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

*************************
ListWorkloadEstimateUsage
*************************



.. py:class:: BillingandCostManagementPricingCalculator.Paginator.ListWorkloadEstimateUsage

  ::

    
    paginator = client.get_paginator('list_workload_estimate_usage')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          workloadEstimateId='string',
          filters=[
              {
                  'name': 'USAGE_ACCOUNT_ID'|'SERVICE_CODE'|'USAGE_TYPE'|'OPERATION'|'LOCATION'|'USAGE_GROUP'|'HISTORICAL_USAGE_ACCOUNT_ID'|'HISTORICAL_SERVICE_CODE'|'HISTORICAL_USAGE_TYPE'|'HISTORICAL_OPERATION'|'HISTORICAL_LOCATION',
                  'values': [
                      'string',
                  ],
                  'matchOption': 'EQUALS'|'STARTS_WITH'|'CONTAINS'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type workloadEstimateId: string
    :param workloadEstimateId: **[REQUIRED]** 

      The unique identifier of the workload estimate to list usage for.

      

    
    :type filters: list
    :param filters: 

      Filters to apply to the list of usage items.

      

    
      - *(dict) --* 

        Represents a filter for listing usage data.

        

      
        - **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 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': [
                {
                    'serviceCode': 'string',
                    'usageType': 'string',
                    'operation': 'string',
                    'location': 'string',
                    'id': 'string',
                    'usageAccountId': 'string',
                    'group': 'string',
                    'quantity': {
                        'unit': 'string',
                        'amount': 123.0
                    },
                    'cost': 123.0,
                    'currency': 'USD',
                    'status': 'VALID'|'INVALID'|'STALE',
                    'historicalUsage': {
                        'serviceCode': 'string',
                        'usageType': 'string',
                        'operation': 'string',
                        'location': 'string',
                        'usageAccountId': 'string',
                        'billInterval': {
                            'start': datetime(2015, 1, 1),
                            'end': datetime(2015, 1, 1)
                        },
                        'filterExpression': {
                            'and': [
                                {'... recursive ...'},
                            ],
                            'or': [
                                {'... recursive ...'},
                            ],
                            'not': {'... recursive ...'},
                            'costCategories': {
                                'key': 'string',
                                'matchOptions': [
                                    'string',
                                ],
                                'values': [
                                    'string',
                                ]
                            },
                            'dimensions': {
                                'key': 'string',
                                'matchOptions': [
                                    'string',
                                ],
                                'values': [
                                    'string',
                                ]
                            },
                            'tags': {
                                'key': 'string',
                                'matchOptions': [
                                    'string',
                                ],
                                'values': [
                                    'string',
                                ]
                            }
                        }
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          The list of usage items associated with the workload estimate.

          
          

          - *(dict) --* 

            Represents a usage item in a workload estimate.

            
            

            - **serviceCode** *(string) --* 

              The Amazon Web Services service code associated with this usage item.

              
            

            - **usageType** *(string) --* 

              The type of usage for this item.

              
            

            - **operation** *(string) --* 

              The specific operation associated with this usage item.

              
            

            - **location** *(string) --* 

              The location associated with this usage item.

              
            

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

              The unique identifier of this usage item.

              
            

            - **usageAccountId** *(string) --* 

              The Amazon Web Services account ID associated with this usage item.

              
            

            - **group** *(string) --* 

              The group identifier for this usage item.

              
            

            - **quantity** *(dict) --* 

              The estimated usage quantity for this item.

              
              

              - **unit** *(string) --* 

                The unit of measurement for the usage quantity.

                
              

              - **amount** *(float) --* 

                The numeric value of the usage quantity.

                
          
            

            - **cost** *(float) --* 

              The estimated cost for this usage item.

              
            

            - **currency** *(string) --* 

              The currency of the estimated cost.

              
            

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

              The current status of this usage item.

              
            

            - **historicalUsage** *(dict) --* 

              Historical usage data associated with this item, if available.

              
              

              - **serviceCode** *(string) --* 

                The Amazon Web Services service code associated with the usage.

                
              

              - **usageType** *(string) --* 

                The type of usage.

                
              

              - **operation** *(string) --* 

                The specific operation associated with the usage.

                
              

              - **location** *(string) --* 

                The location associated with the usage.

                
              

              - **usageAccountId** *(string) --* 

                The Amazon Web Services account ID associated with the usage.

                
              

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

                The time interval for the historical usage data.

                
                

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

                  The start date and time of the interval.

                  
                

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

                  The end date and time of the interval.

                  
            
              

              - **filterExpression** *(dict) --* 

                An optional filter expression to apply to the historical usage data.

                
                

                - **and** *(list) --* 

                  A list of expressions to be combined with AND logic.

                  
                  

                  - *(dict) --* 

                    Represents a complex filtering expression for cost and usage data.

                    
              
                

                - **or** *(list) --* 

                  A list of expressions to be combined with OR logic.

                  
                  

                  - *(dict) --* 

                    Represents a complex filtering expression for cost and usage data.

                    
              
                

                - **not** *(dict) --* 

                  An expression to be negated.

                  
                

                - **costCategories** *(dict) --* 

                  Filters based on cost categories.

                  
                  

                  - **key** *(string) --* 

                    The key or attribute to filter on.

                    
                  

                  - **matchOptions** *(list) --* 

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

                    
                    

                    - *(string) --* 
                
                  

                  - **values** *(list) --* 

                    The values to match against.

                    
                    

                    - *(string) --* 
                
              
                

                - **dimensions** *(dict) --* 

                  Filters based on dimensions (e.g., service, operation).

                  
                  

                  - **key** *(string) --* 

                    The key or attribute to filter on.

                    
                  

                  - **matchOptions** *(list) --* 

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

                    
                    

                    - *(string) --* 
                
                  

                  - **values** *(list) --* 

                    The values to match against.

                    
                    

                    - *(string) --* 
                
              
                

                - **tags** *(dict) --* 

                  Filters based on resource tags.

                  
                  

                  - **key** *(string) --* 

                    The key or attribute to filter on.

                    
                  

                  - **matchOptions** *(list) --* 

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

                    
                    

                    - *(string) --* 
                
                  

                  - **values** *(list) --* 

                    The values to match against.

                    
                    

                    - *(string) --* 
                
              
            
          
        
      
        

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

          A token to resume pagination.

          
    