BillingConductor / Paginator / ListPricingRules

ListPricingRules

class BillingConductor.Paginator.ListPricingRules

paginator = client.get_paginator('list_pricing_rules')

paginate(**kwargs)

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

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 the pricing plan.

• Filters (dict) –

  A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information.

  • Arns (list) –

    A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response.

    • (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',
    'PricingRules': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Description': 'string',
            'Scope': 'GLOBAL'|'SERVICE'|'BILLING_ENTITY'|'SKU',
            'Type': 'MARKUP'|'DISCOUNT'|'TIERING',
            'ModifierPercentage': 123.0,
            'Service': 'string',
            'AssociatedPricingPlanCount': 123,
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'BillingEntity': 'string',
            'Tiering': {
                'FreeTier': {
                    'Activated': True|False
                }
            },
            'UsageType': 'string',
            'Operation': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • BillingPeriod (string) –

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

  • PricingRules (list) –

    A list containing the described pricing rules.

    • (dict) –

      A representation of a pricing rule.

      • Name (string) –

        The name of a pricing rule.

      • Arn (string) –

        The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.

      • Description (string) –

        The pricing rule description.

      • Scope (string) –

        The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.

      • Type (string) –

        The type of pricing rule.

      • ModifierPercentage (float) –

        A percentage modifier applied on the public pricing rates.

      • Service (string) –

        If the Scope attribute is SERVICE, this attribute indicates which service the PricingRule is applicable for.

      • AssociatedPricingPlanCount (integer) –

        The pricing plans count that this pricing rule is associated with.

      • CreationTime (integer) –

        The time when the pricing rule was created.

      • LastModifiedTime (integer) –

        The most recent time when the pricing rule was modified.

      • BillingEntity (string) –

        The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.

      • Tiering (dict) –

        The set of tiering configurations for the pricing rule.

        • FreeTier (dict) –

          The possible Amazon Web Services Free Tier configurations.

          • Activated (boolean) –

            Activate or deactivate Amazon Web Services Free Tier application.

      • UsageType (string) –

        Usage type is the unit that each service uses to measure the usage of a specific type of resource.

        If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an `` M2 High Memory Double Extra Large`` instance in the US West (Oregon) Region. ``</p> ``

      • Operation (string) –

        Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item.

        If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.