@aws-sdk/client-ram 3.42.0 → 3.47.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 (43) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/README.md +5 -6
  3. package/dist-cjs/endpoints.js +1 -20
  4. package/dist-cjs/models/models_0.js +13 -128
  5. package/dist-cjs/protocols/Aws_restJson1.js +29 -0
  6. package/dist-cjs/runtimeConfig.browser.js +7 -2
  7. package/dist-cjs/runtimeConfig.js +9 -3
  8. package/dist-es/endpoints.js +1 -20
  9. package/dist-es/models/models_0.js +11 -84
  10. package/dist-es/protocols/Aws_restJson1.js +65 -36
  11. package/dist-es/runtimeConfig.browser.js +12 -3
  12. package/dist-es/runtimeConfig.js +13 -6
  13. package/dist-types/RAM.d.ts +55 -41
  14. package/dist-types/RAMClient.d.ts +10 -7
  15. package/dist-types/commands/AcceptResourceShareInvitationCommand.d.ts +3 -1
  16. package/dist-types/commands/AssociateResourceShareCommand.d.ts +3 -1
  17. package/dist-types/commands/AssociateResourceSharePermissionCommand.d.ts +4 -1
  18. package/dist-types/commands/CreateResourceShareCommand.d.ts +3 -3
  19. package/dist-types/commands/DeleteResourceShareCommand.d.ts +3 -1
  20. package/dist-types/commands/DisassociateResourceSharePermissionCommand.d.ts +3 -1
  21. package/dist-types/commands/EnableSharingWithAwsOrganizationCommand.d.ts +9 -2
  22. package/dist-types/commands/GetResourcePoliciesCommand.d.ts +2 -1
  23. package/dist-types/commands/GetResourceShareAssociationsCommand.d.ts +1 -1
  24. package/dist-types/commands/GetResourceShareInvitationsCommand.d.ts +1 -1
  25. package/dist-types/commands/GetResourceSharesCommand.d.ts +1 -1
  26. package/dist-types/commands/ListPendingInvitationResourcesCommand.d.ts +3 -2
  27. package/dist-types/commands/ListPermissionsCommand.d.ts +2 -1
  28. package/dist-types/commands/ListPrincipalsCommand.d.ts +1 -1
  29. package/dist-types/commands/ListResourceTypesCommand.d.ts +1 -1
  30. package/dist-types/commands/PromoteResourceShareCreatedFromPolicyCommand.d.ts +6 -13
  31. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  32. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateResourceShareCommand.d.ts +1 -1
  34. package/dist-types/models/models_0.d.ts +841 -388
  35. package/dist-types/runtimeConfig.browser.d.ts +3 -2
  36. package/dist-types/runtimeConfig.d.ts +4 -3
  37. package/dist-types/runtimeConfig.native.d.ts +1 -0
  38. package/dist-types/ts3.4/RAMClient.d.ts +3 -1
  39. package/dist-types/ts3.4/models/models_0.d.ts +24 -83
  40. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
  41. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
  42. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
  43. package/package.json +38 -45
@@ -1,11 +1,18 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
2
  export interface AcceptResourceShareInvitationRequest {
3
3
  /**
4
- * <p>The Amazon Resource Name (ARN) of the invitation.</p>
4
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the invitation that you want to accept.</p>
5
5
  */
6
6
  resourceShareInvitationArn: string | undefined;
7
7
  /**
8
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
8
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
9
+ * ensure the idempotency of the request. This lets you safely retry the request without
10
+ * accidentally performing the same operation a second time. Passing the same value to a
11
+ * later call to an operation requires that you also pass the same value for all other
12
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
13
+ * value.</a>.</p>
14
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
15
+ * you.</p>
9
16
  */
10
17
  clientToken?: string;
11
18
  }
@@ -18,11 +25,11 @@ export declare namespace AcceptResourceShareInvitationRequest {
18
25
  export declare type ResourceShareAssociationType = "PRINCIPAL" | "RESOURCE";
19
26
  export declare type ResourceShareAssociationStatus = "ASSOCIATED" | "ASSOCIATING" | "DISASSOCIATED" | "DISASSOCIATING" | "FAILED";
20
27
  /**
21
- * <p>Describes an association with a resource share.</p>
28
+ * <p>Describes an association with a resource share and either a principal or a resource.</p>
22
29
  */
23
30
  export interface ResourceShareAssociation {
24
31
  /**
25
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
32
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share.</p>
26
33
  */
27
34
  resourceShareArn?: string;
28
35
  /**
@@ -30,33 +37,40 @@ export interface ResourceShareAssociation {
30
37
  */
31
38
  resourceShareName?: string;
32
39
  /**
33
- * <p>The associated entity. For resource associations, this is the Amazon Resource Name
34
- * (ARN) of the resource. For principal associations, this is one of the following:</p>
40
+ * <p>The associated entity. This can be either of the following:</p>
35
41
  * <ul>
36
42
  * <li>
37
- * <p>An Amazon Web Services account ID</p>
43
+ * <p>For a resource association, this is the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource.</p>
38
44
  * </li>
39
45
  * <li>
40
- * <p>An ARN of an organization in Organizations</p>
41
- * </li>
42
- * <li>
43
- * <p>An ARN of an organizational unit (OU) in Organizations</p>
44
- * </li>
45
- * <li>
46
- * <p>An ARN of an IAM role</p>
47
- * </li>
48
- * <li>
49
- * <p>An ARN of an IAM user</p>
46
+ * <p>For principal associations, this is one of the following:</p>
47
+ * <ul>
48
+ * <li>
49
+ * <p>The ID of an Amazon Web Services account</p>
50
+ * </li>
51
+ * <li>
52
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of an organization in Organizations</p>
53
+ * </li>
54
+ * <li>
55
+ * <p>The ARN of an organizational unit (OU) in Organizations</p>
56
+ * </li>
57
+ * <li>
58
+ * <p>The ARN of an IAM role</p>
59
+ * </li>
60
+ * <li>
61
+ * <p>The ARN of an IAM user</p>
62
+ * </li>
63
+ * </ul>
50
64
  * </li>
51
65
  * </ul>
52
66
  */
53
67
  associatedEntity?: string;
54
68
  /**
55
- * <p>The association type.</p>
69
+ * <p>The type of entity included in this association.</p>
56
70
  */
57
71
  associationType?: ResourceShareAssociationType | string;
58
72
  /**
59
- * <p>The status of the association.</p>
73
+ * <p>The current status of the association.</p>
60
74
  */
61
75
  status?: ResourceShareAssociationStatus | string;
62
76
  /**
@@ -64,11 +78,11 @@ export interface ResourceShareAssociation {
64
78
  */
65
79
  statusMessage?: string;
66
80
  /**
67
- * <p>The time when the association was created.</p>
81
+ * <p>The date and time when the association was created.</p>
68
82
  */
69
83
  creationTime?: Date;
70
84
  /**
71
- * <p>The time when the association was last updated.</p>
85
+ * <p>The date and time when the association was last updated.</p>
72
86
  */
73
87
  lastUpdatedTime?: Date;
74
88
  /**
@@ -85,11 +99,11 @@ export declare namespace ResourceShareAssociation {
85
99
  }
86
100
  export declare type ResourceShareInvitationStatus = "ACCEPTED" | "EXPIRED" | "PENDING" | "REJECTED";
87
101
  /**
88
- * <p>Describes an invitation to join a resource share.</p>
102
+ * <p>Describes an invitation for an Amazon Web Services account to join a resource share.</p>
89
103
  */
90
104
  export interface ResourceShareInvitation {
91
105
  /**
92
- * <p>The Amazon Resource Name (ARN) of the invitation.</p>
106
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the invitation.</p>
93
107
  */
94
108
  resourceShareInvitationArn?: string;
95
109
  /**
@@ -97,7 +111,7 @@ export interface ResourceShareInvitation {
97
111
  */
98
112
  resourceShareName?: string;
99
113
  /**
100
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
114
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share</p>
101
115
  */
102
116
  resourceShareArn?: string;
103
117
  /**
@@ -113,19 +127,17 @@ export interface ResourceShareInvitation {
113
127
  */
114
128
  invitationTimestamp?: Date;
115
129
  /**
116
- * <p>The status of the invitation.</p>
130
+ * <p>The current status of the invitation.</p>
117
131
  */
118
132
  status?: ResourceShareInvitationStatus | string;
119
133
  /**
120
134
  * @deprecated
121
135
  *
122
- * <p>To view the resources associated with a pending resource share invitation, use <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_ListPendingInvitationResources.html">
123
- * ListPendingInvitationResources</a>.</p>
136
+ * <p>To view the resources associated with a pending resource share invitation, use <a>ListPendingInvitationResources</a>.</p>
124
137
  */
125
138
  resourceShareAssociations?: ResourceShareAssociation[];
126
139
  /**
127
- * <p>The Amazon Resource Name (ARN) of the IAM user or IAM role that received the
128
- * invitation.</p>
140
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the IAM user or role that received the invitation.</p>
129
141
  */
130
142
  receiverArn?: string;
131
143
  }
@@ -137,11 +149,14 @@ export declare namespace ResourceShareInvitation {
137
149
  }
138
150
  export interface AcceptResourceShareInvitationResponse {
139
151
  /**
140
- * <p>Information about the invitation.</p>
152
+ * <p>An object that contains information about the specified invitation.</p>
141
153
  */
142
154
  resourceShareInvitation?: ResourceShareInvitation;
143
155
  /**
144
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
156
+ * <p>The idempotency identifier associated with this request. If you
157
+ * want to repeat the same operation in an idempotent manner then you must include this
158
+ * value in the <code>clientToken</code> request parameter of that later call. All other
159
+ * parameters must also have the same values that you used in the first call.</p>
145
160
  */
146
161
  clientToken?: string;
147
162
  }
@@ -152,34 +167,23 @@ export declare namespace AcceptResourceShareInvitationResponse {
152
167
  const filterSensitiveLog: (obj: AcceptResourceShareInvitationResponse) => any;
153
168
  }
154
169
  /**
155
- * <p>A client token input parameter was reused with an operation, but at least one of the
156
- * other input parameters is different from the previous call to the operation.</p>
170
+ * <p>The client token input parameter was matched one used with a previous call to the
171
+ * operation, but at least one of the other input parameters is different from the previous
172
+ * call.</p>
157
173
  */
158
174
  export interface IdempotentParameterMismatchException extends __SmithyException, $MetadataBearer {
159
175
  name: "IdempotentParameterMismatchException";
160
176
  $fault: "client";
161
177
  message: string | undefined;
162
178
  }
163
- export declare namespace IdempotentParameterMismatchException {
164
- /**
165
- * @internal
166
- */
167
- const filterSensitiveLog: (obj: IdempotentParameterMismatchException) => any;
168
- }
169
179
  /**
170
- * <p>A client token is not valid.</p>
180
+ * <p>The client token is not valid.</p>
171
181
  */
172
182
  export interface InvalidClientTokenException extends __SmithyException, $MetadataBearer {
173
183
  name: "InvalidClientTokenException";
174
184
  $fault: "client";
175
185
  message: string | undefined;
176
186
  }
177
- export declare namespace InvalidClientTokenException {
178
- /**
179
- * @internal
180
- */
181
- const filterSensitiveLog: (obj: InvalidClientTokenException) => any;
182
- }
183
187
  /**
184
188
  * <p>The format of an Amazon Resource Name (ARN) is not valid.</p>
185
189
  */
@@ -188,12 +192,6 @@ export interface MalformedArnException extends __SmithyException, $MetadataBeare
188
192
  $fault: "client";
189
193
  message: string | undefined;
190
194
  }
191
- export declare namespace MalformedArnException {
192
- /**
193
- * @internal
194
- */
195
- const filterSensitiveLog: (obj: MalformedArnException) => any;
196
- }
197
195
  /**
198
196
  * <p>The requested operation is not permitted.</p>
199
197
  */
@@ -202,68 +200,38 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta
202
200
  $fault: "client";
203
201
  message: string | undefined;
204
202
  }
205
- export declare namespace OperationNotPermittedException {
206
- /**
207
- * @internal
208
- */
209
- const filterSensitiveLog: (obj: OperationNotPermittedException) => any;
210
- }
211
203
  /**
212
- * <p>The invitation was already accepted.</p>
204
+ * <p>The specified invitation was already accepted.</p>
213
205
  */
214
206
  export interface ResourceShareInvitationAlreadyAcceptedException extends __SmithyException, $MetadataBearer {
215
207
  name: "ResourceShareInvitationAlreadyAcceptedException";
216
208
  $fault: "client";
217
209
  message: string | undefined;
218
210
  }
