update_pricing_rule

BillingConductor.Client.update_pricing_rule(**kwargs)

Updates an existing pricing rule.

See also: AWS API Documentation

Request Syntax

response = client.update_pricing_rule(
    Arn='string',
    Name='string',
    Description='string',
    Type='MARKUP'|'DISCOUNT'|'TIERING',
    ModifierPercentage=123.0,
    Tiering={
        'FreeTier': {
            'Activated': True|False
        }
    }
)
Parameters
  • Arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the pricing rule to update.

  • Name (string) -- The new name of the pricing rule. The name must be unique to each pricing rule.
  • Description (string) -- The new description for the pricing rule.
  • Type (string) -- The new pricing rule type.
  • ModifierPercentage (float) -- The new modifier to show pricing plan rates as a percentage.
  • Tiering (dict) --

    The set of tiering configurations for the pricing rule.

    • FreeTier (dict) -- [REQUIRED]

      The possible Amazon Web Services Free Tier configurations.

      • Activated (boolean) -- [REQUIRED]

        Activate or deactivate application of Amazon Web Services Free Tier.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Description': 'string',
    'Scope': 'GLOBAL'|'SERVICE'|'BILLING_ENTITY'|'SKU',
    'Type': 'MARKUP'|'DISCOUNT'|'TIERING',
    'ModifierPercentage': 123.0,
    'Service': 'string',
    'AssociatedPricingPlanCount': 123,
    'LastModifiedTime': 123,
    'BillingEntity': 'string',
    'Tiering': {
        'FreeTier': {
            'Activated': True|False
        }
    },
    'UsageType': 'string',
    'Operation': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the successfully updated pricing rule.

    • Name (string) --

      The new name of the pricing rule. The name must be unique to each pricing rule.

    • Description (string) --

      The new description for the pricing rule.

    • Scope (string) --

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

    • Type (string) --

      The new pricing rule type.

    • ModifierPercentage (float) --

      The new modifier to show pricing plan rates as a percentage.

    • Service (string) --

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

    • AssociatedPricingPlanCount (integer) --

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

    • LastModifiedTime (integer) --

      The most recent time 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 application of Amazon Web Services Free Tier.

    • 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.

    • Operation (string) --

      Operation refers to the specific Amazon Web Services 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.

Exceptions

  • BillingConductor.Client.exceptions.ThrottlingException
  • BillingConductor.Client.exceptions.ConflictException
  • BillingConductor.Client.exceptions.AccessDeniedException
  • BillingConductor.Client.exceptions.ValidationException
  • BillingConductor.Client.exceptions.InternalServerException
  • BillingConductor.Client.exceptions.ResourceNotFoundException