@aws-sdk/client-rbin 3.936.0 → 3.937.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 (16) hide show
  1. package/README.md +2 -2
  2. package/dist-cjs/index.js +1 -0
  3. package/dist-es/models/enums.js +1 -0
  4. package/dist-types/Rbin.d.ts +2 -2
  5. package/dist-types/RbinClient.d.ts +2 -2
  6. package/dist-types/commands/CreateRuleCommand.d.ts +2 -2
  7. package/dist-types/commands/GetRuleCommand.d.ts +1 -1
  8. package/dist-types/commands/ListRulesCommand.d.ts +1 -1
  9. package/dist-types/commands/LockRuleCommand.d.ts +1 -1
  10. package/dist-types/commands/UnlockRuleCommand.d.ts +1 -1
  11. package/dist-types/commands/UpdateRuleCommand.d.ts +2 -2
  12. package/dist-types/index.d.ts +2 -2
  13. package/dist-types/models/enums.d.ts +1 -0
  14. package/dist-types/models/models_0.d.ts +55 -19
  15. package/dist-types/ts3.4/models/enums.d.ts +1 -0
  16. package/package.json +1 -1
package/README.md CHANGED
@@ -8,8 +8,8 @@ AWS SDK for JavaScript Rbin Client for Node.js, Browser and React Native.
8
8
 
9
9
  <p>This is the <i>Recycle Bin API Reference</i>. This documentation provides
10
10
  descriptions and syntax for each of the actions and data types in Recycle Bin.</p>
11
- <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally
12
- deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
11
+ <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted
12
+ EBS volumes, EBS snapshots, and EBS-backed AMIs. When using Recycle Bin, if your resources are
13
13
  deleted, they are retained in the Recycle Bin for a time period that you specify.</p>
14
14
  <p>You can restore a resource from the Recycle Bin at any time before its retention period
15
15
  expires. After you restore a resource from the Recycle Bin, the resource is removed from the
package/dist-cjs/index.js CHANGED
@@ -699,6 +699,7 @@ const UnlockDelayUnit = {
699
699
  };
700
700
  const ResourceType = {
701
701
  EBS_SNAPSHOT: "EBS_SNAPSHOT",
702
+ EBS_VOLUME: "EBS_VOLUME",
702
703
  EC2_IMAGE: "EC2_IMAGE",
703
704
  };