219
- export declare namespace ResourceShareInvitationAlreadyAcceptedException {
220
- /**
221
- * @internal
222
- */
223
- const filterSensitiveLog: (obj: ResourceShareInvitationAlreadyAcceptedException) => any;
224
- }
225
211
  /**
226
- * <p>The invitation was already rejected.</p>
212
+ * <p>The specified invitation was already rejected.</p>
227
213
  */
228
214
  export interface ResourceShareInvitationAlreadyRejectedException extends __SmithyException, $MetadataBearer {
229
215
  name: "ResourceShareInvitationAlreadyRejectedException";
230
216
  $fault: "client";
231
217
  message: string | undefined;
232
218
  }
233
- export declare namespace ResourceShareInvitationAlreadyRejectedException {
234
- /**
235
- * @internal
236
- */
237
- const filterSensitiveLog: (obj: ResourceShareInvitationAlreadyRejectedException) => any;
238
- }
239
219
  /**
240
- * <p>The Amazon Resource Name (ARN) for an invitation was not found.</p>
220
+ * <p>The specified Amazon Resource Name (ARN) for an invitation was not found.</p>
241
221
  */
242
222
  export interface ResourceShareInvitationArnNotFoundException extends __SmithyException, $MetadataBearer {
243
223
  name: "ResourceShareInvitationArnNotFoundException";
244
224
  $fault: "client";
245
225
  message: string | undefined;
246
226
  }
247
- export declare namespace ResourceShareInvitationArnNotFoundException {
248
- /**
249
- * @internal
250
- */
251
- const filterSensitiveLog: (obj: ResourceShareInvitationArnNotFoundException) => any;
252
- }
253
227
  /**
254
- * <p>The invitation is expired.</p>
228
+ * <p>The specified invitation is expired.</p>
255
229
  */
256
230
  export interface ResourceShareInvitationExpiredException extends __SmithyException, $MetadataBearer {
257
231
  name: "ResourceShareInvitationExpiredException";
258
232
  $fault: "client";
259
233
  message: string | undefined;
260
234
  }
261
- export declare namespace ResourceShareInvitationExpiredException {
262
- /**
263
- * @internal
264
- */
265
- const filterSensitiveLog: (obj: ResourceShareInvitationExpiredException) => any;
266
- }
267
235
  /**
268
236
  * <p>The service could not respond to the request due to an internal problem.</p>
269
237
  */
@@ -272,12 +240,6 @@ export interface ServerInternalException extends __SmithyException, $MetadataBea
272
240
  $fault: "server";
273
241
  message: string | undefined;
274
242
  }
275
- export declare namespace ServerInternalException {
276
- /**
277
- * @internal
278
- */
279
- const filterSensitiveLog: (obj: ServerInternalException) => any;
280
- }
281
243
  /**
282
244
  * <p>The service is not available.</p>
283
245
  */
@@ -286,49 +248,65 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat
286
248
  $fault: "server";
287
249
  message: string | undefined;
288
250
  }
289
- export declare namespace ServiceUnavailableException {
290
- /**
291
- * @internal
292
- */
293
- const filterSensitiveLog: (obj: ServiceUnavailableException) => any;
294
- }
295
251
  export interface AssociateResourceShareRequest {
296
252
  /**
297
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
253
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share that you want to add principals or resources
254
+ * to.</p>
298
255
  */
299
256
  resourceShareArn: string | undefined;
300
257
  /**
301
- * <p>The Amazon Resource Names (ARNs) of the resources.</p>
258
+ * <p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resources that you want to share. This can be
259
+ * <code>null</code> if you want to add only principals.</p>
302
260
  */
303
261
  resourceArns?: string[];
304
262
  /**
305
- * <p>The principals to associate with the resource share. The possible values are:</p>
263
+ * <p>Specifies a list of principals to whom you want to the resource share. This can be
264
+ * <code>null</code> if you want to add only resources.</p>
265
+ * <p>What the principals can do with the resources in the share is determined by the RAM
266
+ * permissions that you associate with the resource share. See <a>AssociateResourceSharePermission</a>.</p>
267
+ * <p>You can include the following values:</p>
306
268
  * <ul>
307
269
  * <li>
308
- * <p>An Amazon Web Services account ID</p>
270
+ * <p>An Amazon Web Services account ID, for example: <code>123456789012</code>
271
+ * </p>
309
272
  * </li>
310
273
  * <li>
311
- * <p>An Amazon Resource Name (ARN) of an organization in Organizations</p>
274
+ * <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of an organization in Organizations, for example:
275
+ * <code>organizations::123456789012:organization/o-exampleorgid</code>
276
+ * </p>
312
277
  * </li>
313
278
  * <li>
314
- * <p>An ARN of an organizational unit (OU) in Organizations</p>
279
+ * <p>An ARN of an organizational unit (OU) in Organizations, for example:
280
+ * <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code>
281
+ * </p>
315
282
  * </li>
316
283
  * <li>
317
- * <p>An ARN of an IAM role</p>
284
+ * <p>An ARN of an IAM role, for example:
285
+ * <code>iam::123456789012:role/rolename</code>
286
+ * </p>
318
287
  * </li>
319
288
  * <li>
320
- * <p>An ARN of an IAM user</p>
289
+ * <p>An ARN of an IAM user, for example:
290
+ * <code>iam::123456789012user/username</code>
291
+ * </p>
321
292
  * </li>
322
293
  * </ul>
323
294
  * <note>
324
- * <p>Not all resource types can be shared with IAM roles and IAM users. For more
325
- * information, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types">Sharing with IAM roles and IAM users</a> in the <i>Resource Access Manager User
295
+ * <p>Not all resource types can be shared with IAM roles and users.
296
+ * For more information, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types">Sharing with IAM roles and users</a> in the <i>Resource Access Manager User
326
297
  * Guide</i>.</p>
327
- * </note>
298
+ * </note>
328
299
  */
329
300
  principals?: string[];
330
301
  /**
331
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
302
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
303
+ * ensure the idempotency of the request. This lets you safely retry the request without
304
+ * accidentally performing the same operation a second time. Passing the same value to a
305
+ * later call to an operation requires that you also pass the same value for all other
306
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
307
+ * value.</a>.</p>
308
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
309
+ * you.</p>
332
310
  */
333
311
  clientToken?: string;
334
312
  }
@@ -340,11 +318,14 @@ export declare namespace AssociateResourceShareRequest {
340
318
  }
341
319
  export interface AssociateResourceShareResponse {
342
320
  /**
343
- * <p>Information about the associations.</p>
321
+ * <p>An array of objects that contain information about the associations.</p>
344
322
  */
345
323
  resourceShareAssociations?: ResourceShareAssociation[];
346
324
  /**
347
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
325
+ * <p>The idempotency identifier associated with this request. If you
326
+ * want to repeat the same operation in an idempotent manner then you must include this
327
+ * value in the <code>clientToken</code> request parameter of that later call. All other
328
+ * parameters must also have the same values that you used in the first call.</p>
348
329
  */
349
330
  clientToken?: string;
350
331
  }
@@ -362,12 +343,6 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB
362
343
  $fault: "client";
363
344
  message: string | undefined;
364
345
  }
365
- export declare namespace InvalidParameterException {
366
- /**
367
- * @internal
368
- */
369
- const filterSensitiveLog: (obj: InvalidParameterException) => any;
370
- }
371
346
  /**
372
347
  * <p>The requested state transition is not valid.</p>
373
348
  */
@@ -376,25 +351,22 @@ export interface InvalidStateTransitionException extends __SmithyException, $Met
376
351
  $fault: "client";
377
352
  message: string | undefined;
378
353
  }
379
- export declare namespace InvalidStateTransitionException {
380
- /**
381
- * @internal
382
- */
383
- const filterSensitiveLog: (obj: InvalidStateTransitionException) => any;
384
- }
385
354
  /**
386
- * <p>The requested resource share exceeds the limit for your account.</p>
355
+ * <p>This request would exceed the limit for resource shares for your account.</p>
387
356
  */
388
357
  export interface ResourceShareLimitExceededException extends __SmithyException, $MetadataBearer {
389
358
  name: "ResourceShareLimitExceededException";
390
359
  $fault: "client";
391
360
  message: string | undefined;
392
361
  }
393
- export declare namespace ResourceShareLimitExceededException {
394
- /**
395
- * @internal
396
- */
397
- const filterSensitiveLog: (obj: ResourceShareLimitExceededException) => any;
362
+ /**
363
+ * <p>You exceeded the rate at which you are allowed to perform this operation. Please try
364
+ * again later.</p>
365
+ */
366
+ export interface ThrottlingException extends __SmithyException, $MetadataBearer {
367
+ name: "ThrottlingException";
368
+ $fault: "client";
369
+ message: string | undefined;
398
370
  }
399
371
  /**
400
372
  * <p>A specified resource was not found.</p>
@@ -404,34 +376,45 @@ export interface UnknownResourceException extends __SmithyException, $MetadataBe
404
376
  $fault: "client";
405
377
  message: string | undefined;
406
378
  }
407
- export declare namespace UnknownResourceException {
408
- /**
409
- * @internal
410
- */
411
- const filterSensitiveLog: (obj: UnknownResourceException) => any;
412
- }
413
379
  export interface AssociateResourceSharePermissionRequest {
414
380
  /**
415
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
381
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share to which you want to add or replace
382
+ * permissions.</p>
416
383
  */
417
384
  resourceShareArn: string | undefined;
418
385
  /**
419
- * <p>The Amazon Resource Name (ARN) of the RAM permission to associate with the
420
- * resource share.</p>
386
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the RAM permission to associate with the resource share.
387
+ * To find the ARN for a permission, use either the <a>ListPermissions</a> operation or go to the <a href="https://console.aws.amazon.com/ram/home#Permissions:">Permissions library</a> page in the RAM console and
388
+ * then choose the name of the permission. The ARN is displayed on the detail page.</p>
421
389
  */
422
390
  permissionArn: string | undefined;
423
391
  /**
424
- * <p>Indicates whether the permission should replace the permissions that are currently
425
- * associated with the resource share. Use <code>true</code> to replace the current permissions. Use
426
- * <code>false</code> to add the permission to the current permission.</p>
392
+ * <p>Specifies whether the specified permission should replace or add to the existing
393
+ * permission associated with the resource share. Use <code>true</code> to replace the current
394
+ * permissions. Use <code>false</code> to add the permission to the current permission. The
395
+ * default value is <code>false</code>.</p>
396
+ * <note>
397
+ * <p>A resource share can have only one permission per resource type. If a resource share already has a
398
+ * permission for the specified resource type and you don't set <code>replace</code> to
399
+ * <code>true</code> then the operation returns an error. This helps prevent
400
+ * accidental overwriting of a permission.</p>
401
+ * </note>
427
402
  */
428
403
  replace?: boolean;
429
404
  /**
430
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
405
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
406
+ * ensure the idempotency of the request. This lets you safely retry the request without
407
+ * accidentally performing the same operation a second time. Passing the same value to a
408
+ * later call to an operation requires that you also pass the same value for all other
409
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
410
+ * value.</a>.</p>
411
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
412
+ * you.</p>
431
413
  */
432
414
  clientToken?: string;
433
415
  /**
434
- * <p>The version of the RAM permissions to associate with the resource share.</p>
416
+ * <p>Specifies the version of the RAM permission to associate with the resource share. If you don't
417
+ * specify this parameter, the operation uses the version designated as the default.</p>
435
418
  */
436
419
  permissionVersion?: number;
437
420
  }
@@ -443,11 +426,15 @@ export declare namespace AssociateResourceSharePermissionRequest {
443
426
  }
444
427
  export interface AssociateResourceSharePermissionResponse {
445
428
  /**
446
- * <p>Indicates whether the request succeeded.</p>
429
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
430
+ * A value of <code>false</code> indicates that the request failed.</p>
447
431
  */
448
432
  returnValue?: boolean;
449
433
  /**
450
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
434
+ * <p>The idempotency identifier associated with this request. If you
435
+ * want to repeat the same operation in an idempotent manner then you must include this
436
+ * value in the <code>clientToken</code> request parameter of that later call. All other
437
+ * parameters must also have the same values that you used in the first call.</p>
451
438
  */
452
439
  clientToken?: string;
453
440
  }
@@ -458,15 +445,22 @@ export declare namespace AssociateResourceSharePermissionResponse {
458
445
  const filterSensitiveLog: (obj: AssociateResourceSharePermissionResponse) => any;
459
446
  }
