'2.0', 'service' => '
Savings Plans are a pricing model that offer significant savings on AWS usage (for example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For more information, see the AWS Savings Plans User Guide.
', 'operations' => [ 'CreateSavingsPlan' => 'Creates a Savings Plan.
', 'DeleteQueuedSavingsPlan' => 'Deletes the queued purchase for the specified Savings Plan.
', 'DescribeSavingsPlanRates' => 'Describes the specified Savings Plans rates.
', 'DescribeSavingsPlans' => 'Describes the specified Savings Plans.
', 'DescribeSavingsPlansOfferingRates' => 'Describes the specified Savings Plans offering rates.
', 'DescribeSavingsPlansOfferings' => 'Describes the specified Savings Plans offerings.
', 'ListTagsForResource' => 'Lists the tags for the specified resource.
', 'TagResource' => 'Adds the specified tags to the specified resource.
', 'UntagResource' => 'Removes the specified tags from the specified resource.
', ], 'shapes' => [ 'Amount' => [ 'base' => NULL, 'refs' => [ 'CreateSavingsPlanRequest$commitment' => 'The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than five digits after the decimal point.
', 'CreateSavingsPlanRequest$upfrontPaymentAmount' => '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
.
The hourly commitment, in USD.
', 'SavingsPlan$upfrontPaymentAmount' => 'The up-front payment amount.
', 'SavingsPlan$recurringPaymentAmount' => 'The recurring payment amount.
', 'SavingsPlanRate$rate' => 'The rate.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateSavingsPlanRequest$clientToken' => 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
', ], ], 'CreateSavingsPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSavingsPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'CurrencyList$member' => NULL, 'ParentSavingsPlanOffering$currency' => 'The currency.
', 'SavingsPlan$currency' => 'The currency.
', 'SavingsPlanOffering$currency' => 'The currency.
', 'SavingsPlanRate$currency' => 'The currency.
', ], ], 'CurrencyList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsRequest$currencies' => 'The currencies.
', ], ], 'DateTime' => [ 'base' => NULL, 'refs' => [ 'CreateSavingsPlanRequest$purchaseTime' => 'The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
', ], ], 'DeleteQueuedSavingsPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteQueuedSavingsPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSavingsPlanRatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSavingsPlanRatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSavingsPlansOfferingRatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSavingsPlansOfferingRatesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSavingsPlansOfferingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSavingsPlansOfferingsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSavingsPlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSavingsPlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'DurationsList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsRequest$durations' => 'The durations, in seconds.
', ], ], 'EC2InstanceFamily' => [ 'base' => NULL, 'refs' => [ 'SavingsPlan$ec2InstanceFamily' => 'The EC2 instance family.
', ], ], 'FilterValuesList' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingFilterElement$values' => 'The filter values.
', 'SavingsPlanOfferingRateFilterElement$values' => 'The filter values.
', ], ], 'InternalServerException' => [ 'base' => 'An unexpected error occurred.
', 'refs' => [], ], 'JsonSafeFilterValueString' => [ 'base' => NULL, 'refs' => [ 'FilterValuesList$member' => NULL, 'SavingsPlanOfferingProperty$value' => 'The property value.
', 'SavingsPlanOfferingRateProperty$name' => 'The property name.
', 'SavingsPlanOfferingRateProperty$value' => 'The property value.
', 'SavingsPlanRateProperty$value' => 'The property value.
', ], ], 'ListOfStrings' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanFilter$values' => 'The filter value.
', 'SavingsPlanRateFilter$values' => 'The filter values.
', ], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlanRatesRequest$maxResults' => 'The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.
', 'DescribeSavingsPlansRequest$maxResults' => 'The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.
', ], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$maxResults' => 'The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.
', 'DescribeSavingsPlansOfferingsRequest$maxResults' => 'The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlanRatesRequest$nextToken' => 'The token for the next page of results.
', 'DescribeSavingsPlanRatesResponse$nextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeSavingsPlansOfferingRatesRequest$nextToken' => 'The token for the next page of results.
', 'DescribeSavingsPlansOfferingRatesResponse$nextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeSavingsPlansOfferingsRequest$nextToken' => 'The token for the next page of results.
', 'DescribeSavingsPlansOfferingsResponse$nextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', 'DescribeSavingsPlansRequest$nextToken' => 'The token for the next page of results.
', 'DescribeSavingsPlansResponse$nextToken' => 'The token to use to retrieve the next page of results. This value is null when there are no more results to return.
', ], ], 'ParentSavingsPlanOffering' => [ 'base' => 'Information about a Savings Plan offering.
', 'refs' => [ 'SavingsPlanOfferingRate$savingsPlanOffering' => 'The Savings Plan offering.
', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'SavingsPlan$region' => 'The AWS Region.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource was not found.
', 'refs' => [], ], 'SavingsPlan' => [ 'base' => 'Information about a Savings Plan.
', 'refs' => [ 'SavingsPlanList$member' => NULL, ], ], 'SavingsPlanArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'SavingsPlan$savingsPlanArn' => 'The Amazon Resource Name (ARN) of the Savings Plan.
', 'SavingsPlanArnList$member' => NULL, 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', ], ], 'SavingsPlanArnList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansRequest$savingsPlanArns' => 'The Amazon Resource Names (ARN) of the Savings Plans.
', ], ], 'SavingsPlanDescription' => [ 'base' => NULL, 'refs' => [ 'ParentSavingsPlanOffering$planDescription' => 'The description.
', 'SavingsPlanDescriptionsList$member' => NULL, 'SavingsPlanOffering$description' => 'The description.
', ], ], 'SavingsPlanDescriptionsList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsRequest$descriptions' => 'The descriptions.
', ], ], 'SavingsPlanFilter' => [ 'base' => 'Information about a filter.
', 'refs' => [ 'SavingsPlanFilterList$member' => NULL, ], ], 'SavingsPlanFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansRequest$filters' => 'The filters.
', ], ], 'SavingsPlanId' => [ 'base' => NULL, 'refs' => [ 'CreateSavingsPlanResponse$savingsPlanId' => 'The ID of the Savings Plan.
', 'DeleteQueuedSavingsPlanRequest$savingsPlanId' => 'The ID of the Savings Plan.
', 'DescribeSavingsPlanRatesRequest$savingsPlanId' => 'The ID of the Savings Plan.
', 'DescribeSavingsPlanRatesResponse$savingsPlanId' => 'The ID of the Savings Plan.
', 'SavingsPlan$savingsPlanId' => 'The ID of the Savings Plan.
', 'SavingsPlanIdList$member' => NULL, ], ], 'SavingsPlanIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansRequest$savingsPlanIds' => 'The IDs of the Savings Plans.
', ], ], 'SavingsPlanList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansResponse$savingsPlans' => 'Information about the Savings Plans.
', ], ], 'SavingsPlanOffering' => [ 'base' => 'Information about a Savings Plan offering.
', 'refs' => [ 'SavingsPlanOfferingsList$member' => NULL, ], ], 'SavingsPlanOfferingFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingFilterElement$name' => 'The filter name.
', ], ], 'SavingsPlanOfferingFilterElement' => [ 'base' => 'Information about a filter.
', 'refs' => [ 'SavingsPlanOfferingFiltersList$member' => NULL, ], ], 'SavingsPlanOfferingFiltersList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsRequest$filters' => 'The filters.
', ], ], 'SavingsPlanOfferingId' => [ 'base' => NULL, 'refs' => [ 'CreateSavingsPlanRequest$savingsPlanOfferingId' => 'The ID of the offering.
', 'SavingsPlan$offeringId' => 'The ID of the offering.
', ], ], 'SavingsPlanOfferingProperty' => [ 'base' => 'Information about a property.
', 'refs' => [ 'SavingsPlanOfferingPropertyList$member' => NULL, ], ], 'SavingsPlanOfferingPropertyKey' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingProperty$name' => 'The property name.
', ], ], 'SavingsPlanOfferingPropertyList' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOffering$properties' => 'The properties.
', ], ], 'SavingsPlanOfferingRate' => [ 'base' => 'Information about a Savings Plan offering rate.
', 'refs' => [ 'SavingsPlanOfferingRatesList$member' => NULL, ], ], 'SavingsPlanOfferingRateFilterElement' => [ 'base' => 'Information about a filter.
', 'refs' => [ 'SavingsPlanOfferingRateFiltersList$member' => NULL, ], ], 'SavingsPlanOfferingRateFiltersList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$filters' => 'The filters.
', ], ], 'SavingsPlanOfferingRateProperty' => [ 'base' => 'Information about a property.
', 'refs' => [ 'SavingsPlanOfferingRatePropertyList$member' => NULL, ], ], 'SavingsPlanOfferingRatePropertyList' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingRate$properties' => 'The properties.
', ], ], 'SavingsPlanOfferingRatesList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesResponse$searchResults' => 'Information about the Savings Plans offering rates.
', ], ], 'SavingsPlanOfferingsList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsResponse$searchResults' => 'Information about the Savings Plans offerings.
', ], ], 'SavingsPlanOperation' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOffering$operation' => 'The specific AWS operation for the line item in the billing report.
', 'SavingsPlanOperationList$member' => NULL, ], ], 'SavingsPlanOperationList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsRequest$operations' => 'The specific AWS operation for the line item in the billing report.
', ], ], 'SavingsPlanPaymentOption' => [ 'base' => NULL, 'refs' => [ 'ParentSavingsPlanOffering$paymentOption' => 'The payment option.
', 'SavingsPlan$paymentOption' => 'The payment option.
', 'SavingsPlanOffering$paymentOption' => 'The payment option.
', 'SavingsPlanPaymentOptionList$member' => NULL, ], ], 'SavingsPlanPaymentOptionList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$savingsPlanPaymentOptions' => 'The payment options.
', 'DescribeSavingsPlansOfferingsRequest$paymentOptions' => 'The payment options.
', ], ], 'SavingsPlanProductType' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsRequest$productType' => 'The product type.
', 'SavingsPlanOfferingRate$productType' => 'The product type.
', 'SavingsPlanProductTypeList$member' => NULL, 'SavingsPlanRate$productType' => 'The product type.
', ], ], 'SavingsPlanProductTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$products' => 'The AWS products.
', 'SavingsPlan$productTypes' => 'The product types.
', 'SavingsPlanOffering$productTypes' => 'The product type.
', ], ], 'SavingsPlanRate' => [ 'base' => 'Information about a Savings Plan rate.
', 'refs' => [ 'SavingsPlanRateList$member' => NULL, ], ], 'SavingsPlanRateFilter' => [ 'base' => 'Information about a filter.
', 'refs' => [ 'SavingsPlanRateFilterList$member' => NULL, ], ], 'SavingsPlanRateFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingRateFilterElement$name' => 'The filter name.
', ], ], 'SavingsPlanRateFilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlanRatesRequest$filters' => 'The filters.
', ], ], 'SavingsPlanRateFilterName' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanRateFilter$name' => 'The filter name.
', ], ], 'SavingsPlanRateList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlanRatesResponse$searchResults' => 'Information about the Savings Plans rates.
', ], ], 'SavingsPlanRateOperation' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingRate$operation' => 'The specific AWS operation for the line item in the billing report.
', 'SavingsPlanRate$operation' => 'The specific AWS operation for the line item in the billing report.
', 'SavingsPlanRateOperationList$member' => NULL, ], ], 'SavingsPlanRateOperationList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$operations' => 'The specific AWS operation for the line item in the billing report.
', ], ], 'SavingsPlanRatePricePerUnit' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingRate$rate' => 'The Savings Plan rate.
', ], ], 'SavingsPlanRateProperty' => [ 'base' => 'Information about a property.
', 'refs' => [ 'SavingsPlanRatePropertyList$member' => NULL, ], ], 'SavingsPlanRatePropertyKey' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanRateProperty$name' => 'The property name.
', ], ], 'SavingsPlanRatePropertyList' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanRate$properties' => 'The properties.
', ], ], 'SavingsPlanRateServiceCode' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingRate$serviceCode' => 'The service.
', 'SavingsPlanRate$serviceCode' => 'The service.
', 'SavingsPlanRateServiceCodeList$member' => NULL, ], ], 'SavingsPlanRateServiceCodeList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$serviceCodes' => 'The services.
', ], ], 'SavingsPlanRateUnit' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingRate$unit' => 'The unit.
', 'SavingsPlanRate$unit' => 'The unit.
', ], ], 'SavingsPlanRateUsageType' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOfferingRate$usageType' => 'The usage details of the line item in the billing report.
', 'SavingsPlanRate$usageType' => 'The usage details of the line item in the billing report.
', 'SavingsPlanRateUsageTypeList$member' => NULL, ], ], 'SavingsPlanRateUsageTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$usageTypes' => 'The usage details of the line item in the billing report.
', ], ], 'SavingsPlanServiceCode' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOffering$serviceCode' => 'The service.
', 'SavingsPlanServiceCodeList$member' => NULL, ], ], 'SavingsPlanServiceCodeList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsRequest$serviceCodes' => 'The services.
', ], ], 'SavingsPlanState' => [ 'base' => NULL, 'refs' => [ 'SavingsPlan$state' => 'The state.
', 'SavingsPlanStateList$member' => NULL, ], ], 'SavingsPlanStateList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansRequest$states' => 'The states.
', ], ], 'SavingsPlanType' => [ 'base' => NULL, 'refs' => [ 'ParentSavingsPlanOffering$planType' => 'The plan type.
', 'SavingsPlan$savingsPlanType' => 'The plan type.
', 'SavingsPlanOffering$planType' => 'The plan type.
', 'SavingsPlanTypeList$member' => NULL, ], ], 'SavingsPlanTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$savingsPlanTypes' => 'The plan types.
', 'DescribeSavingsPlansOfferingsRequest$planTypes' => 'The plan type.
', ], ], 'SavingsPlanUsageType' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanOffering$usageType' => 'The usage details of the line item in the billing report.
', 'SavingsPlanUsageTypeList$member' => NULL, ], ], 'SavingsPlanUsageTypeList' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingsRequest$usageTypes' => 'The usage details of the line item in the billing report.
', ], ], 'SavingsPlansDuration' => [ 'base' => NULL, 'refs' => [ 'DurationsList$member' => NULL, 'ParentSavingsPlanOffering$durationSeconds' => 'The duration, in seconds.
', 'SavingsPlanOffering$durationSeconds' => 'The duration, in seconds.
', ], ], 'SavingsPlansFilterName' => [ 'base' => NULL, 'refs' => [ 'SavingsPlanFilter$name' => 'The filter name.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'A service quota has been exceeded.
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'InternalServerException$message' => NULL, 'ListOfStrings$member' => NULL, 'ResourceNotFoundException$message' => NULL, 'SavingsPlan$description' => 'The description.
', 'SavingsPlan$start' => 'The start time.
', 'SavingsPlan$end' => 'The end time.
', 'ServiceQuotaExceededException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The tag keys.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateSavingsPlanRequest$tags' => 'One or more tags.
', 'ListTagsForResourceResponse$tags' => 'Information about the tags.
', 'SavingsPlan$tags' => 'One or more tags.
', 'TagResourceRequest$tags' => 'One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'TermDurationInSeconds' => [ 'base' => NULL, 'refs' => [ 'SavingsPlan$termDurationInSeconds' => 'The duration of the term, in seconds.
', ], ], 'UUID' => [ 'base' => NULL, 'refs' => [ 'ParentSavingsPlanOffering$offeringId' => 'The ID of the offering.
', 'SavingsPlanOffering$offeringId' => 'The ID of the offering.
', 'UUIDs$member' => NULL, ], ], 'UUIDs' => [ 'base' => NULL, 'refs' => [ 'DescribeSavingsPlansOfferingRatesRequest$savingsPlanOfferingIds' => 'The IDs of the offerings.
', 'DescribeSavingsPlansOfferingsRequest$offeringIds' => 'The IDs of the offerings.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'One of the input parameters is not valid.
', 'refs' => [], ], ],];