@aws-sdk/client-savingsplans 3.533.0 → 3.538.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/README.md +12 -4
  2. package/dist-cjs/index.js +53 -1
  3. package/dist-es/Savingsplans.js +2 -0
  4. package/dist-es/commands/ReturnSavingsPlanCommand.js +24 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/models_0.js +2 -0
  7. package/dist-es/protocols/Aws_restJson1.js +28 -0
  8. package/dist-types/Savingsplans.d.ts +14 -4
  9. package/dist-types/SavingsplansClient.d.ts +7 -6
  10. package/dist-types/commands/CreateSavingsPlanCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteQueuedSavingsPlanCommand.d.ts +2 -1
  12. package/dist-types/commands/DescribeSavingsPlanRatesCommand.d.ts +3 -2
  13. package/dist-types/commands/DescribeSavingsPlansCommand.d.ts +5 -3
  14. package/dist-types/commands/DescribeSavingsPlansOfferingRatesCommand.d.ts +3 -2
  15. package/dist-types/commands/DescribeSavingsPlansOfferingsCommand.d.ts +3 -2
  16. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  17. package/dist-types/commands/ReturnSavingsPlanCommand.d.ts +72 -0
  18. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  19. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  20. package/dist-types/commands/index.d.ts +1 -0
  21. package/dist-types/index.d.ts +4 -4
  22. package/dist-types/models/models_0.d.ts +190 -147
  23. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  24. package/dist-types/ts3.4/Savingsplans.d.ts +20 -0
  25. package/dist-types/ts3.4/SavingsplansClient.d.ts +6 -0
  26. package/dist-types/ts3.4/commands/CreateSavingsPlanCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/DeleteQueuedSavingsPlanCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/DescribeSavingsPlanRatesCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/DescribeSavingsPlansCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/DescribeSavingsPlansOfferingRatesCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/DescribeSavingsPlansOfferingsCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/ReturnSavingsPlanCommand.d.ts +39 -0
  34. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  37. package/dist-types/ts3.4/models/models_0.d.ts +10 -0
  38. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  39. package/package.json +40 -40
package/README.md CHANGED
@@ -6,10 +6,10 @@
6
6
 
7
7
  AWS SDK for JavaScript Savingsplans Client for Node.js, Browser and React Native.
8
8
 
9
- <p>Savings Plans are a pricing model that offer significant savings on AWS usage (for
10
- example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD
11
- per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For
12
- more information, see the <a href="https://docs.aws.amazon.com/savingsplans/latest/userguide/">AWS Savings Plans User Guide</a>.</p>
9
+ <p>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
10
+ amount of usage per hour, in the specified currency, for a term of one or three years, and
11
+ receive a lower price for that usage. For more information, see the <a href="https://docs.aws.amazon.com/savingsplans/latest/userguide/">Amazon Web Services
12
+ Savings Plans User Guide</a>.</p>
13
13
 
14
14
  ## Installing
15
15
 
@@ -261,6 +261,14 @@ ListTagsForResource
261
261
 
262
262
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/savingsplans/command/ListTagsForResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-savingsplans/Interface/ListTagsForResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-savingsplans/Interface/ListTagsForResourceCommandOutput/)
263
263
 
264
+ </details>
265
+ <details>
266
+ <summary>
267
+ ReturnSavingsPlan
268
+ </summary>
269
+
270
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/savingsplans/command/ReturnSavingsPlanCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-savingsplans/Interface/ReturnSavingsPlanCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-savingsplans/Interface/ReturnSavingsPlanCommandOutput/)
271
+
264
272
  </details>
265
273
  <details>
266
274
  <summary>
