2019/11/06 - AWS Savings Plans - 8 new api methods
Changes Update savingsplans client to latest version
Creates a Savings Plan.
See also: AWS API Documentation
Request Syntax
client.create_savings_plan( savingsPlanOfferingId='string', commitment='string', upfrontPaymentAmount='string', clientToken='string', tags={ 'string': 'string' } )
string
[REQUIRED]
The ID of the offering.
string
[REQUIRED]
The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than three digits after the decimal point.
string
The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is Partial Upfront.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
One or more tags.
(string) --
(string) --
dict
Response Syntax
{ 'savingsPlanId': 'string' }
Response Structure
(dict) --
savingsPlanId (string) --
The ID of the Savings Plan.
Adds the specified tags to the specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource( resourceArn='string', tags={ 'string': 'string' } )
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
[REQUIRED]
One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Describes the specified Savings Plans rates.
See also: AWS API Documentation
Request Syntax
client.describe_savings_plan_rates( savingsPlanId='string', filters=[ { 'name': 'region'|'instanceType'|'productDescription'|'tenancy'|'productType'|'serviceCode'|'usageType'|'operation', 'values': [ 'string', ] }, ], nextToken='string', maxResults=123 )
string
[REQUIRED]
The ID of the Savings Plan.
list
The filters.
(dict) --
Information about a filter.
name (string) --
The filter name.
values (list) --
The filter values.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.
dict
Response Syntax
{ 'savingsPlanId': 'string', 'searchResults': [ { 'rate': 'string', 'currency': 'CNY'|'USD', 'unit': 'Hrs', 'productType': 'EC2'|'Fargate', 'serviceCode': 'AmazonEC2'|'AmazonECS', 'usageType': 'string', 'operation': 'string', 'properties': [ { 'name': 'region'|'instanceType'|'instanceFamily'|'productDescription'|'tenancy', 'value': 'string' }, ] }, ], 'nextToken': 'string' }
Response Structure
(dict) --
savingsPlanId (string) --
The ID of the Savings Plan.
searchResults (list) --
Information about the Savings Plans rates.
(dict) --
Information about a Savings Plan rate.
rate (string) --
The rate.
currency (string) --
The currency.
unit (string) --
The unit.
productType (string) --
The product type.
serviceCode (string) --
The service.
usageType (string) --
The usage details of the line item in the billing report.
operation (string) --
The specific AWS operation for the line item in the billing report.
properties (list) --
The properties.
(dict) --
Information about a property.
name (string) --
The property name.
value (string) --
The property value.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the specified Savings Plans offering rates.
See also: AWS API Documentation
Request Syntax
client.describe_savings_plans_offering_rates( savingsPlanOfferingIds=[ 'string', ], savingsPlanPaymentOptions=[ 'All Upfront'|'Partial Upfront'|'No Upfront', ], savingsPlanTypes=[ 'Compute'|'EC2Instance', ], products=[ 'EC2'|'Fargate', ], serviceCodes=[ 'AmazonEC2'|'AmazonECS', ], usageTypes=[ 'string', ], operations=[ 'string', ], filters=[ { 'name': 'region'|'instanceFamily'|'instanceType'|'productDescription'|'tenancy'|'productId', 'values': [ 'string', ] }, ], nextToken='string', maxResults=123 )
list
The IDs of the offerings.
(string) --
list
The payment options.
(string) --
list
The plan types.
(string) --
list
The AWS products.
(string) --
list
The services.
(string) --
list
The usage details of the line item in the billing report.
(string) --
list
The specific AWS operation for the line item in the billing report.
(string) --
list
The filters.
(dict) --
Information about a filter.
name (string) --
The filter name.
values (list) --
The filter values.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.
dict
Response Syntax
{ 'searchResults': [ { 'savingsPlanOffering': { 'offeringId': 'string', 'paymentOption': 'All Upfront'|'Partial Upfront'|'No Upfront', 'planType': 'Compute'|'EC2Instance', 'durationSeconds': 123, 'currency': 'CNY'|'USD', 'planDescription': 'string' }, 'rate': 'string', 'unit': 'Hrs', 'productType': 'EC2'|'Fargate', 'serviceCode': 'AmazonEC2'|'AmazonECS', 'usageType': 'string', 'operation': 'string', 'properties': [ { 'name': 'string', 'value': 'string' }, ] }, ], 'nextToken': 'string' }
Response Structure
(dict) --
searchResults (list) --
Information about the Savings Plans offering rates.
(dict) --
Information about a Savings Plan offering rate.
savingsPlanOffering (dict) --
The Savings Plan offering.
offeringId (string) --
The ID of the offering.
paymentOption (string) --
The payment option.
planType (string) --
The plan type.
durationSeconds (integer) --
The duration, in seconds.
currency (string) --
The currency.
planDescription (string) --
The description.
rate (string) --
The Savings Plan rate.
unit (string) --
The unit.
productType (string) --
The product type.
serviceCode (string) --
The service.
usageType (string) --
The usage details of the line item in the billing report.
operation (string) --
The specific AWS operation for the line item in the billing report.
properties (list) --
The properties.
(dict) --
Information about a property.
name (string) --
The property name.
value (string) --
The property value.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the specified Savings Plans.
See also: AWS API Documentation
Request Syntax
client.describe_savings_plans( savingsPlanArns=[ 'string', ], savingsPlanIds=[ 'string', ], nextToken='string', maxResults=123, states=[ 'payment-pending'|'payment-failed'|'active'|'retired', ], filters=[ { 'name': 'region'|'ec2-instance-family'|'commitment'|'upfront'|'term'|'savings-plan-type'|'payment-option'|'start'|'end', 'values': [ 'string', ] }, ] )
list
The Amazon Resource Names (ARN) of the Savings Plans.
(string) --
list
The IDs of the Savings Plans.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.
list
The states.
(string) --
list
The filters.
(dict) --
Information about a filter.
name (string) --
The filter name.
values (list) --
The filter value.
(string) --
dict
Response Syntax
{ 'savingsPlans': [ { 'offeringId': 'string', 'savingsPlanId': 'string', 'savingsPlanArn': 'string', 'description': 'string', 'start': 'string', 'end': 'string', 'state': 'payment-pending'|'payment-failed'|'active'|'retired', 'region': 'string', 'ec2InstanceFamily': 'string', 'savingsPlanType': 'Compute'|'EC2Instance', 'paymentOption': 'All Upfront'|'Partial Upfront'|'No Upfront', 'productTypes': [ 'EC2'|'Fargate', ], 'currency': 'CNY'|'USD', 'commitment': 'string', 'upfrontPaymentAmount': 'string', 'recurringPaymentAmount': 'string', 'termDurationInSeconds': 123, 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' }
Response Structure
(dict) --
savingsPlans (list) --
Information about the Savings Plans.
(dict) --
Information about a Savings Plan.
offeringId (string) --
The ID of the offering.
savingsPlanId (string) --
The ID of the Savings Plan.
savingsPlanArn (string) --
The Amazon Resource Name (ARN) of the Savings Plan.
description (string) --
The description.
start (string) --
The start time.
end (string) --
The end time.
state (string) --
The state.
region (string) --
The AWS Region.
ec2InstanceFamily (string) --
The EC2 instance family.
savingsPlanType (string) --
The plan type.
paymentOption (string) --
The payment option.
productTypes (list) --
The product types.
(string) --
currency (string) --
The currency.
commitment (string) --
The hourly commitment, in USD.
upfrontPaymentAmount (string) --
The up-front payment amount.
recurringPaymentAmount (string) --
The recurring payment amount.
termDurationInSeconds (integer) --
The duration of the term, in seconds.
tags (dict) --
One or more tags.
(string) --
(string) --
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Removes the specified tags from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] )
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
list
[REQUIRED]
The tag keys.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource( resourceArn='string' )
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{ 'tags': { 'string': 'string' } }
Response Structure
(dict) --
tags (dict) --
Information about the tags.
(string) --
(string) --
Describes the specified Savings Plans offerings.
See also: AWS API Documentation
Request Syntax
client.describe_savings_plans_offerings( offeringIds=[ 'string', ], paymentOptions=[ 'All Upfront'|'Partial Upfront'|'No Upfront', ], productType='EC2'|'Fargate', planTypes=[ 'Compute'|'EC2Instance', ], durations=[ 123, ], currencies=[ 'CNY'|'USD', ], descriptions=[ 'string', ], serviceCodes=[ 'string', ], usageTypes=[ 'string', ], operations=[ 'string', ], filters=[ { 'name': 'region'|'instanceFamily', 'values': [ 'string', ] }, ], nextToken='string', maxResults=123 )
list
The IDs of the offerings.
(string) --
list
The payment options.
(string) --
string
The product type.
list
The plan type.
(string) --
list
The durations, in seconds.
(integer) --
list
The currencies.
(string) --
list
The descriptions.
(string) --
list
The services.
(string) --
list
The usage details of the line item in the billing report.
(string) --
list
The specific AWS operation for the line item in the billing report.
(string) --
list
The filters.
(dict) --
Information about a filter.
name (string) --
The filter name.
values (list) --
The filter values.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.
dict
Response Syntax
{ 'searchResults': [ { 'offeringId': 'string', 'productTypes': [ 'EC2'|'Fargate', ], 'planType': 'Compute'|'EC2Instance', 'description': 'string', 'paymentOption': 'All Upfront'|'Partial Upfront'|'No Upfront', 'durationSeconds': 123, 'currency': 'CNY'|'USD', 'serviceCode': 'string', 'usageType': 'string', 'operation': 'string', 'properties': [ { 'name': 'region'|'instanceFamily', 'value': 'string' }, ] }, ], 'nextToken': 'string' }
Response Structure
(dict) --
searchResults (list) --
Information about the Savings Plans offerings.
(dict) --
Information about a Savings Plan offering.
offeringId (string) --
The ID of the offering.
productTypes (list) --
The product type.
(string) --
planType (string) --
The plan type.
description (string) --
The description.
paymentOption (string) --
The payment option.
durationSeconds (integer) --
The duration, in seconds.
currency (string) --
The currency.
serviceCode (string) --
The service.
usageType (string) --
The usage details of the line item in the billing report.
operation (string) --
The specific AWS operation for the line item in the billing report.
properties (list) --
The properties.
(dict) --
Information about a property.
name (string) --
The property name.
value (string) --
The property value.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.