BillingConductor / Paginator / ListPricingPlans

ListPricingPlans

class BillingConductor.Paginator.ListPricingPlans

paginator = client.get_paginator('list_pricing_plans')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BillingConductor.Client.list_pricing_plans().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• BillingPeriod (string) – The preferred billing period to get pricing plan.

• Filters (dict) –

  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) –

• PaginationConfig (dict) –

  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.

Return type:

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.