Class: AWS.SavingsPlans

Inherits:
AWS.Service show all
Identifier:
savingsplans
API Version:
2019-06-28
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service 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.

Sending a Request Using SavingsPlans

var savingsplans = new AWS.SavingsPlans();
savingsplans.createSavingsPlan(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SavingsPlans object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var savingsplans = new AWS.SavingsPlans({apiVersion: '2019-06-28'});

You can also set the API version globally in AWS.config.apiVersions using the savingsplans service identifier:

AWS.config.apiVersions = {
  savingsplans: '2019-06-28',
  // other service API versions
};

var savingsplans = new AWS.SavingsPlans();

Version:

  • 2019-06-28

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SavingsPlans(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SavingsPlans object

var savingsplans = new AWS.SavingsPlans({apiVersion: '2019-06-28'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.SavingsPlans.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.SavingsPlans.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SavingsPlans.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createSavingsPlan(params = {}, callback) ⇒ AWS.Request

Creates a Savings Plan.

Service Reference:

Examples:

Calling the createSavingsPlan operation

var params = {
  commitment: 'STRING_VALUE', /* required */
  savingsPlanOfferingId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  upfrontPaymentAmount: 'STRING_VALUE'
};
savingsplans.createSavingsPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • savingsPlanOfferingId — (String)

      The ID of the offering.

    • commitment — (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.

    • 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.

    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (map<String>)

      One or more tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • savingsPlanId — (String)

        The ID of the Savings Plan.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSavingsPlanRates(params = {}, callback) ⇒ AWS.Request

Describes the specified Savings Plans rates.

Service Reference:

Examples:

Calling the describeSavingsPlanRates operation

var params = {
  savingsPlanId: 'STRING_VALUE', /* required */
  filters: [
    {
      name: region | instanceType | productDescription | tenancy | productType | serviceCode | usageType | operation,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
savingsplans.describeSavingsPlanRates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • savingsPlanId — (String)

      The ID of the Savings Plan.

    • filters — (Array<map>)

      The filters.

      • name — (String)

        The filter name.

        Possible values include:
        • "region"
        • "instanceType"
        • "productDescription"
        • "tenancy"
        • "productType"
        • "serviceCode"
        • "usageType"
        • "operation"
      • values — (Array<String>)

        The filter values.

    • nextToken — (String)

      The token for the next page of results.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • savingsPlanId — (String)

        The ID of the Savings Plan.

      • searchResults — (Array<map>)

        Information about the Savings Plans rates.

        • rate — (String)

          The rate.

        • currency — (String)

          The currency.

          Possible values include:
          • "CNY"
          • "USD"
        • unit — (String)

          The unit.

          Possible values include:
          • "Hrs"
          • "Lambda-GB-Second"
          • "Request"
        • productType — (String)

          The product type.

          Possible values include:
          • "EC2"
          • "Fargate"
          • "Lambda"
        • serviceCode — (String)

          The service.

          Possible values include:
          • "AmazonEC2"
          • "AmazonECS"
          • "AWSLambda"
        • 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 — (Array<map>)

          The properties.

          • name — (String)

            The property name.

            Possible values include:
            • "region"
            • "instanceType"
            • "instanceFamily"
            • "productDescription"
            • "tenancy"
          • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSavingsPlans(params = {}, callback) ⇒ AWS.Request

Describes the specified Savings Plans.

Service Reference:

Examples:

Calling the describeSavingsPlans operation

var params = {
  filters: [
    {
      name: region | ec2-instance-family | commitment | upfront | term | savings-plan-type | payment-option | start | end,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  savingsPlanArns: [
    'STRING_VALUE',
    /* more items */
  ],
  savingsPlanIds: [
    'STRING_VALUE',
    /* more items */
  ],
  states: [
    payment-pending | payment-failed | active | retired,
    /* more items */
  ]
};
savingsplans.describeSavingsPlans(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • savingsPlanArns — (Array<String>)

      The Amazon Resource Names (ARN) of the Savings Plans.

    • savingsPlanIds — (Array<String>)

      The IDs of the Savings Plans.

    • nextToken — (String)

      The token for the next page of results.

    • 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.

    • states — (Array<String>)

      The states.

    • filters — (Array<map>)

      The filters.

      • name — (String)

        The filter name.

        Possible values include:
        • "region"
        • "ec2-instance-family"
        • "commitment"
        • "upfront"
        • "term"
        • "savings-plan-type"
        • "payment-option"
        • "start"
        • "end"
      • values — (Array<String>)

        The filter value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • savingsPlans — (Array<map>)

        Information about the Savings Plans.

        • 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.

          Possible values include:
          • "payment-pending"
          • "payment-failed"
          • "active"
          • "retired"
        • region — (String)

          The AWS Region.

        • ec2InstanceFamily — (String)

          The EC2 instance family.

        • savingsPlanType — (String)

          The plan type.

          Possible values include:
          • "Compute"
          • "EC2Instance"
        • paymentOption — (String)

          The payment option.

          Possible values include:
          • "All Upfront"
          • "Partial Upfront"
          • "No Upfront"
        • productTypes — (Array<String>)

          The product types.

        • currency — (String)

          The currency.

          Possible values include:
          • "CNY"
          • "USD"
        • 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 — (map<String>)

          One or more tags.

      • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSavingsPlansOfferingRates(params = {}, callback) ⇒ AWS.Request

Describes the specified Savings Plans offering rates.

Examples:

Calling the describeSavingsPlansOfferingRates operation

var params = {
  filters: [
    {
      name: region | instanceFamily | instanceType | productDescription | tenancy | productId,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  operations: [
    'STRING_VALUE',
    /* more items */
  ],
  products: [
    EC2 | Fargate | Lambda,
    /* more items */
  ],
  savingsPlanOfferingIds: [
    'STRING_VALUE',
    /* more items */
  ],
  savingsPlanPaymentOptions: [
    All Upfront | Partial Upfront | No Upfront,
    /* more items */
  ],
  savingsPlanTypes: [
    Compute | EC2Instance,
    /* more items */
  ],
  serviceCodes: [
    AmazonEC2 | AmazonECS | AWSLambda,
    /* more items */
  ],
  usageTypes: [
    'STRING_VALUE',
    /* more items */
  ]
};
savingsplans.describeSavingsPlansOfferingRates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • savingsPlanOfferingIds — (Array<String>)

      The IDs of the offerings.

    • savingsPlanPaymentOptions — (Array<String>)

      The payment options.

    • savingsPlanTypes — (Array<String>)

      The plan types.

    • products — (Array<String>)

      The AWS products.

    • serviceCodes — (Array<String>)

      The services.

    • usageTypes — (Array<String>)

      The usage details of the line item in the billing report.

    • operations — (Array<String>)

      The specific AWS operation for the line item in the billing report.

    • filters — (Array<map>)

      The filters.

      • name — (String)

        The filter name.

        Possible values include:
        • "region"
        • "instanceFamily"
        • "instanceType"
        • "productDescription"
        • "tenancy"
        • "productId"
      • values — (Array<String>)

        The filter values.

    • nextToken — (String)

      The token for the next page of results.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • searchResults — (Array<map>)

        Information about the Savings Plans offering rates.

        • savingsPlanOffering — (map)

          The Savings Plan offering.

          • offeringId — (String)

            The ID of the offering.

          • paymentOption — (String)

            The payment option.

            Possible values include:
            • "All Upfront"
            • "Partial Upfront"
            • "No Upfront"
          • planType — (String)

            The plan type.

            Possible values include:
            • "Compute"
            • "EC2Instance"
          • durationSeconds — (Integer)

            The duration, in seconds.

          • currency — (String)

            The currency.

            Possible values include:
            • "CNY"
            • "USD"
          • planDescription — (String)

            The description.

        • rate — (String)

          The Savings Plan rate.

        • unit — (String)

          The unit.

          Possible values include:
          • "Hrs"
          • "Lambda-GB-Second"
          • "Request"
        • productType — (String)

          The product type.

          Possible values include:
          • "EC2"
          • "Fargate"
          • "Lambda"
        • serviceCode — (String)

          The service.

          Possible values include:
          • "AmazonEC2"
          • "AmazonECS"
          • "AWSLambda"
        • 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 — (Array<map>)

          The properties.

          • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSavingsPlansOfferings(params = {}, callback) ⇒ AWS.Request

Describes the specified Savings Plans offerings.

Service Reference:

Examples:

Calling the describeSavingsPlansOfferings operation

var params = {
  currencies: [
    CNY | USD,
    /* more items */
  ],
  descriptions: [
    'STRING_VALUE',
    /* more items */
  ],
  durations: [
    'NUMBER_VALUE',
    /* more items */
  ],
  filters: [
    {
      name: region | instanceFamily,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  offeringIds: [
    'STRING_VALUE',
    /* more items */
  ],
  operations: [
    'STRING_VALUE',
    /* more items */
  ],
  paymentOptions: [
    All Upfront | Partial Upfront | No Upfront,
    /* more items */
  ],
  planTypes: [
    Compute | EC2Instance,
    /* more items */
  ],
  productType: EC2 | Fargate | Lambda,
  serviceCodes: [
    'STRING_VALUE',
    /* more items */
  ],
  usageTypes: [
    'STRING_VALUE',
    /* more items */
  ]
};
savingsplans.describeSavingsPlansOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • offeringIds — (Array<String>)

      The IDs of the offerings.

    • paymentOptions — (Array<String>)

      The payment options.

    • productType — (String)

      The product type.

      Possible values include:
      • "EC2"
      • "Fargate"
      • "Lambda"
    • planTypes — (Array<String>)

      The plan type.

    • durations — (Array<Integer>)

      The durations, in seconds.

    • currencies — (Array<String>)

      The currencies.

    • descriptions — (Array<String>)

      The descriptions.

    • serviceCodes — (Array<String>)

      The services.

    • usageTypes — (Array<String>)

      The usage details of the line item in the billing report.

    • operations — (Array<String>)

      The specific AWS operation for the line item in the billing report.

    • filters — (Array<map>)

      The filters.

      • name — (String)

        The filter name.

        Possible values include:
        • "region"
        • "instanceFamily"
      • values — (Array<String>)

        The filter values.

    • nextToken — (String)

      The token for the next page of results.

    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • searchResults — (Array<map>)

        Information about the Savings Plans offerings.

        • offeringId — (String)

          The ID of the offering.

        • productTypes — (Array<String>)

          The product type.

        • planType — (String)

          The plan type.

          Possible values include:
          • "Compute"
          • "EC2Instance"
        • description — (String)

          The description.

        • paymentOption — (String)

          The payment option.

          Possible values include:
          • "All Upfront"
          • "Partial Upfront"
          • "No Upfront"
        • durationSeconds — (Integer)

          The duration, in seconds.

        • currency — (String)

          The currency.

          Possible values include:
          • "CNY"
          • "USD"
        • 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 — (Array<map>)

          The properties.

          • name — (String)

            The property name.

            Possible values include:
            • "region"
            • "instanceFamily"
          • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
savingsplans.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        Information about the tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds the specified tags to the specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
savingsplans.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      One or more tags. For example, { "tags": "key2":"value2" }.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the specified tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
savingsplans.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The tag keys.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.