@aws-sdk/client-rbin 3.48.0 → 3.52.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.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,41 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.52.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.51.0...v3.52.0) (2022-02-18)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-rbin
9
+
10
+
11
+
12
+
13
+
14
+ # [3.51.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.50.0...v3.51.0) (2022-02-12)
15
+
16
+ **Note:** Version bump only for package @aws-sdk/client-rbin
17
+
18
+
19
+
20
+
21
+
22
+ # [3.50.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.49.0...v3.50.0) (2022-02-08)
23
+
24
+
25
+ ### Features
26
+
27
+ * **clients:** update clients as of 02/04/2022 ([#3280](https://github.com/aws/aws-sdk-js-v3/issues/3280)) ([63d7f8c](https://github.com/aws/aws-sdk-js-v3/commit/63d7f8c539e0fd782fa5bf997bd6ac2730e4bfda))
28
+
29
+
30
+
31
+
32
+
33
+ # [3.49.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.48.0...v3.49.0) (2022-01-29)
34
+
35
+ **Note:** Version bump only for package @aws-sdk/client-rbin
36
+
37
+
38
+
39
+
40
+
6
41
  # [3.48.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.47.2...v3.48.0) (2022-01-22)
7
42
 
8
43
  **Note:** Version bump only for package @aws-sdk/client-rbin
package/README.md CHANGED
@@ -10,17 +10,17 @@ AWS SDK for JavaScript Rbin Client for Node.js, Browser and React Native.
10
10
  <p>This is the <i>Recycle Bin API Reference</i>. This documentation provides
11
11
  descriptions and syntax for each of the actions and data types in Recycle Bin.</p>
12
12
 
13
- <p>Recycle Bin is a snapshot recovery feature that enables you to restore accidentally
14
- deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained
15
- in the Recycle Bin for a time period that you specify.</p>
16
-
17
- <p>You can restore a snapshot from the Recycle Bin at any time before its retention period
18
- expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the
19
- Recycle Bin, and you can then use it in the same way you use any other snapshot in your
20
- account. If the retention period expires and the snapshot is not restored, the snapshot is
21
- permanently deleted from the Recycle Bin and is no longer available for recovery. For more
13
+ <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally
14
+ deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
15
+ deleted, they are retained in the Recycle Bin for a time period that you specify.</p>
16
+
17
+ <p>You can restore a resource from the Recycle Bin at any time before its retention period
18
+ expires. After you restore a resource from the Recycle Bin, the resource is removed from the
19
+ Recycle Bin, and you can then use it in the same way you use any other resource of that type
20
+ in your account. If the retention period expires and the resource is not restored, the resource
21
+ is permanently deleted from the Recycle Bin and is no longer available for recovery. For more
22
22
  information about Recycle Bin, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-recycle-bin.html">
23
- Recycle Bin</a> in the <i>Amazon EC2 User Guide</i>.</p>
23
+ Recycle Bin</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
24
24
 
25
25
  ## Installing
26
26
 
@@ -10,6 +10,7 @@ var ResourceTag;
10
10
  var ResourceType;
11
11
  (function (ResourceType) {
12
12
  ResourceType["EBS_SNAPSHOT"] = "EBS_SNAPSHOT";
13
+ ResourceType["EC2_IMAGE"] = "EC2_IMAGE";
13
14
  })(ResourceType = exports.ResourceType || (exports.ResourceType = {}));
14
15
  var RetentionPeriodUnit;
15
16
  (function (RetentionPeriodUnit) {
@@ -6,6 +6,7 @@ export var ResourceTag;
6
6
  export var ResourceType;
7
7
  (function (ResourceType) {
8
8
  ResourceType["EBS_SNAPSHOT"] = "EBS_SNAPSHOT";
9
+ ResourceType["EC2_IMAGE"] = "EC2_IMAGE";
9
10
  })(ResourceType || (ResourceType = {}));
10
11
  export var RetentionPeriodUnit;
11
12
  (function (RetentionPeriodUnit) {
@@ -12,29 +12,29 @@ import { RbinClient } from "./RbinClient";
12
12
  * <p>This is the <i>Recycle Bin API Reference</i>. This documentation provides
13
13
  * descriptions and syntax for each of the actions and data types in Recycle Bin.</p>
14
14
  *
15
- * <p>Recycle Bin is a snapshot recovery feature that enables you to restore accidentally
16
- * deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained
17
- * in the Recycle Bin for a time period that you specify.</p>
15
+ * <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally
16
+ * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
17
+ * deleted, they are retained in the Recycle Bin for a time period that you specify.</p>
18
18
  *
19
- * <p>You can restore a snapshot from the Recycle Bin at any time before its retention period
20
- * expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the
21
- * Recycle Bin, and you can then use it in the same way you use any other snapshot in your
22
- * account. If the retention period expires and the snapshot is not restored, the snapshot is
23
- * permanently deleted from the Recycle Bin and is no longer available for recovery. For more
19
+ * <p>You can restore a resource from the Recycle Bin at any time before its retention period
20
+ * expires. After you restore a resource from the Recycle Bin, the resource is removed from the
21
+ * Recycle Bin, and you can then use it in the same way you use any other resource of that type
22
+ * in your account. If the retention period expires and the resource is not restored, the resource
23
+ * is permanently deleted from the Recycle Bin and is no longer available for recovery. For more
24
24
  * information about Recycle Bin, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-recycle-bin.html">
25
- * Recycle Bin</a> in the <i>Amazon EC2 User Guide</i>.</p>
25
+ * Recycle Bin</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
26
26
  */
27
27
  export declare class Rbin extends RbinClient {
28
28
  /**
29
29
  * <p>Creates a Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-create-rule">
30
- * Create Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>.</p>
30
+ * Create Recycle Bin retention rules</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
31
31
  */
32
32
  createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise<CreateRuleCommandOutput>;
33
33
  createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void;
34
34
  createRule(args: CreateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleCommandOutput) => void): void;
35
35
  /**
36
36
  * <p>Deletes a Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule">
37
- * Delete Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>.</p>
37
+ * Delete Recycle Bin retention rules</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
38
38
  */
39
39
  deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRuleCommandOutput>;
40
40
  deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void;
@@ -52,26 +52,26 @@ export declare class Rbin extends RbinClient {
52
52
  listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void;
53
53
  listRules(args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void): void;
54
54
  /**
55
- * <p>Lists the tags assigned a specific resource.</p>
55
+ * <p>Lists the tags assigned to a retention rule.</p>
56
56
  */
57
57
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
58
58
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
59
59
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
60
60
  /**
61
- * <p>Assigns tags to the specified resource.</p>
61
+ * <p>Assigns tags to the specified retention rule.</p>
62
62
  */
63
63
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
64
64
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
65
65
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
66
66
  /**
67
- * <p>Unassigns a tag from a resource.</p>
67
+ * <p>Unassigns a tag from a retention rule.</p>
68
68
  */
69
69
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
70
70
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
71
71
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
72
72
  /**
73
73
  * <p>Updates an existing Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule">
74
- * Update Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>.</p>
74
+ * Update Recycle Bin retention rules</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
75
75
  */
76
76
  updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRuleCommandOutput>;
77
77
  updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void;
@@ -137,17 +137,17 @@ export interface RbinClientResolvedConfig extends RbinClientResolvedConfigType {
137
137
  * <p>This is the <i>Recycle Bin API Reference</i>. This documentation provides
138
138
  * descriptions and syntax for each of the actions and data types in Recycle Bin.</p>
139
139
  *
140
- * <p>Recycle Bin is a snapshot recovery feature that enables you to restore accidentally
141
- * deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained
142
- * in the Recycle Bin for a time period that you specify.</p>
140
+ * <p>Recycle Bin is a resource recovery feature that enables you to restore accidentally
141
+ * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
142
+ * deleted, they are retained in the Recycle Bin for a time period that you specify.</p>
143
143
  *
144
- * <p>You can restore a snapshot from the Recycle Bin at any time before its retention period
145
- * expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the
146
- * Recycle Bin, and you can then use it in the same way you use any other snapshot in your
147
- * account. If the retention period expires and the snapshot is not restored, the snapshot is
148
- * permanently deleted from the Recycle Bin and is no longer available for recovery. For more
144
+ * <p>You can restore a resource from the Recycle Bin at any time before its retention period
145
+ * expires. After you restore a resource from the Recycle Bin, the resource is removed from the
146
+ * Recycle Bin, and you can then use it in the same way you use any other resource of that type
147
+ * in your account. If the retention period expires and the resource is not restored, the resource
148
+ * is permanently deleted from the Recycle Bin and is no longer available for recovery. For more
149
149
  * information about Recycle Bin, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-recycle-bin.html">
150
- * Recycle Bin</a> in the <i>Amazon EC2 User Guide</i>.</p>
150
+ * Recycle Bin</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
151
151
  */
152
152
  export declare class RbinClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RbinClientResolvedConfig> {
153
153
  /**
@@ -8,7 +8,7 @@ export interface CreateRuleCommandOutput extends CreateRuleResponse, __MetadataB
8
8
  }
9
9
  /**
10
10
  * <p>Creates a Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-create-rule">
11
- * Create Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>.</p>
11
+ * Create Recycle Bin retention rules</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -8,7 +8,7 @@ export interface DeleteRuleCommandOutput extends DeleteRuleResponse, __MetadataB
8
8
  }
9
9
  /**
10
10
  * <p>Deletes a Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule">
11
- * Delete Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>.</p>
11
+ * Delete Recycle Bin retention rules</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -7,7 +7,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
7
7
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the tags assigned a specific resource.</p>
10
+ * <p>Lists the tags assigned to a retention rule.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,7 +7,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {
7
7
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Assigns tags to the specified resource.</p>
10
+ * <p>Assigns tags to the specified retention rule.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,7 +7,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
7
7
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Unassigns a tag from a resource.</p>
10
+ * <p>Unassigns a tag from a retention rule.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -8,7 +8,7 @@ export interface UpdateRuleCommandOutput extends UpdateRuleResponse, __MetadataB
8
8
  }
9
9
  /**
10
10
  * <p>Updates an existing Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule">
11
- * Update Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>.</p>
11
+ * Update Recycle Bin retention rules</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -1,6 +1,7 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
2
  /**
3
- * <p>Information about a resource tag used to identify resources that are to be retained by a Recycle Bin retention rule.</p>
3
+ * <p>Information about the resource tags used to identify resources that are retained by the retention
4
+ * rule.</p>
4
5
  */
5
6
  export interface ResourceTag {
6
7
  /**
@@ -19,13 +20,14 @@ export declare namespace ResourceTag {
19
20
  const filterSensitiveLog: (obj: ResourceTag) => any;
20
21
  }
21
22
  export declare enum ResourceType {
22
- EBS_SNAPSHOT = "EBS_SNAPSHOT"
23
+ EBS_SNAPSHOT = "EBS_SNAPSHOT",
24
+ EC2_IMAGE = "EC2_IMAGE"
23
25
  }
24
26
  export declare enum RetentionPeriodUnit {
25
27
  DAYS = "DAYS"
26
28
  }
27
29
  /**
28
- * <p>Information about the retention period for which a retention rule is to retain resources.</p>
30
+ * <p>Information about the retention period for which the retention rule is to retain resources.</p>
29
31
  */
30
32
  export interface RetentionPeriod {
31
33
  /**
@@ -46,7 +48,7 @@ export declare namespace RetentionPeriod {
46
48
  const filterSensitiveLog: (obj: RetentionPeriod) => any;
47
49
  }
48
50
  /**
49
- * <p>Information about the tags assigned to a Recycle Bin retention rule.</p>
51
+ * <p>Information about the tags to assign to the retention rule.</p>
50
52
  */
51
53
  export interface Tag {
52
54
  /**
@@ -70,7 +72,7 @@ export interface CreateRuleRequest {
70
72
  */
71
73
  RetentionPeriod: RetentionPeriod | undefined;
72
74
  /**
73
- * <p>A brief description for the retention rule.</p>
75
+ * <p>The retention rule description.</p>
74
76
  */
75
77
  Description?: string;
76
78
  /**
@@ -78,17 +80,20 @@ export interface CreateRuleRequest {
78
80
  */
79
81
  Tags?: Tag[];
80
82
  /**
81
- * <p>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are
82
- * supported.</p>
83
+ * <p>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots
84
+ * and EBS-backed AMIs are supported. To retain snapshots, specify <code>EBS_SNAPSHOT</code>. To
85
+ * retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p>
83
86
  */
84
87
  ResourceType: ResourceType | string | undefined;
85
88
  /**
86
- * <p>Information about the resource tags to use to identify resources that are to be retained
87
- * by the retention rule. The retention rule retains only deleted snapshots that have one or more
88
- * of the specified tag key and value pairs. If a snapshot is deleted, but it does not have
89
- * any of the specified tag key and value pairs, it is immediately deleted without being retained
90
- * by the retention rule.</p>
89
+ * <p>Specifies the resource tags to use to identify resources that are to be retained by a
90
+ * tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that
91
+ * have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have
92
+ * any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.</p>
91
93
  * <p>You can add the same tag key and value pair to a maximum or five retention rules.</p>
94
+ * <p>To create a Region-level retention rule, omit this parameter. A Region-level retention rule
95
+ * does not have any resource tags specified. It retains all deleted resources of the specified
96
+ * resource type in the Region in which the rule is created, even if the resources are not tagged.</p>
92
97
  */
93
98
  ResourceTags?: ResourceTag[];
94
99
  }
@@ -104,11 +109,11 @@ export declare enum RuleStatus {
104
109
  }
105
110
  export interface CreateRuleResponse {
106
111
  /**
107
- * <p>The unique identifier of the retention rule.</p>
112
+ * <p>The unique ID of the retention rule.</p>
108
113
  */
109
114
  Identifier?: string;
110
115
  /**
111
- * <p>Information about the retention period for which a retention rule is to retain resources.</p>
116
+ * <p>Information about the retention period for which the retention rule is to retain resources.</p>
112
117
  */
113
118
  RetentionPeriod?: RetentionPeriod;
114
119
  /**
@@ -116,7 +121,7 @@ export interface CreateRuleResponse {
116
121
  */
117
122
  Description?: string;
118
123
  /**
119
- * <p>The tags assigned to the retention rule.</p>
124
+ * <p>Information about the tags assigned to the retention rule.</p>
120
125
  */
121
126
  Tags?: Tag[];
122
127
  /**
@@ -129,7 +134,8 @@ export interface CreateRuleResponse {
129
134
  */
130
135
  ResourceTags?: ResourceTag[];
131
136
  /**
132
- * <p>The state of the retention rule. Only retention rules that are in the <code>available</code> state retain snapshots.</p>
137
+ * <p>The state of the retention rule. Only retention rules that are in the <code>available</code>
138
+ * state retain resources.</p>
133
139
  */
134
140
  Status?: RuleStatus | string;
135
141
  }
@@ -180,7 +186,7 @@ export interface ValidationException extends __SmithyException, $MetadataBearer
180
186
  }
181
187
  export interface DeleteRuleRequest {
182
188
  /**
183
- * <p>The unique ID of the retention rule to delete.</p>
189
+ * <p>The unique ID of the retention rule.</p>
184
190
  */
185
191
  Identifier: string | undefined;
186
192
  }
@@ -231,23 +237,25 @@ export interface GetRuleResponse {
231
237
  */
232
238
  Identifier?: string;
233
239
  /**
234
- * <p>The description assigned to the retention rule.</p>
240
+ * <p>The retention rule description.</p>
235
241
  */
236
242
  Description?: string;
237
243
  /**
238
- * <p>The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.</p>
244
+ * <p>The resource type retained by the retention rule.</p>
239
245
  */
240
246
  ResourceType?: ResourceType | string;
241
247
  /**
242
- * <p>Information about the period for which the retention rule retains resources.</p>
248
+ * <p>Information about the retention period for which the retention rule is to retain resources.</p>
243
249
  */
244
250
  RetentionPeriod?: RetentionPeriod;
245
251
  /**
246
- * <p>The resource tags used to identify resources that are to be retained by the retention rule.</p>
252
+ * <p>Information about the resource tags used to identify resources that are retained by the retention
253
+ * rule.</p>
247
254
  */
248
255
  ResourceTags?: ResourceTag[];
249
256
  /**
250
- * <p>The state of the retention rule. Only retention rules that are in the <code>available</code> state retain snapshots.</p>
257
+ * <p>The state of the retention rule. Only retention rules that are in the <code>available</code>
258
+ * state retain resources.</p>
251
259
  */
252
260
  Status?: RuleStatus | string;
253
261
  }
@@ -259,20 +267,25 @@ export declare namespace GetRuleResponse {
259
267
  }
260
268
  export interface ListRulesRequest {
261
269
  /**
262
- * <p>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>nextToken</code> value. This value can be between 5 and 500. If <code>maxResults</code> is given a larger value than 500, you receive an error.</p>
270
+ * <p>The maximum number of results to return with a single call.
271
+ * To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
263
272
  */
264
273
  MaxResults?: number;
265
274
  /**
266
- * <p>The token to use to retrieve the next page of results.</p>
275
+ * <p>The token for the next page of results.</p>
267
276
  */
268
277
  NextToken?: string;
269
278
  /**
270
- * <p>The resource type retained by the retention rule. Only retention rules that retain the specified resource type
271
- * are listed.</p>
279
+ * <p>The resource type retained by the retention rule. Only retention rules that retain
280
+ * the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed
281
+ * AMIs are supported. To list retention rules that retain snapshots, specify
282
+ * <code>EBS_SNAPSHOT</code>. To list retention rules that retain EBS-backed AMIs, specify
283
+ * <code>EC2_IMAGE</code>.</p>
272
284
  */
273
285
  ResourceType: ResourceType | string | undefined;
274
286
  /**
275
- * <p>The tags used to identify resources that are to be retained by the retention rule.</p>
287
+ * <p>Information about the resource tags used to identify resources that are retained by the retention
288
+ * rule.</p>
276
289
  */
277
290
  ResourceTags?: ResourceTag[];
278
291
  }
@@ -291,11 +304,11 @@ export interface RuleSummary {
291
304
  */
292
305
  Identifier?: string;
293
306
  /**
294
- * <p>The description for the retention rule.</p>
307
+ * <p>The retention rule description.</p>
295
308
  */
296
309
  Description?: string;
297
310
  /**
298
- * <p>Information about the retention period for which the retention rule retains resources</p>
311
+ * <p>Information about the retention period for which the retention rule is to retain resources.</p>
299
312
  */
300
313
  RetentionPeriod?: RetentionPeriod;
301
314
  }
@@ -323,7 +336,7 @@ export declare namespace ListRulesResponse {
323
336
  }
324
337
  export interface ListTagsForResourceRequest {
325
338
  /**
326
- * <p>The Amazon Resource Name (ARN) of the resource for which to list the tags.</p>
339
+ * <p>The Amazon Resource Name (ARN) of the retention rule.</p>
327
340
  */
328
341
  ResourceArn: string | undefined;
329
342
  }
@@ -335,7 +348,7 @@ export declare namespace ListTagsForResourceRequest {
335
348
  }
336
349
  export interface ListTagsForResourceResponse {
337
350
  /**
338
- * <p>Information about the tags assigned to the resource.</p>
351
+ * <p>Information about the tags assigned to the retention rule.</p>
339
352
  */
340
353
  Tags?: Tag[];
341
354
  }
@@ -347,11 +360,11 @@ export declare namespace ListTagsForResourceResponse {
347
360
  }
348
361
  export interface TagResourceRequest {
349
362
  /**
350
- * <p>The Amazon Resource Name (ARN) of the resource to which to assign the tags.</p>
363
+ * <p>The Amazon Resource Name (ARN) of the retention rule.</p>
351
364
  */
352
365
  ResourceArn: string | undefined;
353
366
  /**
354
- * <p>Information about the tags to assign to the resource.</p>
367
+ * <p>Information about the tags to assign to the retention rule.</p>
355
368
  */
356
369
  Tags: Tag[] | undefined;
357
370
  }
@@ -371,11 +384,11 @@ export declare namespace TagResourceResponse {
371
384
  }
372
385
  export interface UntagResourceRequest {
373
386
  /**
374
- * <p>The Amazon Resource Name (ARN) of the resource from which to unassign the tags.</p>
387
+ * <p>The Amazon Resource Name (ARN) of the retention rule.</p>
375
388
  */
376
389
  ResourceArn: string | undefined;
377
390
  /**
378
- * <p>Information about the tags to unassign from the resource.</p>
391
+ * <p>The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.</p>
379
392
  */
380
393
  TagKeys: string[] | undefined;
381
394
  }
@@ -395,7 +408,7 @@ export declare namespace UntagResourceResponse {
395
408
  }
396
409
  export interface UpdateRuleRequest {
397
410
  /**
398
- * <p>The unique ID of the retention rule to update.</p>
411
+ * <p>The unique ID of the retention rule.</p>
399
412
  */
400
413
  Identifier: string | undefined;
401
414
  /**
@@ -407,16 +420,20 @@ export interface UpdateRuleRequest {
407
420
  */
408
421
  Description?: string;
409
422
  /**
410
- * <p>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are supported.</p>
423
+ * <p>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots
424
+ * and EBS-backed AMIs are supported. To retain snapshots, specify <code>EBS_SNAPSHOT</code>. To
425
+ * retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p>
411
426
  */
412
427
  ResourceType?: ResourceType | string;
413
428
  /**
414
- * <p>Information about the resource tags to use to identify resources that are to be retained
415
- * by the retention rule. The retention rule retains only deleted snapshots that have one or more
416
- * of the specified tag key and value pairs. If a snapshot is deleted, but it does not have
417
- * any of the specified tag key and value pairs, it is immediately deleted without being retained
418
- * by the retention rule. </p>
429
+ * <p>Specifies the resource tags to use to identify resources that are to be retained by a
430
+ * tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that
431
+ * have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have
432
+ * any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.</p>
419
433
  * <p>You can add the same tag key and value pair to a maximum or five retention rules.</p>
434
+ * <p>To create a Region-level retention rule, omit this parameter. A Region-level retention rule
435
+ * does not have any resource tags specified. It retains all deleted resources of the specified
436
+ * resource type in the Region in which the rule is created, even if the resources are not tagged.</p>
420
437
  */
421
438
  ResourceTags?: ResourceTag[];
422
439
  }
@@ -432,7 +449,7 @@ export interface UpdateRuleResponse {
432
449
  */
433
450
  Identifier?: string;
434
451
  /**
435
- * <p>Information about the retention period for which a retention rule is to retain resources.</p>
452
+ * <p>Information about the retention period for which the retention rule is to retain resources.</p>
436
453
  */
437
454
  RetentionPeriod?: RetentionPeriod;
438
455
  /**
@@ -449,7 +466,8 @@ export interface UpdateRuleResponse {
449
466
  */
450
467
  ResourceTags?: ResourceTag[];
451
468
  /**
452
- * <p>The state of the retention rule. Only retention rules that are in the <code>available</code> state retain snapshots.</p>
469
+ * <p>The state of the retention rule. Only retention rules that are in the <code>available</code>
470
+ * state retain resources.</p>
453
471
  */
454
472
  Status?: RuleStatus | string;
455
473
  }
@@ -11,7 +11,8 @@ export declare namespace ResourceTag {
11
11
  const filterSensitiveLog: (obj: ResourceTag) => any;
12
12
  }
13
13
  export declare enum ResourceType {
14
- EBS_SNAPSHOT = "EBS_SNAPSHOT"
14
+ EBS_SNAPSHOT = "EBS_SNAPSHOT",
15
+ EC2_IMAGE = "EC2_IMAGE"
15
16
  }
16
17
  export declare enum RetentionPeriodUnit {
17
18
  DAYS = "DAYS"
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.48.0",
4
+ "version": "3.52.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -9,7 +9,7 @@
9
9
  "build:es": "tsc -p tsconfig.es.json",
10
10
  "build:types": "tsc -p tsconfig.types.json",
11
11
  "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
12
- "clean": "rimraf ./dist-*"
12
+ "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo"
13
13
  },
14
14
  "main": "./dist-cjs/index.js",
15
15
  "types": "./dist-types/index.d.ts",
@@ -18,41 +18,47 @@
18
18
  "dependencies": {
19
19
  "@aws-crypto/sha256-browser": "2.0.0",
20
20
  "@aws-crypto/sha256-js": "2.0.0",
21
- "@aws-sdk/client-sts": "3.48.0",
22
- "@aws-sdk/config-resolver": "3.47.2",
23
- "@aws-sdk/credential-provider-node": "3.48.0",
24
- "@aws-sdk/fetch-http-handler": "3.47.2",
25
- "@aws-sdk/hash-node": "3.47.2",
26
- "@aws-sdk/invalid-dependency": "3.47.2",
27
- "@aws-sdk/middleware-content-length": "3.47.2",
28
- "@aws-sdk/middleware-host-header": "3.47.2",
29
- "@aws-sdk/middleware-logger": "3.47.2",
30
- "@aws-sdk/middleware-retry": "3.47.2",
31
- "@aws-sdk/middleware-serde": "3.47.2",
32
- "@aws-sdk/middleware-signing": "3.47.2",
33
- "@aws-sdk/middleware-stack": "3.47.2",
34
- "@aws-sdk/middleware-user-agent": "3.47.2",
35
- "@aws-sdk/node-config-provider": "3.47.2",
36
- "@aws-sdk/node-http-handler": "3.47.2",
37
- "@aws-sdk/protocol-http": "3.47.2",
38
- "@aws-sdk/smithy-client": "3.47.2",
39
- "@aws-sdk/types": "3.47.1",
40
- "@aws-sdk/url-parser": "3.47.2",
41
- "@aws-sdk/util-base64-browser": "3.47.1",
42
- "@aws-sdk/util-base64-node": "3.47.2",
43
- "@aws-sdk/util-body-length-browser": "3.47.1",
44
- "@aws-sdk/util-body-length-node": "3.47.1",
45
- "@aws-sdk/util-defaults-mode-browser": "3.47.2",
46
- "@aws-sdk/util-defaults-mode-node": "3.47.2",
47
- "@aws-sdk/util-user-agent-browser": "3.47.2",
48
- "@aws-sdk/util-user-agent-node": "3.47.2",
49
- "@aws-sdk/util-utf8-browser": "3.47.1",
50
- "@aws-sdk/util-utf8-node": "3.47.2",
21
+ "@aws-sdk/client-sts": "3.52.0",
22
+ "@aws-sdk/config-resolver": "3.52.0",
23
+ "@aws-sdk/credential-provider-node": "3.52.0",
24
+ "@aws-sdk/fetch-http-handler": "3.52.0",
25
+ "@aws-sdk/hash-node": "3.52.0",
26
+ "@aws-sdk/invalid-dependency": "3.52.0",
27
+ "@aws-sdk/middleware-content-length": "3.52.0",
28
+ "@aws-sdk/middleware-host-header": "3.52.0",
29
+ "@aws-sdk/middleware-logger": "3.52.0",
30
+ "@aws-sdk/middleware-retry": "3.52.0",
31
+ "@aws-sdk/middleware-serde": "3.52.0",
32
+ "@aws-sdk/middleware-signing": "3.52.0",
33
+ "@aws-sdk/middleware-stack": "3.52.0",
34
+ "@aws-sdk/middleware-user-agent": "3.52.0",
35
+ "@aws-sdk/node-config-provider": "3.52.0",
36
+ "@aws-sdk/node-http-handler": "3.52.0",
37
+ "@aws-sdk/protocol-http": "3.52.0",
38
+ "@aws-sdk/smithy-client": "3.52.0",
39
+ "@aws-sdk/types": "3.52.0",
40
+ "@aws-sdk/url-parser": "3.52.0",
41
+ "@aws-sdk/util-base64-browser": "3.52.0",
42
+ "@aws-sdk/util-base64-node": "3.52.0",
43
+ "@aws-sdk/util-body-length-browser": "3.52.0",
44
+ "@aws-sdk/util-body-length-node": "3.52.0",
45
+ "@aws-sdk/util-defaults-mode-browser": "3.52.0",
46
+ "@aws-sdk/util-defaults-mode-node": "3.52.0",
47
+ "@aws-sdk/util-user-agent-browser": "3.52.0",
48
+ "@aws-sdk/util-user-agent-node": "3.52.0",
49
+ "@aws-sdk/util-utf8-browser": "3.52.0",
50
+ "@aws-sdk/util-utf8-node": "3.52.0",
51
51
  "tslib": "^2.3.0"
52
52
  },
53
53
  "devDependencies": {
54
- "@aws-sdk/service-client-documentation-generator": "3.47.1",
55
- "@types/node": "^12.7.5"
54
+ "@aws-sdk/service-client-documentation-generator": "3.52.0",
55
+ "@tsconfig/recommended": "1.0.1",
56
+ "@types/node": "^12.7.5",
57
+ "concurrently": "7.0.0",
58
+ "downlevel-dts": "0.7.0",
59
+ "rimraf": "3.0.2",
60
+ "typedoc": "0.19.2",
61
+ "typescript": "~4.3.5"
56
62
  },
57
63
  "engines": {
58
64
  "node": ">=12.0.0"