460
447
  /**
461
- * <p>Information about a tag.</p>
448
+ * <p>A structure containing a tag. A tag is metadata that you can attach to your resources
449
+ * to help organize and categorize them. You can also use them to help you secure your
450
+ * resources. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources
451
+ * using tags</a>.</p>
452
+ * <p>For more information about tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the
453
+ * <i>Amazon Web Services General Reference Guide</i>.</p>
462
454
  */
463
455
  export interface Tag {
464
456
  /**
465
- * <p>The key of the tag.</p>
457
+ * <p>The key, or name, attached to the tag. Every tag must have a key. Key names are case
458
+ * sensitive.</p>
466
459
  */
467
460
  key?: string;
468
461
  /**
469
- * <p>The value of the tag.</p>
462
+ * <p>The string value attached to the tag. The value can be an empty string. Key values are
463
+ * case sensitive.</p>
470
464
  */
471
465
  value?: string;
472
466
  }
@@ -478,57 +472,79 @@ export declare namespace Tag {
478
472
  }
479
473
  export interface CreateResourceShareRequest {
480
474
  /**
481
- * <p>The name of the resource share.</p>
475
+ * <p>Specifies the name of the resource share.</p>
482
476
  */
483
477
  name: string | undefined;
484
478
  /**
485
- * <p>The ARNs of the resources to associate with the resource share.</p>
479
+ * <p>Specifies a list of one or more ARNs of the resources to associate with the
480
+ * resource share.</p>
486
481
  */
487
482
  resourceArns?: string[];
488
483
  /**
489
- * <p>The principals to associate with the resource share. The possible values are:</p>
484
+ * <p>Specifies a list of one or more principals to associate with the resource share.</p>
485
+ * <p>You can include the following values:</p>
490
486
  * <ul>
491
487
  * <li>
492
- * <p>An Amazon Web Services account ID</p>
488
+ * <p>An Amazon Web Services account ID, for example: <code>123456789012</code>
489
+ * </p>
493
490
  * </li>
494
491
  * <li>
495
- * <p>An Amazon Resource Name (ARN) of an organization in Organizations</p>
492
+ * <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of an organization in Organizations, for example:
493
+ * <code>organizations::123456789012:organization/o-exampleorgid</code>
494
+ * </p>
496
495
  * </li>
497
496
  * <li>
498
- * <p>An ARN of an organizational unit (OU) in Organizations</p>
497
+ * <p>An ARN of an organizational unit (OU) in Organizations, for example:
498
+ * <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code>
499
+ * </p>
499
500
  * </li>
500
501
  * <li>
501
- * <p>An ARN of an IAM role</p>
502
+ * <p>An ARN of an IAM role, for example:
503
+ * <code>iam::123456789012:role/rolename</code>
504
+ * </p>
502
505
  * </li>
503
506
  * <li>
504
- * <p>An ARN of an IAM user</p>
507
+ * <p>An ARN of an IAM user, for example:
508
+ * <code>iam::123456789012user/username</code>
509
+ * </p>
505
510
  * </li>
506
511
  * </ul>
507
512
  * <note>
508
- * <p>Not all resource types can be shared with IAM roles and IAM users. For more
509
- * information, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types">Sharing with IAM roles and IAM users</a> in the <i>Resource Access Manager User
513
+ * <p>Not all resource types can be shared with IAM roles and users.
514
+ * For more information, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types">Sharing with IAM roles and users</a> in the <i>Resource Access Manager User
510
515
  * Guide</i>.</p>
511
- * </note>
516
+ * </note>
512
517
  */
513
518
  principals?: string[];
514
519
  /**
515
- * <p>One or more tags.</p>
520
+ * <p>Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to
521
+ * the resources associated with the resource share.</p>
516
522
  */
517
523
  tags?: Tag[];
518
524
  /**
519
- * <p>Indicates whether principals outside your organization in Organizations can be associated
520
- * with a resource share.</p>
525
+ * <p>Specifies whether principals outside your organization in Organizations can be associated
526
+ * with a resource share. A value of <code>true</code> lets you share with individual Amazon Web Services accounts
527
+ * that are <i>not</i> in your organization. A value of <code>false</code>
528
+ * only has meaning if your account is a member of an Amazon Web Services Organization. The default value
529
+ * is <code>true</code>.</p>
521
530
  */
522
531
  allowExternalPrincipals?: boolean;
523
532
  /**
524
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
533
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
534
+ * ensure the idempotency of the request. This lets you safely retry the request without
535
+ * accidentally performing the same operation a second time. Passing the same value to a
536
+ * later call to an operation requires that you also pass the same value for all other
537
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
538
+ * value.</a>.</p>
539
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
540
+ * you.</p>
525
541
  */
526
542
  clientToken?: string;
527
543
  /**
528
- * <p>The Amazon Resource Names (ARNs) of the permissions to associate with the resource share. If you
529
- * do not specify an ARN for the permission, RAM automatically attaches the default
530
- * version of the permission for each resource type. Only one permission can be associated
531
- * with each resource type in a resource share.</p>
544
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the RAM permission to associate with the resource share. If you do
545
+ * not specify an ARN for the permission, RAM automatically attaches the default version
546
+ * of the permission for each resource type. You can associate only one permission with
547
+ * each resource type included in the resource share.</p>
532
548
  */
533
549
  permissionArns?: string[];
534
550
  }
@@ -541,11 +557,11 @@ export declare namespace CreateResourceShareRequest {
541
557
  export declare type ResourceShareFeatureSet = "CREATED_FROM_POLICY" | "PROMOTING_TO_STANDARD" | "STANDARD";
542
558
  export declare type ResourceShareStatus = "ACTIVE" | "DELETED" | "DELETING" | "FAILED" | "PENDING";
543
559
  /**
544
- * <p>Describes a resource share.</p>
560
+ * <p>Describes a resource share in RAM.</p>
545
561
  */
546
562
  export interface ResourceShare {
547
563
  /**
548
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
564
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share</p>
549
565
  */
550
566
  resourceShareArn?: string;
551
567
  /**
@@ -562,7 +578,7 @@ export interface ResourceShare {
562
578
  */
563
579
  allowExternalPrincipals?: boolean;
564
580
  /**
565
- * <p>The status of the resource share.</p>
581
+ * <p>The current status of the resource share.</p>
566
582
  */
567
583
  status?: ResourceShareStatus | string;
568
584
  /**
@@ -570,15 +586,15 @@ export interface ResourceShare {
570
586
  */
571
587
  statusMessage?: string;
572
588
  /**
573
- * <p>The tags for the resource share.</p>
589
+ * <p>The tag key and value pairs attached to the resource share.</p>
574
590
  */
575
591
  tags?: Tag[];
576
592
  /**
577
- * <p>The time when the resource share was created.</p>
593
+ * <p>The date and time when the resource share was created.</p>
578
594
  */
579
595
  creationTime?: Date;
580
596
  /**
581
- * <p>The time when the resource share was last updated.</p>
597
+ * <p>The date and time when the resource share was last updated.</p>
582
598
  */
583
599
  lastUpdatedTime?: Date;
584
600
  /**
@@ -587,9 +603,9 @@ export interface ResourceShare {
587
603
  * <li>
588
604
  * <p>
589
605
  * <code>CREATED_FROM_POLICY</code> - Indicates that the resource share was created from an
590
- * Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource.
591
- * These resource shares are visible only to the Amazon Web Services account that created it. They cannot
592
- * be modified in RAM.</p>
606
+ * Identity and Access Management (IAM) resource-based permission policy attached to the resource.
607
+ * This type of resource share is visible only to the Amazon Web Services account that created it. You
608
+ * can't modify it in RAM unless you promote it. For more information, see <a>PromoteResourceShareCreatedFromPolicy</a>.</p>
593
609
  * </li>
594
610
  * <li>
595
611
  * <p>
@@ -599,8 +615,8 @@ export interface ResourceShare {
599
615
  * <li>
600
616
  * <p>
601
617
  * <code>STANDARD</code> - Indicates that the resource share was created in RAM using the
602
- * console or APIs. These resource shares are visible to all principals. They can
603
- * be modified in RAM.</p>
618
+ * console or APIs. These resource shares are visible to all principals you share the resource share
619
+ * with. You can modify these resource shares in RAM using the console or APIs.</p>
604
620
  * </li>
605
621
  * </ul>
606
622
  */
@@ -614,11 +630,14 @@ export declare namespace ResourceShare {
614
630
  }
615
631
  export interface CreateResourceShareResponse {
616
632
  /**
617
- * <p>Information about the resource share.</p>
633
+ * <p>An object with information about the new resource share.</p>
618
634
  */
619
635
  resourceShare?: ResourceShare;
620
636
  /**
621
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
637
+ * <p>The idempotency identifier associated with this request. If you
638
+ * want to repeat the same operation in an idempotent manner then you must include this
639
+ * value in the <code>clientToken</code> request parameter of that later call. All other
640
+ * parameters must also have the same values that you used in the first call.</p>
622
641
  */
623
642
  clientToken?: string;
624
643
  }
@@ -629,26 +648,27 @@ export declare namespace CreateResourceShareResponse {
629
648
  const filterSensitiveLog: (obj: CreateResourceShareResponse) => any;
630
649
  }
631
650
  /**
632
- * <p>The specified tag is a reserved word and cannot be used.</p>
651
+ * <p>The specified tag key is a reserved word and can't be used.</p>
633
652
  */
634
653
  export interface TagPolicyViolationException extends __SmithyException, $MetadataBearer {
635
654
  name: "TagPolicyViolationException";
636
655
  $fault: "client";
637
656
  message: string | undefined;
638
657
  }
639
- export declare namespace TagPolicyViolationException {
640
- /**
641
- * @internal
642
- */
643
- const filterSensitiveLog: (obj: TagPolicyViolationException) => any;
644
- }
645
658
  export interface DeleteResourceShareRequest {
646
659
  /**
647
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
660
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share to delete.</p>
648
661
  */
649
662
  resourceShareArn: string | undefined;
650
663
  /**
651
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
664
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
665
+ * ensure the idempotency of the request. This lets you safely retry the request without
666
+ * accidentally performing the same operation a second time. Passing the same value to a
667
+ * later call to an operation requires that you also pass the same value for all other
668
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
669
+ * value.</a>.</p>
670
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
671
+ * you.</p>
652
672
  */
653
673
  clientToken?: string;
654
674
  }
@@ -660,11 +680,15 @@ export declare namespace DeleteResourceShareRequest {
660
680
  }
661
681
  export interface DeleteResourceShareResponse {
662
682
  /**
663
- * <p>Indicates whether the request succeeded.</p>
683
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
684
+ * A value of <code>false</code> indicates that the request failed.</p>
664
685
  */
665
686
  returnValue?: boolean;
666
687
  /**
667
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
688
+ * <p>The idempotency identifier associated with this request. If you
689
+ * want to repeat the same operation in an idempotent manner then you must include this
690
+ * value in the <code>clientToken</code> request parameter of that later call. All other
691
+ * parameters must also have the same values that you used in the first call.</p>
668
692
  */
669
693
  clientToken?: string;
670
694
  }
@@ -676,19 +700,61 @@ export declare namespace DeleteResourceShareResponse {
676
700
  }
677
701
  export interface DisassociateResourceShareRequest {
678
702
  /**
679
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
703
+ * <p>Specifies <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share that you want to remove resources from.</p>
680
704
  */
681
705
  resourceShareArn: string | undefined;
682
706
  /**
683
- * <p>The Amazon Resource Names (ARNs) of the resources.</p>
707
+ * <p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> for one or more resources that you want to remove from
708
+ * the resource share. After the operation runs, these resources are no longer shared with principals
709
+ * outside of the Amazon Web Services account that created the resources.</p>
684
710
  */
685
711
  resourceArns?: string[];
686
712
  /**
687
- * <p>The principals.</p>
713
+ * <p>Specifies a list of one or more principals that no longer are to have access to the
714
+ * resources in this resource share.</p>
715
+ * <p>You can include the following values:</p>
716
+ * <ul>
717
+ * <li>
718
+ * <p>An Amazon Web Services account ID, for example: <code>123456789012</code>
719
+ * </p>
720
+ * </li>
721
+ * <li>
722
+ * <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of an organization in Organizations, for example:
723
+ * <code>organizations::123456789012:organization/o-exampleorgid</code>
724
+ * </p>
725
+ * </li>
726
+ * <li>
727
+ * <p>An ARN of an organizational unit (OU) in Organizations, for example:
728
+ * <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code>
729
+ * </p>
730
+ * </li>
731
+ * <li>
732
+ * <p>An ARN of an IAM role, for example:
733
+ * <code>iam::123456789012:role/rolename</code>
734
+ * </p>
735
+ * </li>
736
+ * <li>
737
+ * <p>An ARN of an IAM user, for example:
738
+ * <code>iam::123456789012user/username</code>
739
+ * </p>
740
+ * </li>
741
+ * </ul>
742
+ * <note>
743
+ * <p>Not all resource types can be shared with IAM roles and users.
744
+ * For more information, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types">Sharing with IAM roles and users</a> in the <i>Resource Access Manager User
745
+ * Guide</i>.</p>
746
+ * </note>
688
747
  */
689
748
  principals?: string[];
690
749
  /**
691
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
750
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
751
+ * ensure the idempotency of the request. This lets you safely retry the request without
752
+ * accidentally performing the same operation a second time. Passing the same value to a
753
+ * later call to an operation requires that you also pass the same value for all other
754
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
755
+ * value.</a>.</p>
756
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
757
+ * you.</p>
692
758
  */
693
759
  clientToken?: string;
694
760
  }
@@ -700,11 +766,15 @@ export declare namespace DisassociateResourceShareRequest {
700
766
  }
701
767
  export interface DisassociateResourceShareResponse {
702
768
  /**
703
- * <p>Information about the associations.</p>
769
+ * <p>An array of objects that contain information about the updated associations for this
770
+ * resource share.</p>
704
771
  */
705
772
  resourceShareAssociations?: ResourceShareAssociation[];
706
773
  /**
707
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
774
+ * <p>The idempotency identifier associated with this request. If you
775
+ * want to repeat the same operation in an idempotent manner then you must include this
776
+ * value in the <code>clientToken</code> request parameter of that later call. All other
777
+ * parameters must also have the same values that you used in the first call.</p>
708
778
  */
709
779
  clientToken?: string;
710
780
  }
@@ -716,15 +786,23 @@ export declare namespace DisassociateResourceShareResponse {
716
786
  }
717
787
  export interface DisassociateResourceSharePermissionRequest {
718
788
  /**
719
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
789
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share from which you want to disassociate a permission.</p>
720
790
  */
721
791
  resourceShareArn: string | undefined;
722
792
  /**
723
- * <p>The Amazon Resource Name (ARN) of the permission to disassociate from the resource share.</p>
793
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the permission to disassociate from the resource share. Changes to permissions
794
+ * take effect immediately.</p>
724
795
  */
725
796
  permissionArn: string | undefined;
726
797
  /**
727
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
798
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
799
+ * ensure the idempotency of the request. This lets you safely retry the request without
800
+ * accidentally performing the same operation a second time. Passing the same value to a
801
+ * later call to an operation requires that you also pass the same value for all other
802
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
803
+ * value.</a>.</p>
804
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
805
+ * you.</p>
728
806
  */
729
807
  clientToken?: string;
730
808
  }
@@ -736,11 +814,15 @@ export declare namespace DisassociateResourceSharePermissionRequest {
736
814
  }
737
815
  export interface DisassociateResourceSharePermissionResponse {
738
816
  /**
739
- * <p>Indicates whether the request succeeded.</p>
817
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
818
+ * A value of <code>false</code> indicates that the request failed.</p>
740
819
  */
741
820
  returnValue?: boolean;
742
821
  /**
743
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
822
+ * <p>The idempotency identifier associated with this request. If you
823
+ * want to repeat the same operation in an idempotent manner then you must include this
824
+ * value in the <code>clientToken</code> request parameter of that later call. All other
825
+ * parameters must also have the same values that you used in the first call.</p>
744
826
  */
745
827
  clientToken?: string;
746
828
  }
@@ -760,7 +842,8 @@ export declare namespace EnableSharingWithAwsOrganizationRequest {
760
842
  }
761
843
  export interface EnableSharingWithAwsOrganizationResponse {
762
844
  /**
763
- * <p>Indicates whether the request succeeded.</p>
845
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
846
+ * A value of <code>false</code> indicates that the request failed.</p>
764
847
  */
765
848
  returnValue?: boolean;
766
849
  }
@@ -772,11 +855,14 @@ export declare namespace EnableSharingWithAwsOrganizationResponse {
772
855
  }
773
856
  export interface GetPermissionRequest {
774
857
  /**
775
- * <p>The Amazon Resource Name (ARN) of the permission.</p>
858
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the permission whose contents you want to retrieve.
859
+ * To find the ARN for a permission, use either the <a>ListPermissions</a> operation or go to the <a href="https://console.aws.amazon.com/ram/home#Permissions:">Permissions library</a> page in the RAM console and
860
+ * then choose the name of the permission. The ARN is displayed on the detail page.</p>
776
861
  */
777
862
  permissionArn: string | undefined;
778
863
  /**
779
- * <p>The identifier for the version of the permission.</p>
864
+ * <p>Specifies identifier for the version of the RAM permission to retrieve. If you don't
865
+ * specify this parameter, the operation retrieves the default version.</p>
780
866
  */
781
867
  permissionVersion?: number;
782
868
  }
@@ -791,30 +877,30 @@ export declare namespace GetPermissionRequest {
791
877
  */
792
878
  export interface ResourceSharePermissionDetail {
793
879
  /**
794
- * <p>The Amazon Resource Name (ARN) of the permission.</p>
880
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of this RAM permission.</p>
795
881
  */
796
882
  arn?: string;
797
883
  /**
798
- * <p>The identifier for the version of the permission.</p>
884
+ * <p>The version of the permission represented in this structure.</p>
799
885
  */
800
886
  version?: string;
801
887
  /**
802
- * <p>Specifies whether the version of the permission is set to the default version for this
803
- * permission.</p>
888
+ * <p>Specifies whether the version of the permission represented in this structure is the
889
+ * default version for this permission.</p>
804
890
  */
805
891
  defaultVersion?: boolean;
806
892
  /**
807
- * <p>The name of the permission.</p>
893
+ * <p>The name of this permission.</p>
808
894
  */
809
895
  name?: string;
810
896
  /**
811
- * <p>The resource type to which the permission applies.</p>
897
+ * <p>The resource type to which this permission applies.</p>
812
898
  */
813
899
  resourceType?: string;
814
900
  /**
815
901
  * <p>The permission's effect and actions in JSON format. The <code>effect</code> indicates
816
- * whether the actions are allowed or denied. The <code>actions</code> list the API actions
817
- * to which the principal is granted or denied access.</p>
902
+ * whether the specified actions are allowed or denied. The <code>actions</code> list the
903
+ * operations to which the principal is granted or denied access.</p>
818
904
  */
819
905
  permission?: string;
820
906
  /**
@@ -826,8 +912,8 @@ export interface ResourceSharePermissionDetail {
826
912
  */
827
913
  lastUpdatedTime?: Date;
828
914
  /**
829
- * <p>Specifies whether the version of the permission is set to the default version for this
830
- * resource type.</p>
915
+ * <p>Specifies whether the version of the permission represented in this structure is the
916
+ * default version for all resources of this resource type.</p>
831
917
  */
832
918
  isResourceTypeDefault?: boolean;
833
919
  }
@@ -839,7 +925,7 @@ export declare namespace ResourceSharePermissionDetail {
839
925
  }
840
926
  export interface GetPermissionResponse {
841
927
  /**
842
- * <p>Information about the permission.</p>
928
+ * <p>An object that contains information about the permission.</p>
843
929
  */
844
930
  permission?: ResourceSharePermissionDetail;
845
931
  }
@@ -851,20 +937,31 @@ export declare namespace GetPermissionResponse {
851
937
  }
852
938
  export interface GetResourcePoliciesRequest {
853
939
  /**
854
- * <p>The Amazon Resource Names (ARNs) of the resources.</p>
940
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resources whose policies you want to retrieve.</p>
855
941
  */
856
942
  resourceArns: string[] | undefined;
857
943
  /**
858
- * <p>The principal.</p>
944
+ * <p>Specifies the principal.</p>
859
945
  */
860
946
  principal?: string;
861
947
  /**
862
- * <p>The token for the next page of results.</p>
948
+ * <p>Specifies that you want to receive the next page of results. Valid
949
+ * only if you received a <code>NextToken</code> response in the previous request. If you
950
+ * did, it indicates that more output is available. Set this parameter to the value
951
+ * provided by the previous call's <code>NextToken</code> response to request the
952
+ * next page of results.</p>
863
953
  */
864
954
  nextToken?: string;
865
955
  /**
866
- * <p>The maximum number of results to return with a single call.
867
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
956
+ * <p>Specifies the total number of results that you want included on each page
957
+ * of the response. If you do not include this parameter, it defaults to a value that is
958
+ * specific to the operation. If additional items exist beyond the number you specify, the
959
+ * <code>NextToken</code> response element is returned with a value (not null).
960
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
961
+ * call to the operation to get the next part of the results. Note that the service might
962
+ * return fewer results than the maximum even when there are more results available. You
963
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
964
+ * of the results.</p>
868
965
  */
869
966
  maxResults?: number;
870
967
  }
@@ -876,11 +973,15 @@ export declare namespace GetResourcePoliciesRequest {
876
973
  }
877
974
  export interface GetResourcePoliciesResponse {
878
975
  /**
879
- * <p>A key policy document, in JSON format.</p>
976
+ * <p>An array of resource policy documents in JSON format.</p>
880
977
  */
881
978
  policies?: string[];
882
979
  /**
883
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
980
+ * <p>If present, this value indicates that more output is available than
981
+ * is included in the current response. Use this value in the <code>NextToken</code>
982
+ * request parameter in a subsequent call to the operation to get the next part of the
983
+ * output. You should repeat this until the <code>NextToken</code> response element comes
984
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
884
985
  */
885
986
  nextToken?: string;
886
987
  }
@@ -891,65 +992,80 @@ export declare namespace GetResourcePoliciesResponse {
891
992
  const filterSensitiveLog: (obj: GetResourcePoliciesResponse) => any;
892
993
  }
893
994
  /**
894
- * <p>The specified value for NextToken is not valid.</p>
995
+ * <p>The specified value for <code>NextToken</code> is not valid.</p>
895
996
  */
896
997
  export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
897
998
  name: "InvalidNextTokenException";
898
999
  $fault: "client";
899
1000
  message: string | undefined;
900
1001
  }
901
- export declare namespace InvalidNextTokenException {
902
- /**
903
- * @internal
904
- */
905
- const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
906
- }
907
1002
  /**
908
- * <p>An Amazon Resource Name (ARN) was not found.</p>
1003
+ * <p>The specified Amazon Resource Name (ARN) was not found.</p>
909
1004
  */
910
1005
  export interface ResourceArnNotFoundException extends __SmithyException, $MetadataBearer {
911
1006
  name: "ResourceArnNotFoundException";
912
1007
  $fault: "client";
913
1008
  message: string | undefined;
914
1009
  }
915
- export declare namespace ResourceArnNotFoundException {
916
- /**
917
- * @internal
918
- */
919
- const filterSensitiveLog: (obj: ResourceArnNotFoundException) => any;
920
- }
921
1010
  export interface GetResourceShareAssociationsRequest {
922
1011
  /**
923
- * <p>The association type. Specify <code>PRINCIPAL</code> to list the principals that are
924
- * associated with the specified resource share. Specify <code>RESOURCE</code> to list the resources
925
- * that are associated with the specified resource share.</p>
1012
+ * <p>Specifies whether you want to retrieve the associations that involve a specified
1013
+ * resource or principal.</p>
1014
+ * <ul>
1015
+ * <li>
1016
+ * <p>
1017
+ * <code>PRINCIPAL</code> – list the principals that are associated with
1018
+ * the specified resource share.</p>
1019
+ * </li>
1020
+ * <li>
1021
+ * <p>
1022
+ * <code>RESOURCE</code> – list the resources that are associated with the
1023
+ * specified resource share.</p>
1024
+ * </li>
1025
+ * </ul>
926
1026
  */
927
1027
  associationType: ResourceShareAssociationType | string | undefined;
928
1028
  /**
929
- * <p>The Amazon Resource Names (ARN) of the resource shares.</p>
1029
+ * <p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resource share whose associations you want to
1030
+ * retrieve.</p>
930
1031
  */
931
1032
  resourceShareArns?: string[];
932
1033
  /**
933
- * <p>The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if
934
- * the association type is <code>PRINCIPAL</code>.</p>
1034
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource whose resource shares you want to retrieve.</p>
1035
+ * <p>You cannot specify this parameter if the association type is
1036
+ * <code>PRINCIPAL</code>.</p>
935
1037
  */
936
1038
  resourceArn?: string;
937
1039
  /**
938
- * <p>The principal. You cannot specify this parameter if the association type is
939
- * <code>RESOURCE</code>.</p>
1040
+ * <p>Specifies the ID of the principal whose resource shares you want to retrieve. This can be an
1041
+ * Amazon Web Services account ID, an organization ID, an organizational unit ID, or the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of an
1042
+ * individual IAM user or role.</p>
1043
+ * <p>You cannot specify this parameter if the association type is
1044
+ * <code>RESOURCE</code>.</p>
940
1045
  */
941
1046
  principal?: string;
942
1047
  /**
943
- * <p>The association status.</p>
1048
+ * <p>Specifies that you want to retrieve only associations with this status.</p>
944
1049
  */
945
1050
  associationStatus?: ResourceShareAssociationStatus | string;
946
1051
  /**
947
- * <p>The token for the next page of results.</p>
1052
+ * <p>Specifies that you want to receive the next page of results. Valid
1053
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1054
+ * did, it indicates that more output is available. Set this parameter to the value
1055
+ * provided by the previous call's <code>NextToken</code> response to request the
1056
+ * next page of results.</p>
948
1057
  */
949
1058
  nextToken?: string;
950
1059
  /**
951
- * <p>The maximum number of results to return with a single call.
952
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1060
+ * <p>Specifies the total number of results that you want included on each page
1061
+ * of the response. If you do not include this parameter, it defaults to a value that is
1062
+ * specific to the operation. If additional items exist beyond the number you specify, the
1063
+ * <code>NextToken</code> response element is returned with a value (not null).
1064
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1065
+ * call to the operation to get the next part of the results. Note that the service might
1066
+ * return fewer results than the maximum even when there are more results available. You
1067
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1068
+ * of the results.</p>
953
1069
  */
954
1070
  maxResults?: number;
955
1071
  }
@@ -961,11 +1077,15 @@ export declare namespace GetResourceShareAssociationsRequest {
961
1077
  }
962
1078
  export interface GetResourceShareAssociationsResponse {
963
1079
  /**
964
- * <p>Information about the associations.</p>
1080
+ * <p>An array of objects that contain the details about the associations.</p>
965
1081
  */
966
1082
  resourceShareAssociations?: ResourceShareAssociation[];
967
1083
  /**
968
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1084
+ * <p>If present, this value indicates that more output is available than
1085
+ * is included in the current response. Use this value in the <code>NextToken</code>
1086
+ * request parameter in a subsequent call to the operation to get the next part of the
1087
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1088
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
969
1089
  */
970
1090
  nextToken?: string;
971
1091
  }
@@ -977,20 +1097,33 @@ export declare namespace GetResourceShareAssociationsResponse {
977
1097
  }
978
1098
  export interface GetResourceShareInvitationsRequest {
979
1099
  /**
980
- * <p>The Amazon Resource Names (ARN) of the invitations.</p>
1100
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resource share invitations you want information about.</p>
981
1101
  */
982
1102
  resourceShareInvitationArns?: string[];
983
1103
  /**
984
- * <p>The Amazon Resource Names (ARN) of the resource shares.</p>
1104
+ * <p>Specifies that you want details about invitations only for the resource shares described by this
1105
+ * list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
1106
+ * </p>
985
1107
  */
986
1108
  resourceShareArns?: string[];
987
1109
  /**
988
- * <p>The token for the next page of results.</p>
1110
+ * <p>Specifies that you want to receive the next page of results. Valid
1111
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1112
+ * did, it indicates that more output is available. Set this parameter to the value
1113
+ * provided by the previous call's <code>NextToken</code> response to request the
1114
+ * next page of results.</p>
989
1115
  */
990
1116
  nextToken?: string;
991
1117
  /**
992
- * <p>The maximum number of results to return with a single call.
993
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1118
+ * <p>Specifies the total number of results that you want included on each page
1119
+ * of the response. If you do not include this parameter, it defaults to a value that is
1120
+ * specific to the operation. If additional items exist beyond the number you specify, the
1121
+ * <code>NextToken</code> response element is returned with a value (not null).
1122
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1123
+ * call to the operation to get the next part of the results. Note that the service might
1124
+ * return fewer results than the maximum even when there are more results available. You
1125
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1126
+ * of the results.</p>
994
1127
  */
995
1128
  maxResults?: number;
996
1129
  }
@@ -1002,11 +1135,15 @@ export declare namespace GetResourceShareInvitationsRequest {
1002
1135
  }
1003
1136
  export interface GetResourceShareInvitationsResponse {
1004
1137
  /**
1005
- * <p>Information about the invitations.</p>
1138
+ * <p>An array of objects that contain the details about the invitations.</p>
1006
1139
  */
1007
1140
  resourceShareInvitations?: ResourceShareInvitation[];
1008
1141
  /**
1009
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1142
+ * <p>If present, this value indicates that more output is available than
1143
+ * is included in the current response. Use this value in the <code>NextToken</code>
1144
+ * request parameter in a subsequent call to the operation to get the next part of the
1145
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1146
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1010
1147
  */
1011
1148
  nextToken?: string;
1012
1149
  }
@@ -1017,33 +1154,29 @@ export declare namespace GetResourceShareInvitationsResponse {
1017
1154
  const filterSensitiveLog: (obj: GetResourceShareInvitationsResponse) => any;
1018
1155
  }
1019
1156
  /**
1020
- * <p>The specified value for MaxResults is not valid.</p>
1157
+ * <p>The specified value for <code>MaxResults</code> is not valid.</p>
1021
1158
  */
1022
1159
  export interface InvalidMaxResultsException extends __SmithyException, $MetadataBearer {
1023
1160
  name: "InvalidMaxResultsException";
1024
1161
  $fault: "client";
1025
1162
  message: string | undefined;
1026
1163
  }
1027
- export declare namespace InvalidMaxResultsException {
1028
- /**
1029
- * @internal
1030
- */
1031
- const filterSensitiveLog: (obj: InvalidMaxResultsException) => any;
1032
- }
1033
1164
  export declare enum ResourceOwner {
1034
1165
  OTHER_ACCOUNTS = "OTHER-ACCOUNTS",
1035
1166
  SELF = "SELF"
1036
1167
  }
1037
1168
  /**
1038
- * <p>Used to filter information based on tags.</p>
1169
+ * <p>A tag key and optional list of possible values that you can use to filter results for
1170
+ * tagged resources.</p>
1039
1171
  */
1040
1172
  export interface TagFilter {
1041
1173
  /**
1042
- * <p>The tag key.</p>
1174
+ * <p>The tag key. This must have a valid string value and can't be empty.</p>
1043
1175
  */
1044
1176
  tagKey?: string;
1045
1177
  /**
1046
- * <p>The tag values.</p>
1178
+ * <p>A list of zero or more tag values. If no values are provided, then the filter matches
1179
+ * any tag with the specified key, regardless of its value.</p>
1047
1180
  */
1048
1181
  tagValues?: string[];
1049
1182
  }
@@ -1055,37 +1188,68 @@ export declare namespace TagFilter {
1055
1188
  }
1056
1189
  export interface GetResourceSharesRequest {
1057
1190
  /**
1058
- * <p>The Amazon Resource Names (ARNs) of the resource shares.</p>
1191
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of individual resource shares that you want information about.</p>
1059
1192
  */
1060
1193
  resourceShareArns?: string[];
1061
1194
  /**
1062
- * <p>The status of the resource share.</p>
1195
+ * <p>Specifies that you want to retrieve details of only those resource shares that have this
1196
+ * status.</p>
1063
1197
  */
1064
1198
  resourceShareStatus?: ResourceShareStatus | string;
1065
1199
  /**
1066
- * <p>The type of owner.</p>
1200
+ * <p>Specifies that you want to retrieve details of only those resource shares that match the
1201
+ * following:</p>
1202
+ * <ul>
1203
+ * <li>
1204
+ * <p>
1205
+ * <b>
1206
+ * <code>SELF</code>
1207
+ * </b> – resources that you
1208
+ * are sharing</p>
1209
+ * </li>
1210
+ * <li>
1211
+ * <p>
1212
+ * <b>
1213
+ * <code>OTHER-ACCOUNTS</code>
1214
+ * </b> –
1215
+ * resources that other accounts share with you</p>
1216
+ * </li>
1217
+ * </ul>
1067
1218
  */
1068
1219
  resourceOwner: ResourceOwner | string | undefined;
1069
1220
  /**
1070
- * <p>The name of the resource share.</p>
1221
+ * <p>Specifies the name of an individual resource share that you want to retrieve details
1222
+ * about.</p>
1071
1223
  */
1072
1224
  name?: string;
1073
1225
  /**
1074
- * <p>One or more tag filters.</p>
1226
+ * <p>Specifies that you want to retrieve details of only those resource shares that match the
1227
+ * specified tag keys and values.</p>
1075
1228
  */
1076
1229
  tagFilters?: TagFilter[];
1077
1230
  /**
1078
- * <p>The token for the next page of results.</p>
1231
+ * <p>Specifies that you want to receive the next page of results. Valid
1232
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1233
+ * did, it indicates that more output is available. Set this parameter to the value
1234
+ * provided by the previous call's <code>NextToken</code> response to request the
1235
+ * next page of results.</p>
1079
1236
  */
1080
1237
  nextToken?: string;
1081
1238
  /**
1082
- * <p>The maximum number of results to return with a single call.
1083
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1239
+ * <p>Specifies the total number of results that you want included on each page
1240
+ * of the response. If you do not include this parameter, it defaults to a value that is
1241
+ * specific to the operation. If additional items exist beyond the number you specify, the
1242
+ * <code>NextToken</code> response element is returned with a value (not null).
1243
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1244
+ * call to the operation to get the next part of the results. Note that the service might
1245
+ * return fewer results than the maximum even when there are more results available. You
1246
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1247
+ * of the results.</p>
1084
1248
  */
1085
1249
  maxResults?: number;
1086
1250
  /**
1087
- * <p>The Amazon Resource Name (ARN) of the RAM permission that is associated with the
1088
- * resource share.</p>
1251
+ * <p>Specifies that you want to retrieve details of only those resource shares that use the RAM
1252
+ * permission with this <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a>.</p>
1089
1253
  */
1090
1254
  permissionArn?: string;
1091
1255
  }
@@ -1097,11 +1261,15 @@ export declare namespace GetResourceSharesRequest {
1097
1261
  }
1098
1262
  export interface GetResourceSharesResponse {
1099
1263
  /**
1100
- * <p>Information about the resource shares.</p>
1264
+ * <p>An array of objects that contain the information about the resource shares.</p>
1101
1265
  */
1102
1266
  resourceShares?: ResourceShare[];
1103
1267
  /**
1104
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1268
+ * <p>If present, this value indicates that more output is available than
1269
+ * is included in the current response. Use this value in the <code>NextToken</code>
1270
+ * request parameter in a subsequent call to the operation to get the next part of the
1271
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1272
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1105
1273
  */
1106
1274
  nextToken?: string;
1107
1275
  }
@@ -1111,20 +1279,59 @@ export declare namespace GetResourceSharesResponse {
1111
1279
  */
1112
1280
  const filterSensitiveLog: (obj: GetResourceSharesResponse) => any;
1113
1281
  }
1282
+ export declare enum ResourceRegionScopeFilter {
1283
+ ALL = "ALL",
1284
+ GLOBAL = "GLOBAL",
1285
+ REGIONAL = "REGIONAL"
1286
+ }
1114
1287
  export interface ListPendingInvitationResourcesRequest {
1115
1288
  /**
1116
- * <p>The Amazon Resource Name (ARN) of the invitation.</p>
1289
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the invitation. You can use <a>GetResourceShareInvitations</a> to find the ARN of the invitation.</p>
1117
1290
  */
1118
1291
  resourceShareInvitationArn: string | undefined;
1119
1292
  /**
1120
- * <p>The token for the next page of results.</p>
1293
+ * <p>Specifies that you want to receive the next page of results. Valid
1294
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1295
+ * did, it indicates that more output is available. Set this parameter to the value
1296
+ * provided by the previous call's <code>NextToken</code> response to request the
1297
+ * next page of results.</p>
1121
1298
  */
1122
1299
  nextToken?: string;
1123
1300
  /**
1124
- * <p>The maximum number of results to return with a single call.
1125
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1301
+ * <p>Specifies the total number of results that you want included on each page
1302
+ * of the response. If you do not include this parameter, it defaults to a value that is
1303
+ * specific to the operation. If additional items exist beyond the number you specify, the
1304
+ * <code>NextToken</code> response element is returned with a value (not null).
1305
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1306
+ * call to the operation to get the next part of the results. Note that the service might
1307
+ * return fewer results than the maximum even when there are more results available. You
1308
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1309
+ * of the results.</p>
1126
1310
  */
1127
1311
  maxResults?: number;
1312
+ /**
1313
+ * <p>Specifies that you want the results to include only
1314
+ * resources that have the specified scope.</p>
1315
+ * <ul>
1316
+ * <li>
1317
+ * <p>
1318
+ * <code>ALL</code> – the results include both global and
1319
+ * regional resources or resource types.</p>
1320
+ * </li>
1321
+ * <li>
1322
+ * <p>
1323
+ * <code>GLOBAL</code> – the results include only global
1324
+ * resources or resource types.</p>
1325
+ * </li>
1326
+ * <li>
1327
+ * <p>
1328
+ * <code>REGIONAL</code> – the results include only regional
1329
+ * resources or resource types.</p>
1330
+ * </li>
1331
+ * </ul>
1332
+ * <p>The default value is <code>ALL</code>.</p>
1333
+ */
1334
+ resourceRegionScope?: ResourceRegionScopeFilter | string;
1128
1335
  }
1129
1336
  export declare namespace ListPendingInvitationResourcesRequest {
1130
1337
  /**
@@ -1132,30 +1339,36 @@ export declare namespace ListPendingInvitationResourcesRequest {
1132
1339
  */
1133
1340
  const filterSensitiveLog: (obj: ListPendingInvitationResourcesRequest) => any;
1134
1341
  }
1342
+ export declare enum ResourceRegionScope {
1343
+ GLOBAL = "GLOBAL",
1344
+ REGIONAL = "REGIONAL"
1345
+ }
1135
1346
  export declare type ResourceStatus = "AVAILABLE" | "LIMIT_EXCEEDED" | "PENDING" | "UNAVAILABLE" | "ZONAL_RESOURCE_INACCESSIBLE";
1136
1347
  /**
1137
- * <p>Describes a resource associated with a resource share.</p>
1348
+ * <p>Describes a resource associated with a resource share in RAM.</p>
1138
1349
  */
1139
1350
  export interface Resource {
1140
1351
  /**
1141
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
1352
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource.</p>
1142
1353
  */
1143
1354
  arn?: string;
1144
1355
  /**
1145
- * <p>The resource type.</p>
1356
+ * <p>The resource type. This takes the form of:
1357
+ * <code>service-code</code>:<code>resource-code</code>
1358
+ * </p>
1146
1359
  */
1147
1360
  type?: string;
1148
1361
  /**
1149
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
1362
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share this resource is associated with.</p>
1150
1363
  */
1151
1364
  resourceShareArn?: string;
1152
1365
  /**
1153
- * <p>The Amazon Resource Name (ARN) of the resource group. This value is returned only if
1154
- * the resource is a resource group.</p>
1366
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource group. This value is available only if the resource is
1367
+ * part of a resource group.</p>
1155
1368
  */
1156
1369
  resourceGroupArn?: string;
1157
1370
  /**
1158
- * <p>The status of the resource.</p>
1371
+ * <p>The current status of the resource.</p>
1159
1372
  */
1160
1373
  status?: ResourceStatus | string;
1161
1374
  /**
@@ -1163,13 +1376,30 @@ export interface Resource {
1163
1376
  */
1164
1377
  statusMessage?: string;
1165
1378
  /**
1166
- * <p>The time when the resource was associated with the resource share.</p>
1379
+ * <p>The date and time when the resource was associated with the resource share.</p>
1167
1380
  */
1168
1381
  creationTime?: Date;
1169
1382
  /**
1170
- * <p>The time when the association was last updated.</p>
1383
+ * <p>The date an time when the association was last updated.</p>
1171
1384
  */
1172
1385
  lastUpdatedTime?: Date;
1386
+ /**
1387
+ * <p>Specifies the scope of visibility of this resource:</p>
1388
+ * <ul>
1389
+ * <li>
1390
+ * <p>
1391
+ * <b>REGIONAL</b> – The resource can be
1392
+ * accessed only by using requests that target the Amazon Web Services Region in which the
1393
+ * resource exists.</p>
1394
+ * </li>
1395
+ * <li>
1396
+ * <p>
1397
+ * <b>GLOBAL</b> – The resource can be accessed
1398
+ * from any Amazon Web Services Region.</p>
1399
+ * </li>
1400
+ * </ul>
1401
+ */
1402
+ resourceRegionScope?: ResourceRegionScope | string;
1173
1403
  }
1174
1404
  export declare namespace Resource {
1175
1405
  /**
@@ -1179,11 +1409,16 @@ export declare namespace Resource {
1179
1409
  }
1180
1410
  export interface ListPendingInvitationResourcesResponse {
1181
1411
  /**
1182
- * <p>Information about the resources included the resource share.</p>
1412
+ * <p>An array of objects that contain the information about the resources included the
1413
+ * specified resource share.</p>
1183
1414
  */
1184
1415
  resources?: Resource[];
1185
1416
  /**
1186
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1417
+ * <p>If present, this value indicates that more output is available than
1418
+ * is included in the current response. Use this value in the <code>NextToken</code>
1419
+ * request parameter in a subsequent call to the operation to get the next part of the
1420
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1421
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1187
1422
  */
1188
1423
  nextToken?: string;
1189
1424
  }
@@ -1201,25 +1436,32 @@ export interface MissingRequiredParameterException extends __SmithyException, $M
1201
1436
  $fault: "client";
1202
1437
  message: string | undefined;
1203
1438
  }
1204
- export declare namespace MissingRequiredParameterException {
1205
- /**
1206
- * @internal
1207
- */
1208
- const filterSensitiveLog: (obj: MissingRequiredParameterException) => any;
1209
- }
1210
1439
  export interface ListPermissionsRequest {
1211
1440
  /**
1212
- * <p>Specifies the resource type for which to list permissions. For example, to list only
1213
- * permissions that apply to EC2 subnets, specify <code>ec2:Subnet</code>.</p>
1441
+ * <p>Specifies that you want to list permissions for only the specified resource type. For
1442
+ * example, to list only permissions that apply to EC2 subnets, specify
1443
+ * <code>ec2:Subnet</code>. You can use the <a>ListResourceTypes</a>
1444
+ * operation to get the specific string required.</p>
1214
1445
  */
1215
1446
  resourceType?: string;
1216
1447
  /**
1217
- * <p>The token for the next page of results.</p>
1448
+ * <p>Specifies that you want to receive the next page of results. Valid
1449
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1450
+ * did, it indicates that more output is available. Set this parameter to the value
1451
+ * provided by the previous call's <code>NextToken</code> response to request the
1452
+ * next page of results.</p>
1218
1453
  */
1219
1454
  nextToken?: string;
1220
1455
  /**
1221
- * <p>The maximum number of results to return with a single call.
1222
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1456
+ * <p>Specifies the total number of results that you want included on each page
1457
+ * of the response. If you do not include this parameter, it defaults to a value that is
1458
+ * specific to the operation. If additional items exist beyond the number you specify, the
1459
+ * <code>NextToken</code> response element is returned with a value (not null).
1460
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1461
+ * call to the operation to get the next part of the results. Note that the service might
1462
+ * return fewer results than the maximum even when there are more results available. You
1463
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1464
+ * of the results.</p>
1223
1465
  */
1224
1466
  maxResults?: number;
1225
1467
  }
@@ -1230,28 +1472,29 @@ export declare namespace ListPermissionsRequest {
1230
1472
  const filterSensitiveLog: (obj: ListPermissionsRequest) => any;
1231
1473
  }
1232
1474
  /**
1233
- * <p>Information about a permission that is associated with a resource share.</p>
1475
+ * <p>Information about an RAM permission that is associated with a resource share and any of its
1476
+ * resources of a specified type.</p>
1234
1477
  */
1235
1478
  export interface ResourceSharePermissionSummary {
1236
1479
  /**
1237
- * <p>The Amazon Resource Name (ARN) of the permission.</p>
1480
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the permission you want information about.</p>
1238
1481
  */
1239
1482
  arn?: string;
1240
1483
  /**
1241
- * <p>The identifier for the version of the permission.</p>
1484
+ * <p>The version of the permission represented in this structure.</p>
1242
1485
  */
1243
1486
  version?: string;
1244
1487
  /**
1245
- * <p>Specifies whether the version of the permission is set to the default version for this
1246
- * permission.</p>
1488
+ * <p>Specifies whether the version of the permission represented in this structure is the
1489
+ * default version for this permission.</p>
1247
1490
  */
1248
1491
  defaultVersion?: boolean;
1249
1492
  /**
1250
- * <p>The name of the permission.</p>
1493
+ * <p>The name of this permission.</p>
1251
1494
  */
1252
1495
  name?: string;
1253
1496
  /**
1254
- * <p>The type of resource to which the permission applies.</p>
1497
+ * <p>The type of resource to which this permission applies.</p>
1255
1498
  */
1256
1499
  resourceType?: string;
1257
1500
  /**
@@ -1267,8 +1510,8 @@ export interface ResourceSharePermissionSummary {
1267
1510
  */
1268
1511
  lastUpdatedTime?: Date;
1269
1512
  /**
1270
- * <p>Specifies whether the version of the permission is set to the default version for this
1271
- * resource type.</p>
1513
+ * <p>Specifies whether the version of the permission represented in this structure is the
1514
+ * default version for all resources of this resource type.</p>
1272
1515
  */
1273
1516
  isResourceTypeDefault?: boolean;
1274
1517
  }
@@ -1280,11 +1523,15 @@ export declare namespace ResourceSharePermissionSummary {
1280
1523
  }
1281
1524
  export interface ListPermissionsResponse {
1282
1525
  /**
1283
- * <p>Information about the permissions.</p>
1526
+ * <p>An array of objects with information about the permissions.</p>
1284
1527
  */
1285
1528
  permissions?: ResourceSharePermissionSummary[];
1286
1529
  /**
1287
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1530
+ * <p>If present, this value indicates that more output is available than
1531
+ * is included in the current response. Use this value in the <code>NextToken</code>
1532
+ * request parameter in a subsequent call to the operation to get the next part of the
1533
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1534
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1288
1535
  */
1289
1536
  nextToken?: string;
1290
1537
  }
@@ -1296,34 +1543,96 @@ export declare namespace ListPermissionsResponse {
1296
1543
  }
1297
1544
  export interface ListPrincipalsRequest {
1298
1545
  /**
1299
- * <p>The type of owner.</p>
1546
+ * <p>Specifies that you want to list information for only resource shares that match the
1547
+ * following:</p>
1548
+ * <ul>
1549
+ * <li>
1550
+ * <p>
1551
+ * <b>
1552
+ * <code>SELF</code>
1553
+ * </b> – resources that you
1554
+ * are sharing</p>
1555
+ * </li>
1556
+ * <li>
1557
+ * <p>
1558
+ * <b>
1559
+ * <code>OTHER-ACCOUNTS</code>
1560
+ * </b> –
1561
+ * resources that other accounts share with you</p>
1562
+ * </li>
1563
+ * </ul>
1300
1564
  */
1301
1565
  resourceOwner: ResourceOwner | string | undefined;
1302
1566
  /**
1303
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
1567
+ * <p>Specifies that you want to list principal information for the resource share with the specified
1568
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a>.</p>
1304
1569
  */
1305
1570
  resourceArn?: string;
1306
1571
  /**
1307
- * <p>The principals.</p>
1572
+ * <p>Specifies that you want to list information for only the listed principals.</p>
1573
+ * <p>You can include the following values:</p>
1574
+ * <ul>
1575
+ * <li>
1576
+ * <p>An Amazon Web Services account ID, for example: <code>123456789012</code>
1577
+ * </p>
1578
+ * </li>
1579
+ * <li>
1580
+ * <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of an organization in Organizations, for example:
1581
+ * <code>organizations::123456789012:organization/o-exampleorgid</code>
1582
+ * </p>
1583
+ * </li>
1584
+ * <li>
1585
+ * <p>An ARN of an organizational unit (OU) in Organizations, for example:
1586
+ * <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code>
1587
+ * </p>
1588
+ * </li>
1589
+ * <li>
1590
+ * <p>An ARN of an IAM role, for example:
1591
+ * <code>iam::123456789012:role/rolename</code>
1592
+ * </p>
1593
+ * </li>
1594
+ * <li>
1595
+ * <p>An ARN of an IAM user, for example:
1596
+ * <code>iam::123456789012user/username</code>
1597
+ * </p>
1598
+ * </li>
1599
+ * </ul>
1600
+ * <note>
1601
+ * <p>Not all resource types can be shared with IAM roles and users.
1602
+ * For more information, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types">Sharing with IAM roles and users</a> in the <i>Resource Access Manager User
1603
+ * Guide</i>.</p>
1604
+ * </note>
1308
1605
  */
1309
1606
  principals?: string[];
1310
1607
  /**
1311
- * <p>The resource type.</p>
1312
- * <p>Valid values: <code>acm-pca:CertificateAuthority</code> | <code>appmesh:Mesh</code> | <code>codebuild:Project</code> | <code>codebuild:ReportGroup</code> | <code>ec2:CapacityReservation</code> | <code>ec2:DedicatedHost</code> | <code>ec2:LocalGatewayRouteTable</code> | <code>ec2:PrefixList</code> | <code>ec2:Subnet</code> | <code>ec2:TrafficMirrorTarget</code> | <code>ec2:TransitGateway</code> | <code>imagebuilder:Component</code> | <code>imagebuilder:Image</code> | <code>imagebuilder:ImageRecipe</code> | <code>imagebuilder:ContainerRecipe</code> | <code>glue:Catalog</code> | <code>glue:Database</code> | <code>glue:Table</code> | <code>license-manager:LicenseConfiguration</code> I <code>network-firewall:FirewallPolicy</code> | <code>network-firewall:StatefulRuleGroup</code> | <code>network-firewall:StatelessRuleGroup</code> | <code>outposts:Outpost</code> | <code>resource-groups:Group</code> | <code>rds:Cluster</code> | <code>route53resolver:FirewallRuleGroup</code> |<code>route53resolver:ResolverQueryLogConfig</code> | <code>route53resolver:ResolverRule</code> | <code>s3-outposts:Outpost</code> | <code>ssm-contacts:Contact</code> | <code>ssm-incidents:ResponsePlan</code>
1313
- * </p>
1608
+ * <p>Specifies that you want to list information for only principals associated with resource shares
1609
+ * that include the specified resource type.</p>
1610
+ * <p>For a list of valid values, query the <a>ListResourceTypes</a> operation.</p>
1314
1611
  */
1315
1612
  resourceType?: string;
1316
1613
  /**
1317
- * <p>The Amazon Resource Names (ARN) of the resource shares.</p>
1614
+ * <p>Specifies that you want to list information for only principals associated with the
1615
+ * resource shares specified by a list the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
1318
1616
  */
1319
1617
  resourceShareArns?: string[];
1320
1618
  /**
1321
- * <p>The token for the next page of results.</p>
1619
+ * <p>Specifies that you want to receive the next page of results. Valid
1620
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1621
+ * did, it indicates that more output is available. Set this parameter to the value
1622
+ * provided by the previous call's <code>NextToken</code> response to request the
1623
+ * next page of results.</p>
1322
1624
  */
1323
1625
  nextToken?: string;
1324
1626
  /**
1325
- * <p>The maximum number of results to return with a single call.
1326
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1627
+ * <p>Specifies the total number of results that you want included on each page
1628
+ * of the response. If you do not include this parameter, it defaults to a value that is
1629
+ * specific to the operation. If additional items exist beyond the number you specify, the
1630
+ * <code>NextToken</code> response element is returned with a value (not null).
1631
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1632
+ * call to the operation to get the next part of the results. Note that the service might
1633
+ * return fewer results than the maximum even when there are more results available. You
1634
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1635
+ * of the results.</p>
1327
1636
  */
1328
1637
  maxResults?: number;
1329
1638
  }
@@ -1342,15 +1651,15 @@ export interface Principal {
1342
1651
  */
1343
1652
  id?: string;
1344
1653
  /**
1345
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
1654
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of a resource share the principal is associated with.</p>
1346
1655
  */
1347
1656
  resourceShareArn?: string;
1348
1657
  /**
1349
- * <p>The time when the principal was associated with the resource share.</p>
1658
+ * <p>The date and time when the principal was associated with the resource share.</p>
1350
1659
  */
1351
1660
  creationTime?: Date;
1352
1661
  /**
1353
- * <p>The time when the association was last updated.</p>
1662
+ * <p>The date and time when the association was last updated.</p>
1354
1663
  */
1355
1664
  lastUpdatedTime?: Date;
1356
1665
  /**
@@ -1367,11 +1676,15 @@ export declare namespace Principal {
1367
1676
  }
1368
1677
  export interface ListPrincipalsResponse {
1369
1678
  /**
1370
- * <p>The principals.</p>
1679
+ * <p>An array of objects that contain the details about the principals.</p>
1371
1680
  */
1372
1681
  principals?: Principal[];
1373
1682
  /**
1374
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1683
+ * <p>If present, this value indicates that more output is available than
1684
+ * is included in the current response. Use this value in the <code>NextToken</code>
1685
+ * request parameter in a subsequent call to the operation to get the next part of the
1686
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1687
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1375
1688
  */
1376
1689
  nextToken?: string;
1377
1690
  }
@@ -1389,44 +1702,91 @@ export interface InvalidResourceTypeException extends __SmithyException, $Metada
1389
1702
  $fault: "client";
1390
1703
  message: string | undefined;
1391
1704
  }
