BillingConductor / Client / list_pricing_plans

list_pricing_plans#

BillingConductor.Client.list_pricing_plans(**kwargs)#

A paginated call to get pricing plans for the given billing period. If you don’t provide a billing period, the current billing period is used.

See also: AWS API Documentation

Request Syntax

response = client.list_pricing_plans(
    BillingPeriod='string',
    Filters={
        'Arns': [
            'string',
        ]
    },
    MaxResults=123,
    NextToken='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) –

  • MaxResults (integer) – The maximum number of pricing plans to retrieve.

  • NextToken (string) – The pagination token that’s used on subsequent call to get pricing plans.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      The pagination token that’s used on subsequent calls to get pricing plans.

Exceptions