AWSBillingConductor

2023/01/17 - AWSBillingConductor - 2 updated api methods

Changes  This release adds support for SKU Scope for pricing plans.

CreatePricingRule (updated) Link ¶
Changes (request)
{'Operation': 'string', 'UsageType': 'string'}

Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.

See also: AWS API Documentation

Request Syntax

client.create_pricing_rule(
    ClientToken='string',
    Name='string',
    Description='string',
    Scope='GLOBAL'|'SERVICE'|'BILLING_ENTITY',
    Type='MARKUP'|'DISCOUNT'|'TIERING',
    ModifierPercentage=123.0,
    Service='string',
    Tags={
        'string': 'string'
    },
    BillingEntity='string',
    Tiering={
        'FreeTier': {
            'Activated': True|False
        }
    },
    UsageType='string',
    Operation='string'
)
type ClientToken:

string

param ClientToken:

The token that's needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

This field is autopopulated if not provided.

type Name:

string

param Name:

[REQUIRED]

The pricing rule name. The names must be unique to each pricing rule.

type Description:

string

param Description:

The pricing rule description.

type Scope:

string

param Scope:

[REQUIRED]

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

type Type:

string

param Type:

[REQUIRED]

The type of pricing rule.

type ModifierPercentage:

float

param ModifierPercentage:

A percentage modifier that's applied on the public pricing rates.

type Service:

string

param Service:

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

type Tags:

dict

param Tags:

A map that contains tag keys and tag values that are attached to a pricing rule.

  • (string) --

    • (string) --

type BillingEntity:

string

param BillingEntity:

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

type Tiering:

dict

param Tiering:

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 Amazon Web Services Free Tier.

type UsageType:

string

param UsageType:

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>

type Operation:

string

param Operation:

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.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

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

UpdatePricingRule (updated) Link ¶
Changes (response)
{'Operation': 'string', 'UsageType': 'string'}

Updates an existing pricing rule.

See also: AWS API Documentation

Request Syntax

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

string

param Arn:

[REQUIRED]

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

type Name:

string

param Name:

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

type Description:

string

param Description:

The new description for the pricing rule.

type Type:

string

param Type:

The new pricing rule type.

type ModifierPercentage:

float

param ModifierPercentage:

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

type Tiering:

dict

param Tiering:

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.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Description': 'string',
    'Scope': 'GLOBAL'|'SERVICE'|'BILLING_ENTITY',
    '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.