1392
- export declare namespace InvalidResourceTypeException {
1393
- /**
1394
- * @internal
1395
- */
1396
- const filterSensitiveLog: (obj: InvalidResourceTypeException) => any;
1397
- }
1398
1705
  export interface ListResourcesRequest {
1399
1706
  /**
1400
- * <p>The type of owner.</p>
1707
+ * <p>Specifies that you want to list only the resource shares that match the following:</p>
1708
+ * <ul>
1709
+ * <li>
1710
+ * <p>
1711
+ * <b>
1712
+ * <code>SELF</code>
1713
+ * </b> – resources that you
1714
+ * are sharing</p>
1715
+ * </li>
1716
+ * <li>
1717
+ * <p>
1718
+ * <b>
1719
+ * <code>OTHER-ACCOUNTS</code>
1720
+ * </b> –
1721
+ * resources that other accounts share with you</p>
1722
+ * </li>
1723
+ * </ul>
1401
1724
  */
1402
1725
  resourceOwner: ResourceOwner | string | undefined;
1403
1726
  /**
1404
- * <p>The principal.</p>
1727
+ * <p>Specifies that you want to list only the resource shares that are associated with the specified
1728
+ * principal.</p>
1405
1729
  */
1406
1730
  principal?: string;
1407
1731
  /**
1408
- * <p>The resource type.</p>
1409
- * <p>Valid values: <code>acm-pca:CertificateAuthority</code> | <code>appmesh:Mesh</code> | <code>codebuild:Project</code> | <code>codebuild:ReportGroup</code> | <code>ec2:CapacityReservation</code> | <code>ec2:DedicatedHost</code> | <code>ec2:LocalGatewayRouteTable</code> | <code>ec2:PrefixList</code> | <code>ec2:Subnet</code> | <code>ec2:TrafficMirrorTarget</code> | <code>ec2:TransitGateway</code> | <code>imagebuilder:Component</code> | <code>imagebuilder:Image</code> | <code>imagebuilder:ImageRecipe</code> | <code>imagebuilder:ContainerRecipe</code> | <code>glue:Catalog</code> | <code>glue:Database</code> | <code>glue:Table</code> | <code>license-manager:LicenseConfiguration</code> I <code>network-firewall:FirewallPolicy</code> | <code>network-firewall:StatefulRuleGroup</code> | <code>network-firewall:StatelessRuleGroup</code> | <code>outposts:Outpost</code> | <code>resource-groups:Group</code> | <code>rds:Cluster</code> | <code>route53resolver:FirewallRuleGroup</code> |<code>route53resolver:ResolverQueryLogConfig</code> | <code>route53resolver:ResolverRule</code> | <code>s3-outposts:Outpost</code> | <code>ssm-contacts:Contact</code> | <code>ssm-incidents:ResponsePlan</code>
1410
- * </p>
1732
+ * <p>Specifies that you want to list only the resource shares that include resources of the specified
1733
+ * resource type.</p>
1734
+ * <p>For valid values, query the <a>ListResourceTypes</a> operation.</p>
1411
1735
  */
1412
1736
  resourceType?: string;
1413
1737
  /**
1414
- * <p>The Amazon Resource Names (ARNs) of the resources.</p>
1738
+ * <p>Specifies that you want to list only the resource shares that include resources with the
1739
+ * specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
1415
1740
  */
1416
1741
  resourceArns?: string[];
1417
1742
  /**
1418
- * <p>The Amazon Resource Names (ARN) of the resource shares.</p>
1743
+ * <p>Specifies that you want to list only resources in the resource shares identified by the
1744
+ * specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
1419
1745
  */
1420
1746
  resourceShareArns?: string[];
1421
1747
  /**
1422
- * <p>The token for the next page of results.</p>
1748
+ * <p>Specifies that you want to receive the next page of results. Valid
1749
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1750
+ * did, it indicates that more output is available. Set this parameter to the value
1751
+ * provided by the previous call's <code>NextToken</code> response to request the
1752
+ * next page of results.</p>
1423
1753
  */
1424
1754
  nextToken?: string;
1425
1755
  /**
1426
- * <p>The maximum number of results to return with a single call.
1427
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1756
+ * <p>Specifies the total number of results that you want included on each page
1757
+ * of the response. If you do not include this parameter, it defaults to a value that is
1758
+ * specific to the operation. If additional items exist beyond the number you specify, the
1759
+ * <code>NextToken</code> response element is returned with a value (not null).
1760
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1761
+ * call to the operation to get the next part of the results. Note that the service might
1762
+ * return fewer results than the maximum even when there are more results available. You
1763
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1764
+ * of the results.</p>
1428
1765
  */
1429
1766
  maxResults?: number;
1767
+ /**
1768
+ * <p>Specifies that you want the results to include only
1769
+ * resources that have the specified scope.</p>
1770
+ * <ul>
1771
+ * <li>
1772
+ * <p>
1773
+ * <code>ALL</code> – the results include both global and
1774
+ * regional resources or resource types.</p>
1775
+ * </li>
1776
+ * <li>
1777
+ * <p>
1778
+ * <code>GLOBAL</code> – the results include only global
1779
+ * resources or resource types.</p>
1780
+ * </li>
1781
+ * <li>
1782
+ * <p>
1783
+ * <code>REGIONAL</code> – the results include only regional
1784
+ * resources or resource types.</p>
1785
+ * </li>
1786
+ * </ul>
1787
+ * <p>The default value is <code>ALL</code>.</p>
1788
+ */
1789
+ resourceRegionScope?: ResourceRegionScopeFilter | string;
1430
1790
  }
