- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SavingsplansClient
Savings Plans are a pricing model that offer significant savings on Amazon Web Services usage (for example, on Amazon EC2 instances). You commit to a consistent amount of usage per hour, in the specified currency, for a term of one or three years, and receive a lower price for that usage. For more information, see the Amazon Web Services Savings Plans User Guide .
Installation
npm install @aws-sdk/client-savingsplans
yarn add @aws-sdk/client-savingsplans
pnpm add @aws-sdk/client-savingsplans
SavingsplansClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateSavingsPlanCommand | Creates a Savings Plan. |
DeleteQueuedSavingsPlanCommand | Deletes the queued purchase for the specified Savings Plan. |
DescribeSavingsPlanRatesCommand | Describes the rates for the specified Savings Plan. |
DescribeSavingsPlansCommand | Describes the specified Savings Plans. |
DescribeSavingsPlansOfferingRatesCommand | Describes the offering rates for the specified Savings Plans. |
DescribeSavingsPlansOfferingsCommand | Describes the offerings for the specified Savings Plans. |
ListTagsForResourceCommand | Lists the tags for the specified resource. |
ReturnSavingsPlanCommand | Returns the specified Savings Plan. |
TagResourceCommand | Adds the specified tags to the specified resource. |
UntagResourceCommand | Removes the specified tags from the specified resource. |
SavingsplansClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SavingsplansClientConfig