AWS API Changes

2022/12/06 - AWSBillingConductor - 3 updated api methods

Changes This release adds the Tiering Pricing Rule feature.

CreatePricingRule (updated)

Link ¶
Changes (request)

{'Tiering': {'FreeTier': {'Activated': 'boolean'}}, 'Type': {'TIERING'}}

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

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

rtype

dict

returns

Response Syntax

{
    'Arn': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the created pricing rule.

ListPricingRules (updated)

Link ¶
Changes (response)

{'PricingRules': {'Tiering': {'FreeTier': {'Activated': 'boolean'}},
                  'Type': {'TIERING'}}}

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

See also: AWS API Documentation

Request Syntax

client.list_pricing_rules(
    BillingPeriod='string',
    Filters={
        'Arns': [
            'string',
        ]
    },
    MaxResults=123,
    NextToken='string'
)

type BillingPeriod

string

param BillingPeriod

The preferred billing period to get the pricing plan.

type Filters

dict

param Filters

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

type MaxResults

integer

param MaxResults

The maximum number of pricing rules to retrieve.

type NextToken

string

param NextToken

The pagination token that's used on subsequent call to get pricing rules.

rtype

dict

returns

Response Syntax

{
    'BillingPeriod': 'string',
    'PricingRules': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Description': 'string',
            'Scope': 'GLOBAL'|'SERVICE'|'BILLING_ENTITY',
            'Type': 'MARKUP'|'DISCOUNT'|'TIERING',
            'ModifierPercentage': 123.0,
            'Service': 'string',
            'AssociatedPricingPlanCount': 123,
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'BillingEntity': 'string',
            'Tiering': {
                'FreeTier': {
                    'Activated': True|False
                }
            }
        },
    ],
    'NextToken': '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.
- NextToken (string) --
  
  The pagination token that's used on subsequent calls to get pricing rules.

UpdatePricingRule (updated)

Link ¶
Changes (both)

{'Tiering': {'FreeTier': {'Activated': 'boolean'}}, 'Type': {'TIERING'}}

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
        }
    }
}

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.