1431
1791
  export declare namespace ListResourcesRequest {
1432
1792
  /**
@@ -1436,11 +1796,15 @@ export declare namespace ListResourcesRequest {
1436
1796
  }
1437
1797
  export interface ListResourcesResponse {
1438
1798
  /**
1439
- * <p>Information about the resources.</p>
1799
+ * <p>An array of objects that contain information about the resources.</p>
1440
1800
  */
1441
1801
  resources?: Resource[];
1442
1802
  /**
1443
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1803
+ * <p>If present, this value indicates that more output is available than
1804
+ * is included in the current response. Use this value in the <code>NextToken</code>
1805
+ * request parameter in a subsequent call to the operation to get the next part of the
1806
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1807
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1444
1808
  */
1445
1809
  nextToken?: string;
1446
1810
  }
@@ -1452,16 +1816,28 @@ export declare namespace ListResourcesResponse {
1452
1816
  }
1453
1817
  export interface ListResourceSharePermissionsRequest {
1454
1818
  /**
1455
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
1819
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share for which you want to retrieve the associated
1820
+ * permissions.</p>
1456
1821
  */
1457
1822
  resourceShareArn: string | undefined;
1458
1823
  /**
1459
- * <p>The token for the next page of results.</p>
1824
+ * <p>Specifies that you want to receive the next page of results. Valid
1825
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1826
+ * did, it indicates that more output is available. Set this parameter to the value
1827
+ * provided by the previous call's <code>NextToken</code> response to request the
1828
+ * next page of results.</p>
1460
1829
  */
1461
1830
  nextToken?: string;
1462
1831
  /**
1463
- * <p>The maximum number of results to return with a single call.
1464
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1832
+ * <p>Specifies the total number of results that you want included on each page
1833
+ * of the response. If you do not include this parameter, it defaults to a value that is
1834
+ * specific to the operation. If additional items exist beyond the number you specify, the
1835
+ * <code>NextToken</code> response element is returned with a value (not null).
1836
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1837
+ * call to the operation to get the next part of the results. Note that the service might
1838
+ * return fewer results than the maximum even when there are more results available. You
1839
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1840
+ * of the results.</p>
1465
1841
  */
1466
1842
  maxResults?: number;
1467
1843
  }
