@datafire/amazonaws_savingsplans
v5.0.0
Published
DataFire integration for AWS Savings Plans
Downloads
18
Readme
@datafire/amazonaws_savingsplans
Client library for AWS Savings Plans
Installation and Usage
npm install --save @datafire/amazonaws_savingsplans
let amazonaws_savingsplans = require('@datafire/amazonaws_savingsplans').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
.then(data => {
console.log(data);
});
Description
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.
Actions
CreateSavingsPlan
amazonaws_savingsplans.CreateSavingsPlan({
"savingsPlanOfferingId": "",
"commitment": ""
}, context)
Input
- input
object
- tags
object
: One or more tags. - clientToken
string
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - commitment required
string
: 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. - purchaseTime
string
: The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ). - savingsPlanOfferingId required
string
: The ID of the offering. - upfrontPaymentAmount
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.
- tags
Output
- output CreateSavingsPlanResponse
DeleteQueuedSavingsPlan
amazonaws_savingsplans.DeleteQueuedSavingsPlan({
"savingsPlanId": ""
}, context)
Input
- input
object
- savingsPlanId required
string
: The ID of the Savings Plan.
- savingsPlanId required
Output
DescribeSavingsPlanRates
amazonaws_savingsplans.DescribeSavingsPlanRates({
"savingsPlanId": ""
}, context)
Input
- input
object
- filters
array
: The filters.- items SavingsPlanRateFilter
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value. - nextToken
string
: The token for the next page of results. - savingsPlanId required
string
: The ID of the Savings Plan.
- filters
Output
DescribeSavingsPlans
amazonaws_savingsplans.DescribeSavingsPlans({}, context)
Input
- input
object
- filters
array
: The filters.- items SavingsPlanFilter
- maxResults
integer
: The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value. - nextToken
string
: The token for the next page of results. - savingsPlanArns
array
: The Amazon Resource Names (ARN) of the Savings Plans.- items SavingsPlanArn
- savingsPlanIds
array
: The IDs of the Savings Plans.- items SavingsPlanId
- states
array
: The states.- items SavingsPlanState
- filters
Output
- output DescribeSavingsPlansResponse
DescribeSavingsPlansOfferingRates
amazonaws_savingsplans.DescribeSavingsPlansOfferingRates({}, context)
Input
- input
object
- filters
array
: The filters. - maxResults
integer
: The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value. - nextToken
string
: The token for the next page of results. - operations
array
: The specific AWS operation for the line item in the billing report.- items SavingsPlanRateOperation
- products
array
: The AWS products.- items SavingsPlanProductType
- savingsPlanOfferingIds
array
: The IDs of the offerings.- items UUID
- savingsPlanPaymentOptions
array
: The payment options.- items SavingsPlanPaymentOption
- savingsPlanTypes
array
: The plan types.- items SavingsPlanType
- serviceCodes
array
: The services. - usageTypes
array
: The usage details of the line item in the billing report.- items SavingsPlanRateUsageType
- filters
Output
DescribeSavingsPlansOfferings
amazonaws_savingsplans.DescribeSavingsPlansOfferings({}, context)
Input
- input
object
- currencies
array
: The currencies.- items CurrencyCode
- descriptions
array
: The descriptions.- items SavingsPlanDescription
- durations
array
: The durations, in seconds.- items SavingsPlansDuration
- filters
array
: The filters. - maxResults
integer
: The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value. - nextToken
string
: The token for the next page of results. - offeringIds
array
: The IDs of the offerings.- items UUID
- operations
array
: The specific AWS operation for the line item in the billing report.- items SavingsPlanOperation
- paymentOptions
array
: The payment options.- items SavingsPlanPaymentOption
- planTypes
array
: The plan type.- items SavingsPlanType
- productType
string
(values: EC2, Fargate, Lambda): The product type. - serviceCodes
array
: The services.- items SavingsPlanServiceCode
- usageTypes
array
: The usage details of the line item in the billing report.- items SavingsPlanUsageType
- currencies
Output
ListTagsForResource
amazonaws_savingsplans.ListTagsForResource({
"resourceArn": ""
}, context)
Input
- input
object
- resourceArn required
string
: The Amazon Resource Name (ARN) of the resource.
- resourceArn required
Output
- output ListTagsForResourceResponse
TagResource
amazonaws_savingsplans.TagResource({
"resourceArn": "",
"tags": {}
}, context)
Input
- input
object
- tags required
object
: One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }. - resourceArn required
string
: The Amazon Resource Name (ARN) of the resource.
- tags required
Output
- output TagResourceResponse
UntagResource
amazonaws_savingsplans.UntagResource({
"resourceArn": "",
"tagKeys": []
}, context)
Input
- input
object
- resourceArn required
string
: The Amazon Resource Name (ARN) of the resource. - tagKeys required
array
: The tag keys.- items TagKey
- resourceArn required
Output
- output UntagResourceResponse
Definitions
Amount
- Amount
string
ClientToken
- ClientToken
string
CreateSavingsPlanRequest
- CreateSavingsPlanRequest
object
- tags
- clientToken
- commitment required
- purchaseTime
- savingsPlanOfferingId required
- upfrontPaymentAmount
CreateSavingsPlanResponse
- CreateSavingsPlanResponse
object
- savingsPlanId
CurrencyCode
- CurrencyCode
string
(values: CNY, USD)
CurrencyList
- CurrencyList
array
- items CurrencyCode
DateTime
- DateTime
string
DeleteQueuedSavingsPlanRequest
- DeleteQueuedSavingsPlanRequest
object
- savingsPlanId required
DeleteQueuedSavingsPlanResponse
- DeleteQueuedSavingsPlanResponse
object
DescribeSavingsPlanRatesRequest
- DescribeSavingsPlanRatesRequest
object
- filters
- items SavingsPlanRateFilter
- maxResults
- nextToken
- savingsPlanId required
- filters
DescribeSavingsPlanRatesResponse
- DescribeSavingsPlanRatesResponse
object
- nextToken
- savingsPlanId
- searchResults
- items SavingsPlanRate
DescribeSavingsPlansOfferingRatesRequest
- DescribeSavingsPlansOfferingRatesRequest
object
- filters
- maxResults
- nextToken
- operations
- items SavingsPlanRateOperation
- products
- items SavingsPlanProductType
- savingsPlanOfferingIds
- items UUID
- savingsPlanPaymentOptions
- items SavingsPlanPaymentOption
- savingsPlanTypes
- items SavingsPlanType
- serviceCodes
- usageTypes
- items SavingsPlanRateUsageType
DescribeSavingsPlansOfferingRatesResponse
- DescribeSavingsPlansOfferingRatesResponse
object
- nextToken
- searchResults
- items SavingsPlanOfferingRate
DescribeSavingsPlansOfferingsRequest
- DescribeSavingsPlansOfferingsRequest
object
- currencies
- items CurrencyCode
- descriptions
- items SavingsPlanDescription
- durations
- items SavingsPlansDuration
- filters
- maxResults
- nextToken
- offeringIds
- items UUID
- operations
- items SavingsPlanOperation
- paymentOptions
- items SavingsPlanPaymentOption
- planTypes
- items SavingsPlanType
- productType
- serviceCodes
- items SavingsPlanServiceCode
- usageTypes
- items SavingsPlanUsageType
- currencies
DescribeSavingsPlansOfferingsResponse
- DescribeSavingsPlansOfferingsResponse
object
- nextToken
- searchResults
- items SavingsPlanOffering
DescribeSavingsPlansRequest
- DescribeSavingsPlansRequest
object
- filters
- items SavingsPlanFilter
- maxResults
- nextToken
- savingsPlanArns
- items SavingsPlanArn
- savingsPlanIds
- items SavingsPlanId
- states
- items SavingsPlanState
- filters
DescribeSavingsPlansResponse
- DescribeSavingsPlansResponse
object
- nextToken
- savingsPlans
- items SavingsPlan
DurationsList
- DurationsList
array
- items SavingsPlansDuration
EC2InstanceFamily
- EC2InstanceFamily
string
FilterValuesList
- FilterValuesList
array
InternalServerException
JsonSafeFilterValueString
- JsonSafeFilterValueString
string
ListOfStrings
- ListOfStrings
array
- items String
ListTagsForResourceRequest
- ListTagsForResourceRequest
object
- resourceArn required
ListTagsForResourceResponse
- ListTagsForResourceResponse
object
- tags
MaxResults
- MaxResults
integer
PageSize
- PageSize
integer
PaginationToken
- PaginationToken
string
ParentSavingsPlanOffering
- ParentSavingsPlanOffering
object
: Information about a Savings Plan offering.- currency
- durationSeconds
- offeringId
- paymentOption
- planDescription
- planType
Region
- Region
string
ResourceNotFoundException
SavingsPlan
- SavingsPlan
object
: Information about a Savings Plan.- tags
- commitment
- currency
- description
- ec2InstanceFamily
- end
- offeringId
- paymentOption
- productTypes
- items SavingsPlanProductType
- recurringPaymentAmount
- region
- savingsPlanArn
- savingsPlanId
- savingsPlanType
- start
- state
- termDurationInSeconds
- upfrontPaymentAmount
SavingsPlanArn
- SavingsPlanArn
string
SavingsPlanArnList
- SavingsPlanArnList
array
- items SavingsPlanArn
SavingsPlanDescription
- SavingsPlanDescription
string
SavingsPlanDescriptionsList
- SavingsPlanDescriptionsList
array
- items SavingsPlanDescription
SavingsPlanFilter
- SavingsPlanFilter
object
: Information about a filter.- name
- values
- items String
SavingsPlanFilterList
- SavingsPlanFilterList
array
- items SavingsPlanFilter
SavingsPlanId
- SavingsPlanId
string
SavingsPlanIdList
- SavingsPlanIdList
array
- items SavingsPlanId
SavingsPlanList
- SavingsPlanList
array
- items SavingsPlan
SavingsPlanOffering
- SavingsPlanOffering
object
: Information about a Savings Plan offering.- currency
- description
- durationSeconds
- offeringId
- operation
- paymentOption
- planType
- productTypes
- items SavingsPlanProductType
- properties
- serviceCode
- usageType
SavingsPlanOfferingFilterAttribute
- SavingsPlanOfferingFilterAttribute
string
(values: region, instanceFamily)
SavingsPlanOfferingFilterElement
- SavingsPlanOfferingFilterElement
object
: Information about a filter.- name
- values
SavingsPlanOfferingFiltersList
- SavingsPlanOfferingFiltersList
array
SavingsPlanOfferingId
- SavingsPlanOfferingId
string
SavingsPlanOfferingProperty
- SavingsPlanOfferingProperty
object
: Information about a property.- name
- value
SavingsPlanOfferingPropertyKey
- SavingsPlanOfferingPropertyKey
string
(values: region, instanceFamily)
SavingsPlanOfferingPropertyList
- SavingsPlanOfferingPropertyList
array
SavingsPlanOfferingRate
- SavingsPlanOfferingRate
object
: Information about a Savings Plan offering rate.- operation
- productType
- properties
- rate
- savingsPlanOffering
- currency
- durationSeconds
- offeringId
- paymentOption
- planDescription
- planType
- serviceCode
- unit
- usageType
SavingsPlanOfferingRateFilterElement
- SavingsPlanOfferingRateFilterElement
object
: Information about a filter.- name
- values
SavingsPlanOfferingRateFiltersList
- SavingsPlanOfferingRateFiltersList
array
SavingsPlanOfferingRateProperty
- SavingsPlanOfferingRateProperty
object
: Information about a property.- name
- value
SavingsPlanOfferingRatePropertyList
- SavingsPlanOfferingRatePropertyList
array
SavingsPlanOfferingRatesList
- SavingsPlanOfferingRatesList
array
- items SavingsPlanOfferingRate
SavingsPlanOfferingsList
- SavingsPlanOfferingsList
array
- items SavingsPlanOffering
SavingsPlanOperation
- SavingsPlanOperation
string
SavingsPlanOperationList
- SavingsPlanOperationList
array
- items SavingsPlanOperation
SavingsPlanPaymentOption
- SavingsPlanPaymentOption
string
(values: All Upfront, Partial Upfront, No Upfront)
SavingsPlanPaymentOptionList
- SavingsPlanPaymentOptionList
array
- items SavingsPlanPaymentOption
SavingsPlanProductType
- SavingsPlanProductType
string
(values: EC2, Fargate, Lambda)
SavingsPlanProductTypeList
- SavingsPlanProductTypeList
array
- items SavingsPlanProductType
SavingsPlanRate
- SavingsPlanRate
object
: Information about a Savings Plan rate.- currency
- operation
- productType
- properties
- items SavingsPlanRateProperty
- rate
- serviceCode
- unit
- usageType
SavingsPlanRateFilter
- SavingsPlanRateFilter
object
: Information about a filter.- name
- values
- items String
SavingsPlanRateFilterAttribute
- SavingsPlanRateFilterAttribute
string
(values: region, instanceFamily, instanceType, productDescription, tenancy, productId)
SavingsPlanRateFilterList
- SavingsPlanRateFilterList
array
- items SavingsPlanRateFilter
SavingsPlanRateFilterName
- SavingsPlanRateFilterName
string
(values: region, instanceType, productDescription, tenancy, productType, serviceCode, usageType, operation)
SavingsPlanRateList
- SavingsPlanRateList
array
- items SavingsPlanRate
SavingsPlanRateOperation
- SavingsPlanRateOperation
string
SavingsPlanRateOperationList
- SavingsPlanRateOperationList
array
- items SavingsPlanRateOperation
SavingsPlanRatePricePerUnit
- SavingsPlanRatePricePerUnit
string
SavingsPlanRateProperty
- SavingsPlanRateProperty
object
: Information about a property.- name
- value
SavingsPlanRatePropertyKey
- SavingsPlanRatePropertyKey
string
(values: region, instanceType, instanceFamily, productDescription, tenancy)
SavingsPlanRatePropertyList
- SavingsPlanRatePropertyList
array
- items SavingsPlanRateProperty
SavingsPlanRateServiceCode
- SavingsPlanRateServiceCode
string
(values: AmazonEC2, AmazonECS, AWSLambda)
SavingsPlanRateServiceCodeList
- SavingsPlanRateServiceCodeList
array
SavingsPlanRateUnit
- SavingsPlanRateUnit
string
(values: Hrs, Lambda-GB-Second, Request)
SavingsPlanRateUsageType
- SavingsPlanRateUsageType
string
SavingsPlanRateUsageTypeList
- SavingsPlanRateUsageTypeList
array
- items SavingsPlanRateUsageType
SavingsPlanServiceCode
- SavingsPlanServiceCode
string
SavingsPlanServiceCodeList
- SavingsPlanServiceCodeList
array
- items SavingsPlanServiceCode
SavingsPlanState
- SavingsPlanState
string
(values: payment-pending, payment-failed, active, retired, queued, queued-deleted)
SavingsPlanStateList
- SavingsPlanStateList
array
- items SavingsPlanState
SavingsPlanType
- SavingsPlanType
string
(values: Compute, EC2Instance)
SavingsPlanTypeList
- SavingsPlanTypeList
array
- items SavingsPlanType
SavingsPlanUsageType
- SavingsPlanUsageType
string
SavingsPlanUsageTypeList
- SavingsPlanUsageTypeList
array
- items SavingsPlanUsageType
SavingsPlansDuration
- SavingsPlansDuration
integer
SavingsPlansFilterName
- SavingsPlansFilterName
string
(values: region, ec2-instance-family, commitment, upfront, term, savings-plan-type, payment-option, start, end)
ServiceQuotaExceededException
String
- String
string
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagMap
- TagMap
object
TagResourceRequest
- TagResourceRequest
object
- tags required
- resourceArn required
TagResourceResponse
- TagResourceResponse
object
TagValue
- TagValue
string
TermDurationInSeconds
- TermDurationInSeconds
integer
UUID
- UUID
string
UUIDs
- UUIDs
array
- items UUID
UntagResourceRequest
- UntagResourceRequest
object
- resourceArn required
- tagKeys required
- items TagKey
UntagResourceResponse
- UntagResourceResponse
object