package/dist-cjs/index.js CHANGED
@@ -31,6 +31,7 @@ __export(src_exports, {
31
31
  InternalServerException: () => InternalServerException,
32
32
  ListTagsForResourceCommand: () => ListTagsForResourceCommand,
33
33
  ResourceNotFoundException: () => ResourceNotFoundException,
34
+ ReturnSavingsPlanCommand: () => ReturnSavingsPlanCommand,
34
35
  SavingsPlanOfferingFilterAttribute: () => SavingsPlanOfferingFilterAttribute,
35
36
  SavingsPlanOfferingPropertyKey: () => SavingsPlanOfferingPropertyKey,
36
37
  SavingsPlanPaymentOption: () => SavingsPlanPaymentOption,
@@ -349,9 +350,11 @@ var SavingsPlanState = {
349
350
  ACTIVE: "active",
350
351
  PAYMENT_FAILED: "payment-failed",
351
352
  PAYMENT_PENDING: "payment-pending",
353
+ PENDING_RETURN: "pending-return",
352
354
  QUEUED: "queued",
353
355
  QUEUED_DELETED: "queued-deleted",
354
- RETIRED: "retired"
356
+ RETIRED: "retired",
357
+ RETURNED: "returned"
355
358
  };
356
359
  var SavingsPlanPaymentOption = {
357
360
  ALL_UPFRONT: "All Upfront",
@@ -520,6 +523,22 @@ var se_ListTagsForResourceCommand = /* @__PURE__ */ __name(async (input, context
520
523
  b.m("POST").h(headers).b(body);
521
524
  return b.build();
522
525
  }, "se_ListTagsForResourceCommand");
526
+ var se_ReturnSavingsPlanCommand = /* @__PURE__ */ __name(async (input, context) => {
527
+ const b = (0, import_core.requestBuilder)(input, context);
528
+ const headers = {
529
+ "content-type": "application/json"
530
+ };
531
+ b.bp("/ReturnSavingsPlan");
532
+ let body;
533
+ body = JSON.stringify(
534
+ (0, import_smithy_client.take)(input, {
535
+ clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
536
+ savingsPlanId: []
537
+ })
538
+ );
539
+ b.m("POST").h(headers).b(body);
540
+ return b.build();
541
+ }, "se_ReturnSavingsPlanCommand");
523
542
  var se_TagResourceCommand = /* @__PURE__ */ __name(async (input, context) => {
524
543
  const b = (0, import_core.requestBuilder)(input, context);
525
544
  const headers = {
@@ -651,6 +670,20 @@ var de_ListTagsForResourceCommand = /* @__PURE__ */ __name(async (output, contex
651
670
  Object.assign(contents, doc);
652
671
  return contents;
653
672
  }, "de_ListTagsForResourceCommand");
673
+ var de_ReturnSavingsPlanCommand = /* @__PURE__ */ __name(async (output, context) => {
674
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
675
+ return de_CommandError(output, context);
676
+ }
677
+ const contents = (0, import_smithy_client.map)({
678
+ $metadata: deserializeMetadata(output)
679
+ });
680
+ const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
681
+ const doc = (0, import_smithy_client.take)(data, {
682
+ savingsPlanId: import_smithy_client.expectString
683
+ });
684
+ Object.assign(contents, doc);
685
+ return contents;
686
+ }, "de_ReturnSavingsPlanCommand");
654
687
  var de_TagResourceCommand = /* @__PURE__ */ __name(async (output, context) => {
655
688
  if (output.statusCode !== 200 && output.statusCode >= 300) {
656
689
  return de_CommandError(output, context);
@@ -874,6 +907,23 @@ var _ListTagsForResourceCommand = class _ListTagsForResourceCommand extends impo
874
907
  __name(_ListTagsForResourceCommand, "ListTagsForResourceCommand");
875
908
  var ListTagsForResourceCommand = _ListTagsForResourceCommand;
876
909
 
910
+ // src/commands/ReturnSavingsPlanCommand.ts
911
+
912
+
913
+
914
+
915
+ var _ReturnSavingsPlanCommand = class _ReturnSavingsPlanCommand extends import_smithy_client.Command.classBuilder().ep({
916
+ ...commonParams
917
+ }).m(function(Command, cs, config, o) {
918
+ return [
919
+ (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
920
+ (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
921
+ ];
922
+ }).s("AWSSavingsPlan", "ReturnSavingsPlan", {}).n("SavingsplansClient", "ReturnSavingsPlanCommand").f(void 0, void 0).ser(se_ReturnSavingsPlanCommand).de(de_ReturnSavingsPlanCommand).build() {
923
+ };
924
+ __name(_ReturnSavingsPlanCommand, "ReturnSavingsPlanCommand");
925
+ var ReturnSavingsPlanCommand = _ReturnSavingsPlanCommand;
926
+
877
927
  // src/commands/TagResourceCommand.ts
878
928
 
879
929
 
@@ -917,6 +967,7 @@ var commands = {
917
967
  DescribeSavingsPlansOfferingRatesCommand,
918
968
  DescribeSavingsPlansOfferingsCommand,
919
969
  ListTagsForResourceCommand,
970
+ ReturnSavingsPlanCommand,
920
971
  TagResourceCommand,
921
972
  UntagResourceCommand
922
973
  };
@@ -943,6 +994,7 @@ var import_util_endpoints = require("@aws-sdk/util-endpoints");
943
994
  DescribeSavingsPlansOfferingRatesCommand,
944
995
  DescribeSavingsPlansOfferingsCommand,
945
996
  ListTagsForResourceCommand,
997
+ ReturnSavingsPlanCommand,
946
998
  TagResourceCommand,
947
999
  UntagResourceCommand,
948
1000
  InternalServerException,
@@ -6,6 +6,7 @@ import { DescribeSavingsPlansCommand, } from "./commands/DescribeSavingsPlansCom
6
6
  import { DescribeSavingsPlansOfferingRatesCommand, } from "./commands/DescribeSavingsPlansOfferingRatesCommand";
7
7
  import { DescribeSavingsPlansOfferingsCommand, } from "./commands/DescribeSavingsPlansOfferingsCommand";
8
8
  import { ListTagsForResourceCommand, } from "./commands/ListTagsForResourceCommand";
9
+ import { ReturnSavingsPlanCommand, } from "./commands/ReturnSavingsPlanCommand";
9
10
  import { TagResourceCommand } from "./commands/TagResourceCommand";
10
11
  import { UntagResourceCommand, } from "./commands/UntagResourceCommand";
11
12
  import { SavingsplansClient } from "./SavingsplansClient";
@@ -17,6 +18,7 @@ const commands = {
17
18
  DescribeSavingsPlansOfferingRatesCommand,
18
19
  DescribeSavingsPlansOfferingsCommand,
19
20
  ListTagsForResourceCommand,
21
+ ReturnSavingsPlanCommand,
20
22
  TagResourceCommand,
21
23
  UntagResourceCommand,
22
24
  };
@@ -0,0 +1,24 @@
1
+ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
2
+ import { getSerdePlugin } from "@smithy/middleware-serde";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { commonParams } from "../endpoint/EndpointParameters";
5
+ import { de_ReturnSavingsPlanCommand, se_ReturnSavingsPlanCommand } from "../protocols/Aws_restJson1";
6
+ export { $Command };
7
+ export class ReturnSavingsPlanCommand extends $Command
8
+ .classBuilder()
9
+ .ep({
10
+ ...commonParams,
11
+ })
12
+ .m(function (Command, cs, config, o) {
13
+ return [
14
+ getSerdePlugin(config, this.serialize, this.deserialize),
15
+ getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
16
+ ];
17
+ })
18
+ .s("AWSSavingsPlan", "ReturnSavingsPlan", {})
19
+ .n("SavingsplansClient", "ReturnSavingsPlanCommand")
20
+ .f(void 0, void 0)
21
+ .ser(se_ReturnSavingsPlanCommand)
22
+ .de(de_ReturnSavingsPlanCommand)
23
+ .build() {
24
+ }
@@ -5,5 +5,6 @@ export * from "./DescribeSavingsPlansCommand";
5
5
  export * from "./DescribeSavingsPlansOfferingRatesCommand";
6
6
  export * from "./DescribeSavingsPlansOfferingsCommand";
7
7
  export * from "./ListTagsForResourceCommand";
8
+ export * from "./ReturnSavingsPlanCommand";
8
9
  export * from "./TagResourceCommand";
9
10
  export * from "./UntagResourceCommand";
@@ -101,9 +101,11 @@ export const SavingsPlanState = {
101
101
  ACTIVE: "active",
102
102
  PAYMENT_FAILED: "payment-failed",
103
103
  PAYMENT_PENDING: "payment-pending",
104
+ PENDING_RETURN: "pending-return",
104
105
  QUEUED: "queued",
105
106
  QUEUED_DELETED: "queued-deleted",
106
107
  RETIRED: "retired",
108
+ RETURNED: "returned",
107
109
  };
108
110
  export const SavingsPlanPaymentOption = {
109
111
  ALL_UPFRONT: "All Upfront",
@@ -129,6 +129,20 @@ export const se_ListTagsForResourceCommand = async (input, context) => {
129
129
  b.m("POST").h(headers).b(body);
130
130
  return b.build();
131
131
  };
132
+ export const se_ReturnSavingsPlanCommand = async (input, context) => {
133
+ const b = rb(input, context);
134
+ const headers = {
135
+ "content-type": "application/json",
136
+ };
137
+ b.bp("/ReturnSavingsPlan");
138
+ let body;
139
+ body = JSON.stringify(take(input, {
140
+ clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
141
+ savingsPlanId: [],
142
+ }));
143
+ b.m("POST").h(headers).b(body);
144
+ return b.build();
145
+ };
132
146
  export const se_TagResourceCommand = async (input, context) => {
133
147
  const b = rb(input, context);
134
148
  const headers = {
@@ -256,6 +270,20 @@ export const de_ListTagsForResourceCommand = async (output, context) => {
256
270
  Object.assign(contents, doc);
257
271
  return contents;
258
272
  };
273
+ export const de_ReturnSavingsPlanCommand = async (output, context) => {
274
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
275
+ return de_CommandError(output, context);
276
+ }
277
+ const contents = map({
278
+ $metadata: deserializeMetadata(output),
279
+ });
280
+ const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
281
+ const doc = take(data, {
282
+ savingsPlanId: __expectString,
283
+ });
284
+ Object.assign(contents, doc);
285
+ return contents;
286
+ };
259
287
  export const de_TagResourceCommand = async (output, context) => {
260
288
  if (output.statusCode !== 200 && output.statusCode >= 300) {
261
289
  return de_CommandError(output, context);
@@ -6,6 +6,7 @@ import { DescribeSavingsPlansCommandInput, DescribeSavingsPlansCommandOutput } f
6
6
  import { DescribeSavingsPlansOfferingRatesCommandInput, DescribeSavingsPlansOfferingRatesCommandOutput } from "./commands/DescribeSavingsPlansOfferingRatesCommand";
7
7
  import { DescribeSavingsPlansOfferingsCommandInput, DescribeSavingsPlansOfferingsCommandOutput } from "./commands/DescribeSavingsPlansOfferingsCommand";
8
8
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
9
+ import { ReturnSavingsPlanCommandInput, ReturnSavingsPlanCommandOutput } from "./commands/ReturnSavingsPlanCommand";
9
10
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
10
11
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
11
12
  import { SavingsplansClient } from "./SavingsplansClient";
@@ -31,18 +32,21 @@ export interface Savingsplans {
31
32
  /**
32
33
  * @see {@link DescribeSavingsPlansCommand}
33
34
  */
35
+ describeSavingsPlans(): Promise<DescribeSavingsPlansCommandOutput>;
34
36
  describeSavingsPlans(args: DescribeSavingsPlansCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSavingsPlansCommandOutput>;
35
37
  describeSavingsPlans(args: DescribeSavingsPlansCommandInput, cb: (err: any, data?: DescribeSavingsPlansCommandOutput) => void): void;
36
38
  describeSavingsPlans(args: DescribeSavingsPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSavingsPlansCommandOutput) => void): void;
37
39
  /**
38
40
  * @see {@link DescribeSavingsPlansOfferingRatesCommand}
39
41
  */
42
+ describeSavingsPlansOfferingRates(): Promise<DescribeSavingsPlansOfferingRatesCommandOutput>;
40
43
  describeSavingsPlansOfferingRates(args: DescribeSavingsPlansOfferingRatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSavingsPlansOfferingRatesCommandOutput>;
41
44
  describeSavingsPlansOfferingRates(args: DescribeSavingsPlansOfferingRatesCommandInput, cb: (err: any, data?: DescribeSavingsPlansOfferingRatesCommandOutput) => void): void;
42
45
  describeSavingsPlansOfferingRates(args: DescribeSavingsPlansOfferingRatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSavingsPlansOfferingRatesCommandOutput) => void): void;
43
46
  /**
44
47
  * @see {@link DescribeSavingsPlansOfferingsCommand}
45
48
  */
49
+ describeSavingsPlansOfferings(): Promise<DescribeSavingsPlansOfferingsCommandOutput>;
46
50
  describeSavingsPlansOfferings(args: DescribeSavingsPlansOfferingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSavingsPlansOfferingsCommandOutput>;
47
51
  describeSavingsPlansOfferings(args: DescribeSavingsPlansOfferingsCommandInput, cb: (err: any, data?: DescribeSavingsPlansOfferingsCommandOutput) => void): void;
48
52
  describeSavingsPlansOfferings(args: DescribeSavingsPlansOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSavingsPlansOfferingsCommandOutput) => void): void;
@@ -52,6 +56,12 @@ export interface Savingsplans {
52
56
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
53
57
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
54
58
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
59
+ /**
60
+ * @see {@link ReturnSavingsPlanCommand}
61
+ */
62
+ returnSavingsPlan(args: ReturnSavingsPlanCommandInput, options?: __HttpHandlerOptions): Promise<ReturnSavingsPlanCommandOutput>;
63
+ returnSavingsPlan(args: ReturnSavingsPlanCommandInput, cb: (err: any, data?: ReturnSavingsPlanCommandOutput) => void): void;
64
+ returnSavingsPlan(args: ReturnSavingsPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReturnSavingsPlanCommandOutput) => void): void;
55
65
  /**
56
66
  * @see {@link TagResourceCommand}
57
67
  */
@@ -66,11 +76,11 @@ export interface Savingsplans {
66
76
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
67
77
  }
68
78
  /**
79
+ * <p>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
80
+ * amount of usage per hour, in the specified currency, for a term of one or three years, and
81
+ * receive a lower price for that usage. For more information, see the <a href="https://docs.aws.amazon.com/savingsplans/latest/userguide/">Amazon Web Services
82
+ * Savings Plans User Guide</a>.</p>
69
83
  * @public
70
- * <p>Savings Plans are a pricing model that offer significant savings on AWS usage (for
71
- * example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD
72
- * per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For
73
- * more information, see the <a href="https://docs.aws.amazon.com/savingsplans/latest/userguide/">AWS Savings Plans User Guide</a>.</p>
74
84
  */
75
85
  export declare class Savingsplans extends SavingsplansClient implements Savingsplans {
76
86
  }
@@ -14,6 +14,7 @@ import { DescribeSavingsPlansCommandInput, DescribeSavingsPlansCommandOutput } f
14
14
  import { DescribeSavingsPlansOfferingRatesCommandInput, DescribeSavingsPlansOfferingRatesCommandOutput } from "./commands/DescribeSavingsPlansOfferingRatesCommand";
15
15
  import { DescribeSavingsPlansOfferingsCommandInput, DescribeSavingsPlansOfferingsCommandOutput } from "./commands/DescribeSavingsPlansOfferingsCommand";
16
16
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
17
+ import { ReturnSavingsPlanCommandInput, ReturnSavingsPlanCommandOutput } from "./commands/ReturnSavingsPlanCommand";
17
18
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
18
19
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
19
20
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
@@ -22,11 +23,11 @@ export { __Client };
22
23
  /**
23
24
  * @public
24
25
  */
25
- export type ServiceInputTypes = CreateSavingsPlanCommandInput | DeleteQueuedSavingsPlanCommandInput | DescribeSavingsPlanRatesCommandInput | DescribeSavingsPlansCommandInput | DescribeSavingsPlansOfferingRatesCommandInput | DescribeSavingsPlansOfferingsCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
26
+ export type ServiceInputTypes = CreateSavingsPlanCommandInput | DeleteQueuedSavingsPlanCommandInput | DescribeSavingsPlanRatesCommandInput | DescribeSavingsPlansCommandInput | DescribeSavingsPlansOfferingRatesCommandInput | DescribeSavingsPlansOfferingsCommandInput | ListTagsForResourceCommandInput | ReturnSavingsPlanCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
26
27
  /**
27
28
  * @public
28
29
  */
29
- export type ServiceOutputTypes = CreateSavingsPlanCommandOutput | DeleteQueuedSavingsPlanCommandOutput | DescribeSavingsPlanRatesCommandOutput | DescribeSavingsPlansCommandOutput | DescribeSavingsPlansOfferingRatesCommandOutput | DescribeSavingsPlansOfferingsCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
30
+ export type ServiceOutputTypes = CreateSavingsPlanCommandOutput | DeleteQueuedSavingsPlanCommandOutput | DescribeSavingsPlanRatesCommandOutput | DescribeSavingsPlansCommandOutput | DescribeSavingsPlansOfferingRatesCommandOutput | DescribeSavingsPlansOfferingsCommandOutput | ListTagsForResourceCommandOutput | ReturnSavingsPlanCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
30
31
  /**
31
32
  * @public
32
33
  */
@@ -160,11 +161,11 @@ export type SavingsplansClientResolvedConfigType = __SmithyResolvedConfiguration
160
161
  export interface SavingsplansClientResolvedConfig extends SavingsplansClientResolvedConfigType {
161
162
  }
162
163
  /**
164
+ * <p>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
165
+ * amount of usage per hour, in the specified currency, for a term of one or three years, and
166
+ * receive a lower price for that usage. For more information, see the <a href="https://docs.aws.amazon.com/savingsplans/latest/userguide/">Amazon Web Services
167
+ * Savings Plans User Guide</a>.</p>
163
168
  * @public
164
- * <p>Savings Plans are a pricing model that offer significant savings on AWS usage (for
165
- * example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD
166
- * per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For
167
- * more information, see the <a href="https://docs.aws.amazon.com/savingsplans/latest/userguide/">AWS Savings Plans User Guide</a>.</p>
168
169
  */
169
170
  export declare class SavingsplansClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SavingsplansClientResolvedConfig> {
170
171
  /**
@@ -22,10 +22,10 @@ export interface CreateSavingsPlanCommandOutput extends CreateSavingsPlanRespons
22
22
  }
23
23
  declare const CreateSavingsPlanCommand_base: {
24
24
  new (input: CreateSavingsPlanCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSavingsPlanCommandInput, CreateSavingsPlanCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: CreateSavingsPlanCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSavingsPlanCommandInput, CreateSavingsPlanCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Creates a Savings Plan.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -72,6 +72,7 @@ declare const CreateSavingsPlanCommand_base: {
72
72
  * @throws {@link SavingsplansServiceException}
73
73
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
74
74
  *
75
+ * @public
75
76
  */
76
77
  export declare class CreateSavingsPlanCommand extends CreateSavingsPlanCommand_base {
77
78
  }
@@ -22,10 +22,10 @@ export interface DeleteQueuedSavingsPlanCommandOutput extends DeleteQueuedSaving
22
22
  }
23
23
  declare const DeleteQueuedSavingsPlanCommand_base: {
24
24
  new (input: DeleteQueuedSavingsPlanCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteQueuedSavingsPlanCommandInput, DeleteQueuedSavingsPlanCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: DeleteQueuedSavingsPlanCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteQueuedSavingsPlanCommandInput, DeleteQueuedSavingsPlanCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Deletes the queued purchase for the specified Savings Plan.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -63,6 +63,7 @@ declare const DeleteQueuedSavingsPlanCommand_base: {
63
63
  * @throws {@link SavingsplansServiceException}
64
64
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
65
65
  *
66
+ * @public
66
67
  */
67
68
  export declare class DeleteQueuedSavingsPlanCommand extends DeleteQueuedSavingsPlanCommand_base {
68
69
  }
@@ -22,11 +22,11 @@ export interface DescribeSavingsPlanRatesCommandOutput extends DescribeSavingsPl
22
22
  }
23
23
  declare const DescribeSavingsPlanRatesCommand_base: {
24
24
  new (input: DescribeSavingsPlanRatesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSavingsPlanRatesCommandInput, DescribeSavingsPlanRatesCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: DescribeSavingsPlanRatesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSavingsPlanRatesCommandInput, DescribeSavingsPlanRatesCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
- * <p>Describes the specified Savings Plans rates.</p>
29
+ * <p>Describes the rates for the specified Savings Plan.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -87,6 +87,7 @@ declare const DescribeSavingsPlanRatesCommand_base: {
87
87
  * @throws {@link SavingsplansServiceException}
88
88
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
89
89
  *
90
+ * @public
90
91
  */
91
92
  export declare class DescribeSavingsPlanRatesCommand extends DescribeSavingsPlanRatesCommand_base {
92
93
  }
@@ -22,10 +22,10 @@ export interface DescribeSavingsPlansCommandOutput extends DescribeSavingsPlansR
22
22
  }
23
23
  declare const DescribeSavingsPlansCommand_base: {
24
24
  new (input: DescribeSavingsPlansCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSavingsPlansCommandInput, DescribeSavingsPlansCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [DescribeSavingsPlansCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeSavingsPlansCommandInput, DescribeSavingsPlansCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Describes the specified Savings Plans.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -43,7 +43,7 @@ declare const DescribeSavingsPlansCommand_base: {
43
43
  * nextToken: "STRING_VALUE",
44
44
  * maxResults: Number("int"),
45
45
  * states: [ // SavingsPlanStateList
46
- * "payment-pending" || "payment-failed" || "active" || "retired" || "queued" || "queued-deleted",
46
+ * "payment-pending" || "payment-failed" || "active" || "retired" || "queued" || "queued-deleted" || "pending-return" || "returned",
47
47
  * ],
48
48
  * filters: [ // SavingsPlanFilterList
49
49
  * { // SavingsPlanFilter
@@ -65,7 +65,7 @@ declare const DescribeSavingsPlansCommand_base: {
65
65
  * // description: "STRING_VALUE",
66
66
  * // start: "STRING_VALUE",
67
67
  * // end: "STRING_VALUE",
68
- * // state: "payment-pending" || "payment-failed" || "active" || "retired" || "queued" || "queued-deleted",
68
+ * // state: "payment-pending" || "payment-failed" || "active" || "retired" || "queued" || "queued-deleted" || "pending-return" || "returned",
69
69
  * // region: "STRING_VALUE",
70
70
  * // ec2InstanceFamily: "STRING_VALUE",
71
71
  * // savingsPlanType: "Compute" || "EC2Instance" || "SageMaker",
@@ -81,6 +81,7 @@ declare const DescribeSavingsPlansCommand_base: {
81
81
  * // tags: { // TagMap
82
82
  * // "<keys>": "STRING_VALUE",
83
83
  * // },
84
+ * // returnableUntil: "STRING_VALUE",
84
85
  * // },
85
86
  * // ],
86
87
  * // nextToken: "STRING_VALUE",
@@ -103,6 +104,7 @@ declare const DescribeSavingsPlansCommand_base: {
103
104
  * @throws {@link SavingsplansServiceException}
104
105
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
105
106
  *
107
+ * @public
106
108
  */
107
109
  export declare class DescribeSavingsPlansCommand extends DescribeSavingsPlansCommand_base {
108
110
  }
@@ -22,11 +22,11 @@ export interface DescribeSavingsPlansOfferingRatesCommandOutput extends Describe
22
22
  }
23
23
  declare const DescribeSavingsPlansOfferingRatesCommand_base: {
24
24
  new (input: DescribeSavingsPlansOfferingRatesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSavingsPlansOfferingRatesCommandInput, DescribeSavingsPlansOfferingRatesCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [DescribeSavingsPlansOfferingRatesCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeSavingsPlansOfferingRatesCommandInput, DescribeSavingsPlansOfferingRatesCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
- * <p>Describes the specified Savings Plans offering rates.</p>
29
+ * <p>Describes the offering rates for the specified Savings Plans.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -113,6 +113,7 @@ declare const DescribeSavingsPlansOfferingRatesCommand_base: {
113
113
  * @throws {@link SavingsplansServiceException}
114
114
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
115
115
  *
116
+ * @public
116
117
  */
117
118
  export declare class DescribeSavingsPlansOfferingRatesCommand extends DescribeSavingsPlansOfferingRatesCommand_base {
118
119
  }
@@ -22,11 +22,11 @@ export interface DescribeSavingsPlansOfferingsCommandOutput extends DescribeSavi
22
22
  }
23
23
  declare const DescribeSavingsPlansOfferingsCommand_base: {
24
24
  new (input: DescribeSavingsPlansOfferingsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSavingsPlansOfferingsCommandInput, DescribeSavingsPlansOfferingsCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [DescribeSavingsPlansOfferingsCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeSavingsPlansOfferingsCommandInput, DescribeSavingsPlansOfferingsCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
- * <p>Describes the specified Savings Plans offerings.</p>
29
+ * <p>Describes the offerings for the specified Savings Plans.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -118,6 +118,7 @@ declare const DescribeSavingsPlansOfferingsCommand_base: {
118
118
  * @throws {@link SavingsplansServiceException}
119
119
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
120
120
  *
121
+ * @public
121
122
  */
122
123
  export declare class DescribeSavingsPlansOfferingsCommand extends DescribeSavingsPlansOfferingsCommand_base {
123
124
  }
@@ -22,10 +22,10 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
22
22
  }
23
23
  declare const ListTagsForResourceCommand_base: {
24
24
  new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Lists the tags for the specified resource.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -64,6 +64,7 @@ declare const ListTagsForResourceCommand_base: {
64
64
  * @throws {@link SavingsplansServiceException}
65
65
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
66
66
  *
67
+ * @public
67
68
  */
68
69
  export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
69
70
  }
@@ -0,0 +1,72 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ReturnSavingsPlanRequest, ReturnSavingsPlanResponse } from "../models/models_0";
4
+ import { SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SavingsplansClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link ReturnSavingsPlanCommand}.
13
+ */
14
+ export interface ReturnSavingsPlanCommandInput extends ReturnSavingsPlanRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link ReturnSavingsPlanCommand}.
20
+ */
21
+ export interface ReturnSavingsPlanCommandOutput extends ReturnSavingsPlanResponse, __MetadataBearer {
22
+ }
23
+ declare const ReturnSavingsPlanCommand_base: {
24
+ new (input: ReturnSavingsPlanCommandInput): import("@smithy/smithy-client").CommandImpl<ReturnSavingsPlanCommandInput, ReturnSavingsPlanCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: ReturnSavingsPlanCommandInput): import("@smithy/smithy-client").CommandImpl<ReturnSavingsPlanCommandInput, ReturnSavingsPlanCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Returns the specified Savings Plan.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { SavingsplansClient, ReturnSavingsPlanCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import
34
+ * // const { SavingsplansClient, ReturnSavingsPlanCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import
35
+ * const client = new SavingsplansClient(config);
36
+ * const input = { // ReturnSavingsPlanRequest
37
+ * savingsPlanId: "STRING_VALUE", // required
38
+ * clientToken: "STRING_VALUE",
39
+ * };
40
+ * const command = new ReturnSavingsPlanCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // ReturnSavingsPlanResponse
43
+ * // savingsPlanId: "STRING_VALUE",
44
+ * // };
45
+ *
46
+ * ```
47
+ *
48
+ * @param ReturnSavingsPlanCommandInput - {@link ReturnSavingsPlanCommandInput}
49
+ * @returns {@link ReturnSavingsPlanCommandOutput}
50
+ * @see {@link ReturnSavingsPlanCommandInput} for command's `input` shape.
51
+ * @see {@link ReturnSavingsPlanCommandOutput} for command's `response` shape.
52
+ * @see {@link SavingsplansClientResolvedConfig | config} for SavingsplansClient's `config` shape.
53
+ *
54
+ * @throws {@link InternalServerException} (server fault)
55
+ * <p>An unexpected error occurred.</p>
56
+ *
57
+ * @throws {@link ResourceNotFoundException} (client fault)
58
+ * <p>The specified resource was not found.</p>
59
+ *
60
+ * @throws {@link ServiceQuotaExceededException} (client fault)
61
+ * <p>A service quota has been exceeded.</p>
62
+ *
63
+ * @throws {@link ValidationException} (client fault)
64
+ * <p>One of the input parameters is not valid.</p>
65
+ *
66
+ * @throws {@link SavingsplansServiceException}
67
+ * <p>Base exception class for all service exceptions from Savingsplans service.</p>
68
+ *
69
+ * @public
70
+ */
71
+ export declare class ReturnSavingsPlanCommand extends ReturnSavingsPlanCommand_base {
72
+ }
@@ -22,10 +22,10 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
22
22
  }
23
23
  declare const TagResourceCommand_base: {
24
24
  new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Adds the specified tags to the specified resource.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -66,6 +66,7 @@ declare const TagResourceCommand_base: {
66
66
  * @throws {@link SavingsplansServiceException}
67
67
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
68
68
  *
69
+ * @public
69
70
  */
70
71
  export declare class TagResourceCommand extends TagResourceCommand_base {
71
72
  }
@@ -22,10 +22,10 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
22
22
  }
23
23
  declare const UntagResourceCommand_base: {
24
24
  new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, SavingsplansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Removes the specified tags from the specified resource.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -63,6 +63,7 @@ declare const UntagResourceCommand_base: {
63
63
  * @throws {@link SavingsplansServiceException}
64
64
  * <p>Base exception class for all service exceptions from Savingsplans service.</p>
65
65
  *
66
+ * @public
66
67
  */
67
68
  export declare class UntagResourceCommand extends UntagResourceCommand_base {
68
69
  }
@@ -5,5 +5,6 @@ export * from "./DescribeSavingsPlansCommand";
5
5
  export * from "./DescribeSavingsPlansOfferingRatesCommand";
6
6
  export * from "./DescribeSavingsPlansOfferingsCommand";
7
7
  export * from "./ListTagsForResourceCommand";
8
+ export * from "./ReturnSavingsPlanCommand";
8
9
  export * from "./TagResourceCommand";
9
10
  export * from "./UntagResourceCommand";