:doc:`Billing <../../billing>` / Paginator / ListBillingViews

****************
ListBillingViews
****************



.. py:class:: Billing.Paginator.ListBillingViews

  ::

    
    paginator = client.get_paginator('list_billing_views')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Billing.Client.list_billing_views`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/billing-2023-09-07/ListBillingViews>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          activeTimeRange={
              'activeAfterInclusive': datetime(2015, 1, 1),
              'activeBeforeInclusive': datetime(2015, 1, 1)
          },
          arns=[
              'string',
          ],
          billingViewTypes=[
              'PRIMARY'|'BILLING_GROUP'|'CUSTOM'|'BILLING_TRANSFER'|'BILLING_TRANSFER_SHOWBACK',
          ],
          names=[
              {
                  'searchOption': 'STARTS_WITH',
                  'searchValue': 'string'
              },
          ],
          ownerAccountId='string',
          sourceAccountId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type activeTimeRange: dict
    :param activeTimeRange: 

      The time range for the billing views listed. ``PRIMARY`` billing view is always listed. ``BILLING_GROUP`` billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.

      

    
      - **activeAfterInclusive** *(datetime) --* **[REQUIRED]** 

        The inclusive time range start date.

        

      
      - **activeBeforeInclusive** *(datetime) --* **[REQUIRED]** 

        The inclusive time range end date.

        

      
    
    :type arns: list
    :param arns: 

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

      

    
      - *(string) --* 

      
  
    :type billingViewTypes: list
    :param billingViewTypes: 

      The type of billing view.

      

    
      - *(string) --* 

      
  
    :type names: list
    :param names: 

      Filters the list of billing views by name. You can specify search criteria to match billing view names based on the search option provided.

      

    
      - *(dict) --* 

        A structure that defines how to search for string values. You can specify a search option and the value to search for.

        

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

          The type of search operation to perform on the string value. Determines how the search value is matched against the target field.

          

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

          The string value to use in the search operation. This value is compared against the target field using the specified search option.

          

        
      
  
    :type ownerAccountId: string
    :param ownerAccountId: 

      The list of owners of the billing view.

      

    
    :type sourceAccountId: string
    :param sourceAccountId: 

      Filters the results to include only billing views that use the specified account as a source.

      

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

      
      ::

        {
            'billingViews': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'description': 'string',
                    'ownerAccountId': 'string',
                    'sourceAccountId': 'string',
                    'billingViewType': 'PRIMARY'|'BILLING_GROUP'|'CUSTOM'|'BILLING_TRANSFER'|'BILLING_TRANSFER_SHOWBACK',
                    'healthStatus': {
                        'statusCode': 'HEALTHY'|'UNHEALTHY'|'CREATING'|'UPDATING',
                        'statusReasons': [
                            'SOURCE_VIEW_UNHEALTHY'|'SOURCE_VIEW_UPDATING'|'SOURCE_VIEW_ACCESS_DENIED'|'SOURCE_VIEW_NOT_FOUND'|'CYCLIC_DEPENDENCY'|'SOURCE_VIEW_DEPTH_EXCEEDED'|'AGGREGATE_SOURCE'|'VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT',
                        ]
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **billingViews** *(list) --* 

          A list of ``BillingViewListElement`` retrieved.

          
          

          - *(dict) --* 

            A representation of a billing view.

            
            

            - **arn** *(string) --* 

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

              
            

            - **name** *(string) --* 

              A list of names of the Billing view.

              
            

            - **description** *(string) --* 

              The description of the billing view.

              
            

            - **ownerAccountId** *(string) --* 

              The list of owners of the Billing view.

              
            

            - **sourceAccountId** *(string) --* 

              The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.

              
            

            - **billingViewType** *(string) --* 

              The type of billing view.

              
            

            - **healthStatus** *(dict) --* 

              The current health status of the billing view.

              
              

              - **statusCode** *(string) --* 

                The current health status code of the billing view.

                
              

              - **statusReasons** *(list) --* 

                A list of reasons explaining the current health status, if applicable.

                
                

                - *(string) --* 
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    