:doc:`BillingConductor <../../billingconductor>` / Paginator / ListBillingGroupCostReports

***************************
ListBillingGroupCostReports
***************************



.. py:class:: BillingConductor.Paginator.ListBillingGroupCostReports

  ::

    
    paginator = client.get_paginator('list_billing_group_cost_reports')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`BillingConductor.Client.list_billing_group_cost_reports`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/billingconductor-2021-07-30/ListBillingGroupCostReports>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          BillingPeriod='string',
          Filters={
              'BillingGroupArns': [
                  'string',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type BillingPeriod: string
    :param BillingPeriod: 

      The preferred billing period for your report.

      

    
    :type Filters: dict
    :param Filters: 

      A ``ListBillingGroupCostReportsFilter`` to specify billing groups to retrieve reports from.

      

    
      - **BillingGroupArns** *(list) --* 

        The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve reports.

        

      
        - *(string) --* 

        
    
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'BillingGroupCostReports': [
                {
                    'Arn': 'string',
                    'AWSCost': 'string',
                    'ProformaCost': 'string',
                    'Margin': 'string',
                    'MarginPercentage': 'string',
                    'Currency': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **BillingGroupCostReports** *(list) --* 

          A list of ``BillingGroupCostReportElement`` retrieved.

          
          

          - *(dict) --* 

            A summary report of actual Amazon Web Services charges and calculated Amazon Web Services charges, based on the associated pricing plan of a billing group.

            
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of a billing group.

              
            

            - **AWSCost** *(string) --* 

              The actual Amazon Web Services charges for the billing group.

              
            

            - **ProformaCost** *(string) --* 

              The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group.

              
            

            - **Margin** *(string) --* 

              The billing group margin.

              
            

            - **MarginPercentage** *(string) --* 

              The percentage of billing group margin.

              
            

            - **Currency** *(string) --* 

              The displayed currency.

              
        
      
    