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

****************
ListPricingPlans
****************



.. py:class:: BillingConductor.Paginator.ListPricingPlans

  ::

    
    paginator = client.get_paginator('list_pricing_plans')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          BillingPeriod='string',
          Filters={
              'Arns': [
                  'string',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type BillingPeriod: string
    :param BillingPeriod: 

      The preferred billing period to get pricing plan.

      

    
    :type Filters: dict
    :param Filters: 

      A ``ListPricingPlansFilter`` that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information.

      

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

        A list of pricing plan Amazon Resource Names (ARNs) to retrieve information.

        

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

      
      ::

        {
            'BillingPeriod': 'string',
            'PricingPlans': [
                {
                    'Name': 'string',
                    'Arn': 'string',
                    'Description': 'string',
                    'Size': 123,
                    'CreationTime': 123,
                    'LastModifiedTime': 123
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **BillingPeriod** *(string) --* 

          The billing period for which the described pricing plans are applicable.

          
        

        - **PricingPlans** *(list) --* 

          A list of ``PricingPlanListElement`` retrieved.

          
          

          - *(dict) --* 

            A representation of a pricing plan.

            
            

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

              The name of a pricing plan.

              
            

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

              The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan.

              
            

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

              The pricing plan description.

              
            

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

              The pricing rules count that's currently associated with this pricing plan list element.

              
            

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

              The time when the pricing plan was created.

              
            

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

              The most recent time when the pricing plan was modified.

              
        
      
    