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

*****************
ListBillingGroups
*****************



.. py:class:: BillingConductor.Paginator.ListBillingGroups

  ::

    
    paginator = client.get_paginator('list_billing_groups')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          BillingPeriod='string',
          Filters={
              'Arns': [
                  'string',
              ],
              'PricingPlan': 'string',
              'Statuses': [
                  'ACTIVE'|'PRIMARY_ACCOUNT_MISSING'|'PENDING',
              ],
              'AutoAssociate': True|False,
              'PrimaryAccountIds': [
                  'string',
              ],
              'BillingGroupTypes': [
                  'STANDARD'|'TRANSFER_BILLING',
              ],
              'Names': [
                  {
                      'SearchOption': 'STARTS_WITH',
                      'SearchValue': 'string'
                  },
              ],
              'ResponsibilityTransferArns': [
                  'string',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type BillingPeriod: string
    :param BillingPeriod: 

      The preferred billing period to get billing groups.

      

    
    :type Filters: dict
    :param Filters: 

      A ``ListBillingGroupsFilter`` that specifies the billing group and pricing plan to retrieve billing group information.

      

    
      - **Arns** *(list) --* 

        The list of billing group Amazon Resource Names (ARNs) to retrieve information.

        

      
        - *(string) --* 

        
    
      - **PricingPlan** *(string) --* 

        The pricing plan Amazon Resource Names (ARNs) to retrieve information.

        

      
      - **Statuses** *(list) --* 

        A list of billing groups to retrieve their current status for a specific time range

        

      
        - *(string) --* 

        
    
      - **AutoAssociate** *(boolean) --* 

        Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

        

      
      - **PrimaryAccountIds** *(list) --* 

        A list of primary account IDs to filter the billing groups.

        

      
        - *(string) --* 

        
    
      - **BillingGroupTypes** *(list) --* 

        Filter billing groups by their type.

        

      
        - *(string) --* 

        
    
      - **Names** *(list) --* 

        Filter billing groups by their names.

        

      
        - *(dict) --* 

          A structure that defines string search parameters.

          

        
          - **SearchOption** *(string) --* **[REQUIRED]** 

            The search option to be applied when performing the string search.

            

          
          - **SearchValue** *(string) --* **[REQUIRED]** 

            The value to search for within the specified string field.

            

          
        
    
      - **ResponsibilityTransferArns** *(list) --* 

        Filter billing groups by their responsibility transfer ARNs.

        

      
        - *(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**

      
      ::

        {
            'BillingGroups': [
                {
                    'Name': 'string',
                    'Arn': 'string',
                    'Description': 'string',
                    'PrimaryAccountId': 'string',
                    'ComputationPreference': {
                        'PricingPlanArn': 'string'
                    },
                    'Size': 123,
                    'CreationTime': 123,
                    'LastModifiedTime': 123,
                    'Status': 'ACTIVE'|'PRIMARY_ACCOUNT_MISSING'|'PENDING',
                    'StatusReason': 'string',
                    'AccountGrouping': {
                        'AutoAssociate': True|False,
                        'ResponsibilityTransferArn': 'string'
                    },
                    'BillingGroupType': 'STANDARD'|'TRANSFER_BILLING'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **BillingGroups** *(list) --* 

          A list of ``BillingGroupListElement`` retrieved.

          
          

          - *(dict) --* 

            A representation of a billing group.

            
            

            - **Name** *(string) --* 

              The name of the billing group.

              
            

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

              The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.

              
            

            - **Description** *(string) --* 

              The description of the billing group.

              
            

            - **PrimaryAccountId** *(string) --* 

              The account ID that serves as the main account in a billing group.

              
            

            - **ComputationPreference** *(dict) --* 

              The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

              
              

              - **PricingPlanArn** *(string) --* 

                The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group.

                
          
            

            - **Size** *(integer) --* 

              The number of accounts in the particular billing group.

              
            

            - **CreationTime** *(integer) --* 

              The time when the billing group was created.

              
            

            - **LastModifiedTime** *(integer) --* 

              The most recent time when the billing group was modified.

              
            

            - **Status** *(string) --* 

              The billing group status. Only one of the valid values can be used.

              
            

            - **StatusReason** *(string) --* 

              The reason why the billing group is in its current status.

              
            

            - **AccountGrouping** *(dict) --* 

              Specifies if the billing group has automatic account association ( ``AutoAssociate``) enabled.

              
              

              - **AutoAssociate** *(boolean) --* 

                Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

                
              

              - **ResponsibilityTransferArn** *(string) --* 

                The Amazon Resource Name (ARN) that identifies the transfer relationship for the billing group.

                
          
            

            - **BillingGroupType** *(string) --* 

              The type of billing group.

              
        
      
    