:doc:`BillingandCostManagementPricingCalculator <../../bcm-pricing-calculator>` / Paginator / ListBillScenarios

*****************
ListBillScenarios
*****************



.. py:class:: BillingandCostManagementPricingCalculator.Paginator.ListBillScenarios

  ::

    
    paginator = client.get_paginator('list_bill_scenarios')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`BillingandCostManagementPricingCalculator.Client.list_bill_scenarios`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bcm-pricing-calculator-2024-06-19/ListBillScenarios>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters=[
              {
                  'name': 'STATUS'|'NAME'|'GROUP_SHARING_PREFERENCE'|'COST_CATEGORY_ARN',
                  'values': [
                      'string',
                  ],
                  'matchOption': 'EQUALS'|'STARTS_WITH'|'CONTAINS'
              },
          ],
          createdAtFilter={
              'afterTimestamp': datetime(2015, 1, 1),
              'beforeTimestamp': datetime(2015, 1, 1)
          },
          expiresAtFilter={
              'afterTimestamp': datetime(2015, 1, 1),
              'beforeTimestamp': datetime(2015, 1, 1)
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: list
    :param filters: 

      Filters to apply to the list of bill scenarios.

      

    
      - *(dict) --* 

        Represents a filter for listing bill scenarios.

        

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

          The name of the filter attribute.

          

        
        - **values** *(list) --* **[REQUIRED]** 

          The values to filter by.

          

        
          - *(string) --* 

          
      
        - **matchOption** *(string) --* 

          The match option for the filter (e.g., equals, contains).

          

        
      
  
    :type createdAtFilter: dict
    :param createdAtFilter: 

      Filter bill scenarios based on the creation date.

      

    
      - **afterTimestamp** *(datetime) --* 

        Include results after this timestamp.

        

      
      - **beforeTimestamp** *(datetime) --* 

        Include results before this timestamp.

        

      
    
    :type expiresAtFilter: dict
    :param expiresAtFilter: 

      Filter bill scenarios based on the expiration date.

      

    
      - **afterTimestamp** *(datetime) --* 

        Include results after this timestamp.

        

      
      - **beforeTimestamp** *(datetime) --* 

        Include results before this timestamp.

        

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

      
      ::

        {
            'items': [
                {
                    'id': 'string',
                    'name': 'string',
                    'billInterval': {
                        'start': datetime(2015, 1, 1),
                        'end': datetime(2015, 1, 1)
                    },
                    'status': 'READY'|'LOCKED'|'FAILED'|'STALE',
                    'createdAt': datetime(2015, 1, 1),
                    'expiresAt': datetime(2015, 1, 1),
                    'failureMessage': 'string',
                    'groupSharingPreference': 'OPEN'|'PRIORITIZED'|'RESTRICTED',
                    'costCategoryGroupSharingPreferenceArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          The list of bill scenarios for the account.

          
          

          - *(dict) --* 

            Provides a summary of a bill scenario.

            
            

            - **id** *(string) --* 

              The unique identifier of the bill scenario.

              
            

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

              The name of the bill scenario.

              
            

            - **billInterval** *(dict) --* 

              The time period covered by the bill scenario.

              
              

              - **start** *(datetime) --* 

                The start date and time of the interval.

                
              

              - **end** *(datetime) --* 

                The end date and time of the interval.

                
          
            

            - **status** *(string) --* 

              The current status of the bill scenario.

              
            

            - **createdAt** *(datetime) --* 

              The timestamp when the bill scenario was created.

              
            

            - **expiresAt** *(datetime) --* 

              The timestamp when the bill scenario will expire.

              
            

            - **failureMessage** *(string) --* 

              An error message if the bill scenario creation or processing failed.

              
            

            - **groupSharingPreference** *(string) --* 

              The setting for the reserved instance and savings plan group sharing used in this estimate.

              
            

            - **costCategoryGroupSharingPreferenceArn** *(string) --* 

              The arn of the cost category used in the reserved and prioritized group sharing.

              
        
      
        

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

          A token to resume pagination.

          
    