@@ -1473,11 +1849,15 @@ export declare namespace ListResourceSharePermissionsRequest {
1473
1849
  }
1474
1850
  export interface ListResourceSharePermissionsResponse {
1475
1851
  /**
1476
- * <p>The permissions associated with the resource share.</p>
1852
+ * <p>An array of objects that describe the permissions associated with the resource share.</p>
1477
1853
  */
1478
1854
  permissions?: ResourceSharePermissionSummary[];
1479
1855
  /**
1480
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1856
+ * <p>If present, this value indicates that more output is available than
1857
+ * is included in the current response. Use this value in the <code>NextToken</code>
1858
+ * request parameter in a subsequent call to the operation to get the next part of the
1859
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1860
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1481
1861
  */
1482
1862
  nextToken?: string;
1483
1863
  }
@@ -1489,14 +1869,48 @@ export declare namespace ListResourceSharePermissionsResponse {
1489
1869
  }
1490
1870
  export interface ListResourceTypesRequest {
1491
1871
  /**
1492
- * <p>The token for the next page of results.</p>
1872
+ * <p>Specifies that you want to receive the next page of results. Valid
1873
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1874
+ * did, it indicates that more output is available. Set this parameter to the value
1875
+ * provided by the previous call's <code>NextToken</code> response to request the
1876
+ * next page of results.</p>
1493
1877
  */
1494
1878
  nextToken?: string;
1495
1879
  /**
1496
- * <p>The maximum number of results to return with a single call.
1497
- * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1880
+ * <p>Specifies the total number of results that you want included on each page
1881
+ * of the response. If you do not include this parameter, it defaults to a value that is
1882
+ * specific to the operation. If additional items exist beyond the number you specify, the
1883
+ * <code>NextToken</code> response element is returned with a value (not null).
1884
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1885
+ * call to the operation to get the next part of the results. Note that the service might
1886
+ * return fewer results than the maximum even when there are more results available. You
1887
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1888
+ * of the results.</p>
1498
1889
  */
1499
1890
  maxResults?: number;
1891
+ /**
1892
+ * <p>Specifies that you want the results to include only
1893
+ * resources that have the specified scope.</p>
1894
+ * <ul>
1895
+ * <li>
1896
+ * <p>
1897
+ * <code>ALL</code> – the results include both global and
1898
+ * regional resources or resource types.</p>
1899
+ * </li>
1900
+ * <li>
1901
+ * <p>
1902
+ * <code>GLOBAL</code> – the results include only global
1903
+ * resources or resource types.</p>
1904
+ * </li>
1905
+ * <li>
1906
+ * <p>
1907
+ * <code>REGIONAL</code> – the results include only regional
1908
+ * resources or resource types.</p>
1909
+ * </li>
1910
+ * </ul>
1911
+ * <p>The default value is <code>ALL</code>.</p>
1912
+ */
1913
+ resourceRegionScope?: ResourceRegionScopeFilter | string;
1500
1914
  }