704
705
  const RetentionPeriodUnit = {
package/dist-es/models/enums.js CHANGED
@@ -3,6 +3,7 @@ export const UnlockDelayUnit = {
3
3
  };
4
4
  export const ResourceType = {
5
5
  EBS_SNAPSHOT: "EBS_SNAPSHOT",
6
+ EBS_VOLUME: "EBS_VOLUME",
6
7
  EC2_IMAGE: "EC2_IMAGE",
7
8
  };
8
9
  export const RetentionPeriodUnit = {
package/dist-types/Rbin.d.ts CHANGED
@@ -75,8 +75,8 @@ export interface Rbin {
75
75
  /**
76
76
  * <p>This is the <i>Recycle Bin API Reference</i>. This documentation provides
77
77
  * descriptions and syntax for each of the actions and data types in Recycle Bin.</p>
78
- * <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally
79
- * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
78
+ * <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted
79
+ * EBS volumes, EBS snapshots, and EBS-backed AMIs. When using Recycle Bin, if your resources are
80
80
  * deleted, they are retained in the Recycle Bin for a time period that you specify.</p>
81
81
  * <p>You can restore a resource from the Recycle Bin at any time before its retention period
82
82
  * expires. After you restore a resource from the Recycle Bin, the resource is removed from the
package/dist-types/RbinClient.d.ts CHANGED
@@ -190,8 +190,8 @@ export interface RbinClientResolvedConfig extends RbinClientResolvedConfigType {
190
190
  /**
191
191
  * <p>This is the <i>Recycle Bin API Reference</i>. This documentation provides
192
192
  * descriptions and syntax for each of the actions and data types in Recycle Bin.</p>
193
- * <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally
194
- * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
193
+ * <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted
194
+ * EBS volumes, EBS snapshots, and EBS-backed AMIs. When using Recycle Bin, if your resources are
195
195
  * deleted, they are retained in the Recycle Bin for a time period that you specify.</p>
196
196
  * <p>You can restore a resource from the Recycle Bin at any time before its retention period
197
197
  * expires. After you restore a resource from the Recycle Bin, the resource is removed from the
package/dist-types/commands/CreateRuleCommand.d.ts CHANGED
@@ -68,7 +68,7 @@ declare const CreateRuleCommand_base: {
68
68
  * Value: "STRING_VALUE", // required
69
69
  * },
70
70
  * ],
71
- * ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE", // required
71
+ * ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE" || "EBS_VOLUME", // required
72
72
  * ResourceTags: [ // ResourceTags
73
73
  * { // ResourceTag
74
74
  * ResourceTagKey: "STRING_VALUE", // required
@@ -103,7 +103,7 @@ declare const CreateRuleCommand_base: {
103
103
  * // Value: "STRING_VALUE", // required
104
104
  * // },
105
105
  * // ],
106
- * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE",
106
+ * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE" || "EBS_VOLUME",
107
107
  * // ResourceTags: [ // ResourceTags
108
108
  * // { // ResourceTag
109
109
  * // ResourceTagKey: "STRING_VALUE", // required
package/dist-types/commands/GetRuleCommand.d.ts CHANGED
@@ -44,7 +44,7 @@ declare const GetRuleCommand_base: {
44
44
  * // { // GetRuleResponse
45
45
  * // Identifier: "STRING_VALUE",
46
46
  * // Description: "STRING_VALUE",
47
- * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE",
47
+ * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE" || "EBS_VOLUME",
48
48
  * // RetentionPeriod: { // RetentionPeriod
49
49
  * // RetentionPeriodValue: Number("int"), // required
50
50
  * // RetentionPeriodUnit: "DAYS", // required
package/dist-types/commands/ListRulesCommand.d.ts CHANGED
@@ -39,7 +39,7 @@ declare const ListRulesCommand_base: {
39
39
  * const input = { // ListRulesRequest
40
40
  * MaxResults: Number("int"),
41
41
  * NextToken: "STRING_VALUE",
42
- * ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE", // required
42
+ * ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE" || "EBS_VOLUME", // required
43
43
  * ResourceTags: [ // ResourceTags
44
44
  * { // ResourceTag
45
45
  * ResourceTagKey: "STRING_VALUE", // required
package/dist-types/commands/LockRuleCommand.d.ts CHANGED
@@ -55,7 +55,7 @@ declare const LockRuleCommand_base: {
55
55
  * // { // LockRuleResponse
56
56
  * // Identifier: "STRING_VALUE",
57
57
  * // Description: "STRING_VALUE",
58
- * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE",
58
+ * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE" || "EBS_VOLUME",
59
59
  * // RetentionPeriod: { // RetentionPeriod
60
60
  * // RetentionPeriodValue: Number("int"), // required
61
61
  * // RetentionPeriodUnit: "DAYS", // required
package/dist-types/commands/UnlockRuleCommand.d.ts CHANGED
@@ -45,7 +45,7 @@ declare const UnlockRuleCommand_base: {
45
45
  * // { // UnlockRuleResponse
46
46
  * // Identifier: "STRING_VALUE",
47
47
  * // Description: "STRING_VALUE",
48
- * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE",
48
+ * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE" || "EBS_VOLUME",
49
49
  * // RetentionPeriod: { // RetentionPeriod
50
50
  * // RetentionPeriodValue: Number("int"), // required
51
51
  * // RetentionPeriodUnit: "DAYS", // required
package/dist-types/commands/UpdateRuleCommand.d.ts CHANGED
@@ -46,7 +46,7 @@ declare const UpdateRuleCommand_base: {
46
46
  * RetentionPeriodUnit: "DAYS", // required
47
47
  * },
48
48
  * Description: "STRING_VALUE",
49
- * ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE",
49
+ * ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE" || "EBS_VOLUME",
50
50
  * ResourceTags: [ // ResourceTags
51
51
  * { // ResourceTag
52
52
  * ResourceTagKey: "STRING_VALUE", // required
@@ -69,7 +69,7 @@ declare const UpdateRuleCommand_base: {
69
69
  * // RetentionPeriodUnit: "DAYS", // required
70
70
  * // },
71
71
  * // Description: "STRING_VALUE",
72
- * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE",
72
+ * // ResourceType: "EBS_SNAPSHOT" || "EC2_IMAGE" || "EBS_VOLUME",
73
73
  * // ResourceTags: [ // ResourceTags
74
74
  * // { // ResourceTag
75
75
  * // ResourceTagKey: "STRING_VALUE", // required
package/dist-types/index.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * <p>This is the <i>Recycle Bin API Reference</i>. This documentation provides
3
3
  * descriptions and syntax for each of the actions and data types in Recycle Bin.</p>
4
- * <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally
5
- * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
4
+ * <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted
5
+ * EBS volumes, EBS snapshots, and EBS-backed AMIs. When using Recycle Bin, if your resources are
6
6
  * deleted, they are retained in the Recycle Bin for a time period that you specify.</p>
7
7
  * <p>You can restore a resource from the Recycle Bin at any time before its retention period
8
8
  * expires. After you restore a resource from the Recycle Bin, the resource is removed from the
package/dist-types/models/enums.d.ts CHANGED
@@ -15,6 +15,7 @@ export type UnlockDelayUnit = (typeof UnlockDelayUnit)[keyof typeof UnlockDelayU
15
15
  */
16
16
  export declare const ResourceType: {
17
17
  readonly EBS_SNAPSHOT: "EBS_SNAPSHOT";
18
+ readonly EBS_VOLUME: "EBS_VOLUME";
18
19
  readonly EC2_IMAGE: "EC2_IMAGE";
19
20
  };
20
21
  /**
package/dist-types/models/models_0.d.ts CHANGED
@@ -31,7 +31,7 @@ export interface UnlockDelay {
31
31
  UnlockDelayValue: number | undefined;
32
32
  /**
33
33
  * <p>The unit of time in which to measure the unlock delay. Currently, the unlock delay can
34
- * be measure only in days.</p>
34
+ * be measured only in days.</p>
35
35
  * @public
36
36
  */
37
37
  UnlockDelayUnit: UnlockDelayUnit | undefined;
@@ -48,13 +48,22 @@ export interface LockConfiguration {
48
48
  UnlockDelay: UnlockDelay | undefined;
49
49
  }
50
50
  /**
51
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
51
+ * <p>Information about the retention period for which the retention rule is to
52
+ * retain resources.</p>
52
53
  * @public
53
54
  */
54
55
  export interface RetentionPeriod {
55
56
  /**
56
- * <p>The period value for which the retention rule is to retain resources. The period is measured using
57
- * the unit specified for <b>RetentionPeriodUnit</b>.</p>
57
+ * <p>The period value for which the retention rule is to retain resources, measured in days.
58
+ * The supported retention periods are:</p>
59
+ * <ul>
60
+ * <li>
61
+ * <p>EBS volumes: 1 - 7 days</p>
62
+ * </li>
63
+ * <li>
64
+ * <p>EBS snapshots and EBS-backed AMIs: 1 - 365 days</p>
65
+ * </li>
66
+ * </ul>
58
67
  * @public
59
68
  */
60
69
  RetentionPeriodValue: number | undefined;
@@ -86,7 +95,8 @@ export interface Tag {
86
95
  */
87
96
  export interface CreateRuleRequest {
88
97
  /**
89
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
98
+ * <p>Information about the retention period for which the retention rule is to
99
+ * retain resources.</p>
90
100
  * @public
91
101
  */
92
102
  RetentionPeriod: RetentionPeriod | undefined;
@@ -101,9 +111,20 @@ export interface CreateRuleRequest {
101
111
  */
102
112
  Tags?: Tag[] | undefined;
103
113
  /**
104
- * <p>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots
105
- * and EBS-backed AMIs are supported. To retain snapshots, specify <code>EBS_SNAPSHOT</code>. To
106
- * retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p>
114
+ * <p>The resource type to be retained by the retention rule. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs
115
+ * are supported.</p>
116
+ * <ul>
117
+ * <li>
118
+ * <p>To retain EBS volumes, specify <code>EBS_VOLUME</code>.</p>
119
+ * </li>
120
+ * <li>
121
+ * <p>To retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>
122
+ * </p>
123
+ * </li>
124
+ * <li>
125
+ * <p>To retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p>
126
+ * </li>
127
+ * </ul>
107
128
  * @public
108
129
  */
109
130
  ResourceType: ResourceType | undefined;
@@ -143,7 +164,8 @@ export interface CreateRuleResponse {
143
164
  */
144
165
  Identifier?: string | undefined;
145
166
  /**
146
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
167
+ * <p>Information about the retention period for which the retention rule is to
168
+ * retain resources.</p>
147
169
  * @public
148
170
  */
149
171
  RetentionPeriod?: RetentionPeriod | undefined;
@@ -264,7 +286,8 @@ export interface GetRuleResponse {
264
286
  */
265
287
  ResourceType?: ResourceType | undefined;
266
288
  /**
267
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
289
+ * <p>Information about the retention period for which the retention rule is to
290
+ * retain resources.</p>
268
291
  * @public
269
292
  */
270
293
  RetentionPeriod?: RetentionPeriod | undefined;
@@ -349,10 +372,18 @@ export interface ListRulesRequest {
349
372
  NextToken?: string | undefined;
350
373
  /**
351
374
  * <p>The resource type retained by the retention rule. Only retention rules that retain
352
- * the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed
353
- * AMIs are supported. To list retention rules that retain snapshots, specify
354
- * <code>EBS_SNAPSHOT</code>. To list retention rules that retain EBS-backed AMIs, specify
355
- * <code>EC2_IMAGE</code>.</p>
375
+ * the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.</p>
376
+ * <ul>
377
+ * <li>
378
+ * <p>To list retention rules that retain EBS volumes, specify <code>EBS_VOLUME</code>.</p>
379
+ * </li>
380
+ * <li>
381
+ * <p>To list retention rules that retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>.</p>
382
+ * </li>
383
+ * <li>
384
+ * <p>To list retention rules that retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p>
385
+ * </li>
386
+ * </ul>
356
387
  * @public
357
388
  */
358
389
  ResourceType: ResourceType | undefined;
@@ -391,7 +422,8 @@ export interface RuleSummary {
391
422
  */
392
423
  Description?: string | undefined;
393
424
  /**
394
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
425
+ * <p>Information about the retention period for which the retention rule is to
426
+ * retain resources.</p>
395
427
  * @public
396
428
  */
397
429
  RetentionPeriod?: RetentionPeriod | undefined;
@@ -499,7 +531,8 @@ export interface LockRuleResponse {
499
531
  */
500
532
  ResourceType?: ResourceType | undefined;
501
533
  /**
502
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
534
+ * <p>Information about the retention period for which the retention rule is to
535
+ * retain resources.</p>
503
536
  * @public
504
537
  */
505
538
  RetentionPeriod?: RetentionPeriod | undefined;
@@ -610,7 +643,8 @@ export interface UnlockRuleResponse {
610
643
  */
611
644
  ResourceType?: ResourceType | undefined;
612
645
  /**
613
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
646
+ * <p>Information about the retention period for which the retention rule is to
647
+ * retain resources.</p>
614
648
  * @public
615
649
  */
616
650
  RetentionPeriod?: RetentionPeriod | undefined;
@@ -708,7 +742,8 @@ export interface UpdateRuleRequest {
708
742
  */
709
743
  Identifier: string | undefined;
710
744
  /**
711
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
745
+ * <p>Information about the retention period for which the retention rule is to
746
+ * retain resources.</p>
712
747
  * @public
713
748
  */
714
749
  RetentionPeriod?: RetentionPeriod | undefined;
@@ -756,7 +791,8 @@ export interface UpdateRuleResponse {
756
791
  */
757
792
  Identifier?: string | undefined;
758
793
  /**
759
- * <p>Information about the retention period for which the retention rule is to retain resources.</p>
794
+ * <p>Information about the retention period for which the retention rule is to
795
+ * retain resources.</p>
760
796
  * @public
761
797
  */
762
798
  RetentionPeriod?: RetentionPeriod | undefined;
package/dist-types/ts3.4/models/enums.d.ts CHANGED
@@ -5,6 +5,7 @@ export type UnlockDelayUnit =
5
5
  (typeof UnlockDelayUnit)[keyof typeof UnlockDelayUnit];
6
6
  export declare const ResourceType: {
7
7
  readonly EBS_SNAPSHOT: "EBS_SNAPSHOT";
8
+ readonly EBS_VOLUME: "EBS_VOLUME";
8
9
  readonly EC2_IMAGE: "EC2_IMAGE";
9
10
  };
10
11
  export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rbin",
3
3
  "description": "AWS SDK for JavaScript Rbin Client for Node.js, Browser and React Native",
4
- "version": "3.936.0",
4
+ "version": "3.937.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-rbin",