npm.io
5.0.0 • Published 5 years ago

@datafire/amazonaws_savingsplans

Licence
MIT
Version
5.0.0
Deps
2
Size
103 kB
Vulns
1
Weekly
0
SummaryDependencyVersions

@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-DDTHHSSZ).
    • 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.
Output
DeleteQueuedSavingsPlan
amazonaws_savingsplans.DeleteQueuedSavingsPlan({
  "savingsPlanId": ""
}, context)
Input
  • input object
    • savingsPlanId required string: The ID of the Savings Plan.
Output
DescribeSavingsPlanRates
amazonaws_savingsplans.DescribeSavingsPlanRates({
  "savingsPlanId": ""
}, 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.
    • savingsPlanId required string: The ID of the Savings Plan.
Output
DescribeSavingsPlans
amazonaws_savingsplans.DescribeSavingsPlans({}, 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.
    • savingsPlanArns array: The Amazon Resource Names (ARN) of the Savings Plans.
    • savingsPlanIds array: The IDs of the Savings Plans.
    • states array: The states.
Output
DescribeSavingsPlansOfferingRates
amazonaws_savingsplans.DescribeSavingsPlansOfferingRates({}, context)
Input
Output
DescribeSavingsPlansOfferings
amazonaws_savingsplans.DescribeSavingsPlansOfferings({}, context)
Input
  • input object
    • currencies array: The currencies.
    • descriptions array: The descriptions.
    • durations array: The durations, in seconds.
    • 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.
    • operations array: The specific AWS operation for the line item in the billing report.
    • paymentOptions array: The payment options.
    • planTypes array: The plan type.
    • productType string (values: EC2, Fargate, Lambda): The product type.
    • serviceCodes array: The services.
    • usageTypes array: The usage details of the line item in the billing report.
Output
ListTagsForResource
amazonaws_savingsplans.ListTagsForResource({
  "resourceArn": ""
}, context)
Input
  • input object
    • resourceArn required string: The Amazon Resource Name (ARN) of the resource.
Output
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.
Output
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.
Output

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
DateTime
  • DateTime string
DeleteQueuedSavingsPlanRequest
  • DeleteQueuedSavingsPlanRequest object
    • savingsPlanId required
DeleteQueuedSavingsPlanResponse
  • DeleteQueuedSavingsPlanResponse object
DescribeSavingsPlanRatesRequest
  • DescribeSavingsPlanRatesRequest object
DescribeSavingsPlanRatesResponse
  • DescribeSavingsPlanRatesResponse object
DescribeSavingsPlansOfferingRatesRequest
DescribeSavingsPlansOfferingRatesResponse
DescribeSavingsPlansOfferingsRequest
DescribeSavingsPlansOfferingsResponse
  • DescribeSavingsPlansOfferingsResponse object
DescribeSavingsPlansRequest
DescribeSavingsPlansResponse
  • DescribeSavingsPlansResponse object
DurationsList
EC2InstanceFamily
  • EC2InstanceFamily string
FilterValuesList
InternalServerException
JsonSafeFilterValueString
  • JsonSafeFilterValueString string
ListOfStrings
  • ListOfStrings array
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
    • recurringPaymentAmount
    • region
    • savingsPlanArn
    • savingsPlanId
    • savingsPlanType
    • start
    • state
    • termDurationInSeconds
    • upfrontPaymentAmount
SavingsPlanArn
  • SavingsPlanArn string
SavingsPlanArnList
SavingsPlanDescription
  • SavingsPlanDescription string
SavingsPlanDescriptionsList
SavingsPlanFilter
  • SavingsPlanFilter object: Information about a filter.
SavingsPlanFilterList
SavingsPlanId
  • SavingsPlanId string
SavingsPlanIdList
SavingsPlanList
SavingsPlanOffering
  • SavingsPlanOffering object: Information about a Savings Plan offering.
SavingsPlanOfferingFilterAttribute
  • SavingsPlanOfferingFilterAttribute string (values: region, instanceFamily)
SavingsPlanOfferingFilterElement
SavingsPlanOfferingFiltersList
SavingsPlanOfferingId
  • SavingsPlanOfferingId string
SavingsPlanOfferingProperty
  • SavingsPlanOfferingProperty object: Information about a property.
    • name
    • value
SavingsPlanOfferingPropertyKey
  • SavingsPlanOfferingPropertyKey string (values: region, instanceFamily)
SavingsPlanOfferingPropertyList
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
SavingsPlanOfferingRateFiltersList
SavingsPlanOfferingRateProperty
  • SavingsPlanOfferingRateProperty object: Information about a property.
    • name
    • value
SavingsPlanOfferingRatePropertyList
SavingsPlanOfferingRatesList
SavingsPlanOfferingsList
SavingsPlanOperation
  • SavingsPlanOperation string
SavingsPlanOperationList
SavingsPlanPaymentOption
  • SavingsPlanPaymentOption string (values: All Upfront, Partial Upfront, No Upfront)
SavingsPlanPaymentOptionList
SavingsPlanProductType
  • SavingsPlanProductType string (values: EC2, Fargate, Lambda)
SavingsPlanProductTypeList
SavingsPlanRate
  • SavingsPlanRate object: Information about a Savings Plan rate.
SavingsPlanRateFilter
  • SavingsPlanRateFilter object: Information about a filter.
SavingsPlanRateFilterAttribute
  • SavingsPlanRateFilterAttribute string (values: region, instanceFamily, instanceType, productDescription, tenancy, productId)
SavingsPlanRateFilterList
SavingsPlanRateFilterName
  • SavingsPlanRateFilterName string (values: region, instanceType, productDescription, tenancy, productType, serviceCode, usageType, operation)
SavingsPlanRateList
SavingsPlanRateOperation
  • SavingsPlanRateOperation string
SavingsPlanRateOperationList
SavingsPlanRatePricePerUnit
  • SavingsPlanRatePricePerUnit string
SavingsPlanRateProperty
  • SavingsPlanRateProperty object: Information about a property.
    • name
    • value
SavingsPlanRatePropertyKey
  • SavingsPlanRatePropertyKey string (values: region, instanceType, instanceFamily, productDescription, tenancy)
SavingsPlanRatePropertyList
SavingsPlanRateServiceCode
  • SavingsPlanRateServiceCode string (values: AmazonEC2, AmazonECS, AWSLambda)
SavingsPlanRateServiceCodeList
SavingsPlanRateUnit
  • SavingsPlanRateUnit string (values: Hrs, Lambda-GB-Second, Request)
SavingsPlanRateUsageType
  • SavingsPlanRateUsageType string
SavingsPlanRateUsageTypeList
SavingsPlanServiceCode
  • SavingsPlanServiceCode string
SavingsPlanServiceCodeList
SavingsPlanState
  • SavingsPlanState string (values: payment-pending, payment-failed, active, retired, queued, queued-deleted)
SavingsPlanStateList
SavingsPlanType
  • SavingsPlanType string (values: Compute, EC2Instance)
SavingsPlanTypeList
SavingsPlanUsageType
  • SavingsPlanUsageType string
SavingsPlanUsageTypeList
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
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
UntagResourceRequest
  • UntagResourceRequest object
    • resourceArn required
    • tagKeys required
UntagResourceResponse
  • UntagResourceResponse object
ValidationException