:doc:`Pricing <../../pricing>` / Paginator / ListPriceLists

**************
ListPriceLists
**************



.. py:class:: Pricing.Paginator.ListPriceLists

  ::

    
    paginator = client.get_paginator('list_price_lists')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Pricing.Client.list_price_lists`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pricing-2017-10-15/ListPriceLists>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ServiceCode='string',
          EffectiveDate=datetime(2015, 1, 1),
          RegionCode='string',
          CurrencyCode='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ServiceCode: string
    :param ServiceCode: **[REQUIRED]** 

      The service code or the Savings Plan service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use ``AmazonEC2``. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the `DescribeServices <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_DescribeServices.html#awscostmanagement-pricing_DescribeServices-request-FormatVersion>`__ API.

       

      To retrieve the Reserved Instance and Compute Savings Plan price lists, use ``ComputeSavingsPlans``.

       

      To retrieve Machine Learning Savings Plans price lists, use ``MachineLearningSavingsPlans``.

      

    
    :type EffectiveDate: datetime
    :param EffectiveDate: **[REQUIRED]** 

      The date that the Price List file prices are effective from.

      

    
    :type RegionCode: string
    :param RegionCode: 

      This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the ``US East (N. Virginia)`` Region, use ``us-east-1``. If nothing is specified, you retrieve price lists for all applicable Regions. The available ``RegionCode`` list can be retrieved from `GetAttributeValues <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html>`__ API.

      

    
    :type CurrencyCode: string
    :param CurrencyCode: **[REQUIRED]** 

      The three alphabetical character ISO-4217 currency code that the Price List files are denominated in.

      

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

      
      ::

        {
            'PriceLists': [
                {
                    'PriceListArn': 'string',
                    'RegionCode': 'string',
                    'CurrencyCode': 'string',
                    'FileFormats': [
                        'string',
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **PriceLists** *(list) --* 

          The type of price list references that match your request.

          
          

          - *(dict) --* 

            This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the `Amazon Web Services Service Terms <https://aws.amazon.com/service-terms/>`__ (Section 1.10).

             

            This is the type of price list references that match your request.

            
            

            - **PriceListArn** *(string) --* 

              The unique identifier that maps to where your Price List files are located. ``PriceListArn`` can be obtained from the `ListPriceList <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html>`__ response.

              
            

            - **RegionCode** *(string) --* 

              This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the ``US East (N. Virginia)`` Region, use ``us-east-1``. If nothing is specified, you retrieve price lists for all applicable Regions. The available ``RegionCode`` list can be retrieved from `GetAttributeValues <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html>`__ API.

              
            

            - **CurrencyCode** *(string) --* 

              The three alphabetical character ISO-4217 currency code the Price List files are denominated in.

              
            

            - **FileFormats** *(list) --* 

              The format you want to retrieve your Price List files. The ``FileFormat`` can be obtained from the `ListPriceList <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html>`__ response.

              
              

              - *(string) --* 
          
        
      
    