1501
1915
  export declare namespace ListResourceTypesRequest {
1502
1916
  /**
@@ -1505,18 +1919,35 @@ export declare namespace ListResourceTypesRequest {
1505
1919
  const filterSensitiveLog: (obj: ListResourceTypesRequest) => any;
1506
1920
  }
1507
1921
  /**
1508
- * <p>Information about the shareable resource types and the Amazon Web Services services to which they
1509
- * belong.</p>
1922
+ * <p>Information about a shareable resource type and the Amazon Web Services service to which resources
1923
+ * of that type belong.</p>
1510
1924
  */
1511
1925
  export interface ServiceNameAndResourceType {
1512
1926
  /**
1513
- * <p>The shareable resource types.</p>
1927
+ * <p>The type of the resource.</p>
1514
1928
  */
1515
1929
  resourceType?: string;
1516
1930
  /**
1517
- * <p>The name of the Amazon Web Services services to which the resources belong.</p>
1931
+ * <p>The name of the Amazon Web Services service to which resources of this type belong.</p>
1518
1932
  */
1519
1933
  serviceName?: string;
1934
+ /**
1935
+ * <p>Specifies the scope of visibility of resources of this type:</p>
1936
+ * <ul>
1937
+ * <li>
1938
+ * <p>
1939
+ * <b>REGIONAL</b> – The resource can be
1940
+ * accessed only by using requests that target the Amazon Web Services Region in which the
1941
+ * resource exists.</p>
1942
+ * </li>
1943
+ * <li>
1944
+ * <p>
1945
+ * <b>GLOBAL</b> – The resource can be accessed
1946
+ * from any Amazon Web Services Region.</p>
1947
+ * </li>
1948
+ * </ul>
1949
+ */
1950
+ resourceRegionScope?: ResourceRegionScope | string;
1520
1951
  }
1521
1952
  export declare namespace ServiceNameAndResourceType {
1522
1953
  /**
@@ -1526,11 +1957,16 @@ export declare namespace ServiceNameAndResourceType {
1526
1957
  }
1527
1958
  export interface ListResourceTypesResponse {
1528
1959
  /**
1529
- * <p>The shareable resource types supported by RAM.</p>
1960
+ * <p>An array of objects that contain information about the resource types that can be
1961
+ * shared using RAM.</p>
1530
1962
  */
1531
1963
  resourceTypes?: ServiceNameAndResourceType[];
1532
1964
  /**
1533
- * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1965
+ * <p>If present, this value indicates that more output is available than
1966
+ * is included in the current response. Use this value in the <code>NextToken</code>
1967
+ * request parameter in a subsequent call to the operation to get the next part of the
1968
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1969
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1534
1970
  */
1535
1971
  nextToken?: string;
1536
1972
  }
@@ -1542,7 +1978,7 @@ export declare namespace ListResourceTypesResponse {
1542
1978
  }
1543
1979
  export interface PromoteResourceShareCreatedFromPolicyRequest {
1544
1980
  /**
1545
- * <p>The Amazon Resource Name (ARN) of the resource share to promote.</p>
1981
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share to promote.</p>
1546
1982
  */
1547
1983
  resourceShareArn: string | undefined;
1548
1984
  }
@@ -1554,7 +1990,8 @@ export declare namespace PromoteResourceShareCreatedFromPolicyRequest {
1554
1990
  }
1555
1991
  export interface PromoteResourceShareCreatedFromPolicyResponse {
1556
1992
  /**
1557
- * <p>Indicates whether the request succeeded.</p>
1993
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
1994
+ * A value of <code>false</code> indicates that the request failed.</p>
1558
1995
  */
1559
1996
  returnValue?: boolean;
1560
1997
  }
@@ -1566,11 +2003,18 @@ export declare namespace PromoteResourceShareCreatedFromPolicyResponse {
1566
2003
  }
1567
2004
  export interface RejectResourceShareInvitationRequest {
1568
2005
  /**
1569
- * <p>The Amazon Resource Name (ARN) of the invitation.</p>
2006
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the invitation that you want to reject.</p>
1570
2007
  */
1571
2008
  resourceShareInvitationArn: string | undefined;
1572
2009
  /**
1573
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
2010
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
2011
+ * ensure the idempotency of the request. This lets you safely retry the request without
2012
+ * accidentally performing the same operation a second time. Passing the same value to a
2013
+ * later call to an operation requires that you also pass the same value for all other
2014
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
2015
+ * value.</a>.</p>
2016
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
2017
+ * you.</p>
1574
2018
  */
1575
2019
  clientToken?: string;
1576
2020
  }
@@ -1582,11 +2026,14 @@ export declare namespace RejectResourceShareInvitationRequest {
1582
2026
  }
1583
2027
  export interface RejectResourceShareInvitationResponse {
1584
2028
  /**
1585
- * <p>Information about the invitation.</p>
2029
+ * <p>An object that contains the details about the rejected invitation.</p>
1586
2030
  */
1587
2031
  resourceShareInvitation?: ResourceShareInvitation;
1588
2032
  /**
1589
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
2033
+ * <p>The idempotency identifier associated with this request. If you
2034
+ * want to repeat the same operation in an idempotent manner then you must include this
2035
+ * value in the <code>clientToken</code> request parameter of that later call. All other
2036
+ * parameters must also have the same values that you used in the first call.</p>
1590
2037
  */
1591
2038
  clientToken?: string;
1592
2039
  }
@@ -1597,26 +2044,21 @@ export declare namespace RejectResourceShareInvitationResponse {
1597
2044
  const filterSensitiveLog: (obj: RejectResourceShareInvitationResponse) => any;
1598
2045
  }
1599
2046
  /**
1600
- * <p>The requested tags exceed the limit for your account.</p>
2047
+ * <p>This request would exceed the limit for tags for your account.</p>
1601
2048
  */
1602
2049
  export interface TagLimitExceededException extends __SmithyException, $MetadataBearer {
1603
2050
  name: "TagLimitExceededException";
1604
2051
  $fault: "client";
1605
2052
  message: string | undefined;
1606
2053
  }
1607
- export declare namespace TagLimitExceededException {
1608
- /**
1609
- * @internal
1610
- */
1611
- const filterSensitiveLog: (obj: TagLimitExceededException) => any;
1612
- }
1613
2054
  export interface TagResourceRequest {
1614
2055
  /**
1615
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
2056
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share that you want to add tags to.</p>
1616
2057
  */
1617
2058
  resourceShareArn: string | undefined;
1618
2059
  /**
1619
- * <p>One or more tags.</p>
2060
+ * <p>A list of one or more tag key and value pairs. The tag key must be present and not be
2061
+ * an empty string. The tag value must be present but can be an empty string.</p>
1620
2062
  */
1621
2063
  tags: Tag[] | undefined;
1622
2064
  }
@@ -1636,11 +2078,12 @@ export declare namespace TagResourceResponse {
1636
2078
  }
1637
2079
  export interface UntagResourceRequest {
1638
2080
  /**
1639
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
2081
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share that you want to remove tags from. The tags are
2082
+ * removed from the resource share, not the resources in the resource share.</p>
1640
2083
  */
1641
2084
  resourceShareArn: string | undefined;
1642
2085
  /**
1643
- * <p>The tag keys of the tags to remove.</p>
2086
+ * <p>Specifies a list of one or more tag keys that you want to remove.</p>
1644
2087
  */
1645
2088
  tagKeys: string[] | undefined;
1646
2089
  }
@@ -1660,20 +2103,27 @@ export declare namespace UntagResourceResponse {
1660
2103
  }
1661
2104
  export interface UpdateResourceShareRequest {
1662
2105
  /**
1663
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
2106
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a> of the resource share that you want to modify.</p>
1664
2107
  */
1665
2108
  resourceShareArn: string | undefined;
1666
2109
  /**
1667
- * <p>The name of the resource share.</p>
2110
+ * <p>If specified, the new name that you want to attach to the resource share.</p>
1668
2111
  */
1669
2112
  name?: string;
1670
2113
  /**
1671
- * <p>Indicates whether principals outside your organization in Organizations can be associated
2114
+ * <p>Specifies whether principals outside your organization in Organizations can be associated
1672
2115
  * with a resource share.</p>
1673
2116
  */
1674
2117
  allowExternalPrincipals?: boolean;
1675
2118
  /**
1676
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
2119
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
2120
+ * ensure the idempotency of the request. This lets you safely retry the request without
2121
+ * accidentally performing the same operation a second time. Passing the same value to a
2122
+ * later call to an operation requires that you also pass the same value for all other
2123
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
2124
+ * value.</a>.</p>
2125
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
2126
+ * you.</p>
1677
2127
  */
1678
2128
  clientToken?: string;
1679
2129
  }
@@ -1689,7 +2139,10 @@ export interface UpdateResourceShareResponse {
1689
2139
  */
1690
2140
  resourceShare?: ResourceShare;
1691
2141
  /**
1692
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
2142
+ * <p>The idempotency identifier associated with this request. If you
2143
+ * want to repeat the same operation in an idempotent manner then you must include this
2144
+ * value in the <code>clientToken</code> request parameter of that later call. All other
2145
+ * parameters must also have the same values that you used in the first call.</p>
1693
2146
  */
1694
2147
  clientToken?: string;
1695
2148
  }