@aws-sdk/client-ram 3.40.0 → 3.45.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 (37) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +5 -6
  3. package/dist-cjs/endpoints.js +9 -0
  4. package/dist-cjs/models/models_0.js +19 -2
  5. package/dist-cjs/protocols/Aws_restJson1.js +29 -0
  6. package/dist-es/endpoints.js +9 -0
  7. package/dist-es/models/models_0.js +15 -0
  8. package/dist-es/protocols/Aws_restJson1.js +65 -36
  9. package/dist-types/RAM.d.ts +55 -41
  10. package/dist-types/RAMClient.d.ts +5 -6
  11. package/dist-types/commands/AcceptResourceShareInvitationCommand.d.ts +4 -2
  12. package/dist-types/commands/AssociateResourceShareCommand.d.ts +4 -2
  13. package/dist-types/commands/AssociateResourceSharePermissionCommand.d.ts +5 -2
  14. package/dist-types/commands/CreateResourceShareCommand.d.ts +4 -4
  15. package/dist-types/commands/DeleteResourceShareCommand.d.ts +4 -2
  16. package/dist-types/commands/DisassociateResourceShareCommand.d.ts +1 -1
  17. package/dist-types/commands/DisassociateResourceSharePermissionCommand.d.ts +4 -2
  18. package/dist-types/commands/EnableSharingWithAwsOrganizationCommand.d.ts +10 -3
  19. package/dist-types/commands/GetPermissionCommand.d.ts +1 -1
  20. package/dist-types/commands/GetResourcePoliciesCommand.d.ts +3 -2
  21. package/dist-types/commands/GetResourceShareAssociationsCommand.d.ts +2 -2
  22. package/dist-types/commands/GetResourceShareInvitationsCommand.d.ts +2 -2
  23. package/dist-types/commands/GetResourceSharesCommand.d.ts +2 -2
  24. package/dist-types/commands/ListPendingInvitationResourcesCommand.d.ts +4 -3
  25. package/dist-types/commands/ListPermissionsCommand.d.ts +3 -2
  26. package/dist-types/commands/ListPrincipalsCommand.d.ts +2 -2
  27. package/dist-types/commands/ListResourceSharePermissionsCommand.d.ts +1 -1
  28. package/dist-types/commands/ListResourceTypesCommand.d.ts +2 -2
  29. package/dist-types/commands/ListResourcesCommand.d.ts +1 -1
  30. package/dist-types/commands/PromoteResourceShareCreatedFromPolicyCommand.d.ts +7 -14
  31. package/dist-types/commands/RejectResourceShareInvitationCommand.d.ts +1 -1
  32. package/dist-types/commands/TagResourceCommand.d.ts +3 -2
  33. package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
  34. package/dist-types/commands/UpdateResourceShareCommand.d.ts +2 -2
  35. package/dist-types/models/models_0.d.ts +848 -263
  36. package/dist-types/ts3.4/models/models_0.d.ts +29 -0
  37. package/package.json +6 -6
@@ -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,8 +167,9 @@ 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";
@@ -167,7 +183,7 @@ export declare namespace IdempotentParameterMismatchException {
167
183
  const filterSensitiveLog: (obj: IdempotentParameterMismatchException) => any;
168
184
  }
169
185
  /**
170
- * <p>A client token is not valid.</p>
186
+ * <p>The client token is not valid.</p>
171
187
  */
172
188
  export interface InvalidClientTokenException extends __SmithyException, $MetadataBearer {
173
189
  name: "InvalidClientTokenException";
@@ -209,7 +225,7 @@ export declare namespace OperationNotPermittedException {
209
225
  const filterSensitiveLog: (obj: OperationNotPermittedException) => any;
210
226
  }
211
227
  /**
212
- * <p>The invitation was already accepted.</p>
228
+ * <p>The specified invitation was already accepted.</p>
213
229
  */
214
230
  export interface ResourceShareInvitationAlreadyAcceptedException extends __SmithyException, $MetadataBearer {
215
231
  name: "ResourceShareInvitationAlreadyAcceptedException";
@@ -223,7 +239,7 @@ export declare namespace ResourceShareInvitationAlreadyAcceptedException {
223
239
  const filterSensitiveLog: (obj: ResourceShareInvitationAlreadyAcceptedException) => any;
224
240
  }
225
241
  /**
226
- * <p>The invitation was already rejected.</p>
242
+ * <p>The specified invitation was already rejected.</p>
227
243
  */
228
244
  export interface ResourceShareInvitationAlreadyRejectedException extends __SmithyException, $MetadataBearer {
229
245
  name: "ResourceShareInvitationAlreadyRejectedException";
@@ -237,7 +253,7 @@ export declare namespace ResourceShareInvitationAlreadyRejectedException {
237
253
  const filterSensitiveLog: (obj: ResourceShareInvitationAlreadyRejectedException) => any;
238
254
  }
239
255
  /**
240
- * <p>The Amazon Resource Name (ARN) for an invitation was not found.</p>
256
+ * <p>The specified Amazon Resource Name (ARN) for an invitation was not found.</p>
241
257
  */
242
258
  export interface ResourceShareInvitationArnNotFoundException extends __SmithyException, $MetadataBearer {
243
259
  name: "ResourceShareInvitationArnNotFoundException";
@@ -251,7 +267,7 @@ export declare namespace ResourceShareInvitationArnNotFoundException {
251
267
  const filterSensitiveLog: (obj: ResourceShareInvitationArnNotFoundException) => any;
252
268
  }
253
269
  /**
254
- * <p>The invitation is expired.</p>
270
+ * <p>The specified invitation is expired.</p>
255
271
  */
256
272
  export interface ResourceShareInvitationExpiredException extends __SmithyException, $MetadataBearer {
257
273
  name: "ResourceShareInvitationExpiredException";
@@ -294,41 +310,63 @@ export declare namespace ServiceUnavailableException {
294
310
  }
295
311
  export interface AssociateResourceShareRequest {
296
312
  /**
297
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
313
+ * <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
314
+ * to.</p>
298
315
  */
299
316
  resourceShareArn: string | undefined;
300
317
  /**
301
- * <p>The Amazon Resource Names (ARNs) of the resources.</p>
318
+ * <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
319
+ * <code>null</code> if you want to add only principals.</p>
302
320
  */
303
321
  resourceArns?: string[];
304
322
  /**
305
- * <p>The principals to associate with the resource share. The possible values are:</p>
323
+ * <p>Specifies a list of principals to whom you want to the resource share. This can be
324
+ * <code>null</code> if you want to add only resources.</p>
325
+ * <p>What the principals can do with the resources in the share is determined by the RAM
326
+ * permissions that you associate with the resource share. See <a>AssociateResourceSharePermission</a>.</p>
327
+ * <p>You can include the following values:</p>
306
328
  * <ul>
307
329
  * <li>
308
- * <p>An Amazon Web Services account ID</p>
330
+ * <p>An Amazon Web Services account ID, for example: <code>123456789012</code>
331
+ * </p>
309
332
  * </li>
310
333
  * <li>
311
- * <p>An Amazon Resource Name (ARN) of an organization in Organizations</p>
334
+ * <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:
335
+ * <code>organizations::123456789012:organization/o-exampleorgid</code>
336
+ * </p>
312
337
  * </li>
313
338
  * <li>
314
- * <p>An ARN of an organizational unit (OU) in Organizations</p>
339
+ * <p>An ARN of an organizational unit (OU) in Organizations, for example:
340
+ * <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code>
341
+ * </p>
315
342
  * </li>
316
343
  * <li>
317
- * <p>An ARN of an IAM role</p>
344
+ * <p>An ARN of an IAM role, for example:
345
+ * <code>iam::123456789012:role/rolename</code>
346
+ * </p>
318
347
  * </li>
319
348
  * <li>
320
- * <p>An ARN of an IAM user</p>
349
+ * <p>An ARN of an IAM user, for example:
350
+ * <code>iam::123456789012user/username</code>
351
+ * </p>
321
352
  * </li>
322
353
  * </ul>
323
354
  * <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
355
+ * <p>Not all resource types can be shared with IAM roles and users.
356
+ * 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
357
  * Guide</i>.</p>
327
- * </note>
358
+ * </note>
328
359
  */
329
360
  principals?: string[];
330
361
  /**
331
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
362
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
363
+ * ensure the idempotency of the request. This lets you safely retry the request without
364
+ * accidentally performing the same operation a second time. Passing the same value to a
365
+ * later call to an operation requires that you also pass the same value for all other
366
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
367
+ * value.</a>.</p>
368
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
369
+ * you.</p>
332
370
  */
333
371
  clientToken?: string;
334
372
  }
@@ -340,11 +378,14 @@ export declare namespace AssociateResourceShareRequest {
340
378
  }
341
379
  export interface AssociateResourceShareResponse {
342
380
  /**
343
- * <p>Information about the associations.</p>
381
+ * <p>An array of objects that contain information about the associations.</p>
344
382
  */
345
383
  resourceShareAssociations?: ResourceShareAssociation[];
346
384
  /**
347
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
385
+ * <p>The idempotency identifier associated with this request. If you
386
+ * want to repeat the same operation in an idempotent manner then you must include this
387
+ * value in the <code>clientToken</code> request parameter of that later call. All other
388
+ * parameters must also have the same values that you used in the first call.</p>
348
389
  */
349
390
  clientToken?: string;
350
391
  }
@@ -383,7 +424,7 @@ export declare namespace InvalidStateTransitionException {
383
424
  const filterSensitiveLog: (obj: InvalidStateTransitionException) => any;
384
425
  }
385
426
  /**
386
- * <p>The requested resource share exceeds the limit for your account.</p>
427
+ * <p>This request would exceed the limit for resource shares for your account.</p>
387
428
  */
388
429
  export interface ResourceShareLimitExceededException extends __SmithyException, $MetadataBearer {
389
430
  name: "ResourceShareLimitExceededException";
@@ -396,6 +437,21 @@ export declare namespace ResourceShareLimitExceededException {
396
437
  */
397
438
  const filterSensitiveLog: (obj: ResourceShareLimitExceededException) => any;
398
439
  }
440
+ /**
441
+ * <p>You exceeded the rate at which you are allowed to perform this operation. Please try
442
+ * again later.</p>
443
+ */
444
+ export interface ThrottlingException extends __SmithyException, $MetadataBearer {
445
+ name: "ThrottlingException";
446
+ $fault: "client";
447
+ message: string | undefined;
448
+ }
449
+ export declare namespace ThrottlingException {
450
+ /**
451
+ * @internal
452
+ */
453
+ const filterSensitiveLog: (obj: ThrottlingException) => any;
454
+ }
399
455
  /**
400
456
  * <p>A specified resource was not found.</p>
401
457
  */
@@ -412,26 +468,43 @@ export declare namespace UnknownResourceException {
412
468
  }
413
469
  export interface AssociateResourceSharePermissionRequest {
414
470
  /**
415
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
471
+ * <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
472
+ * permissions.</p>
416
473
  */
417
474
  resourceShareArn: string | undefined;
418
475
  /**
419
- * <p>The Amazon Resource Name (ARN) of the RAM permission to associate with the
420
- * resource share.</p>
476
+ * <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.
477
+ * 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
478
+ * then choose the name of the permission. The ARN is displayed on the detail page.</p>
421
479
  */
422
480
  permissionArn: string | undefined;
423
481
  /**
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>
482
+ * <p>Specifies whether the specified permission should replace or add to the existing
483
+ * permission associated with the resource share. Use <code>true</code> to replace the current
484
+ * permissions. Use <code>false</code> to add the permission to the current permission. The
485
+ * default value is <code>false</code>.</p>
486
+ * <note>
487
+ * <p>A resource share can have only one permission per resource type. If a resource share already has a
488
+ * permission for the specified resource type and you don't set <code>replace</code> to
489
+ * <code>true</code> then the operation returns an error. This helps prevent
490
+ * accidental overwriting of a permission.</p>
491
+ * </note>
427
492
  */
428
493
  replace?: boolean;
429
494
  /**
430
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
495
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
496
+ * ensure the idempotency of the request. This lets you safely retry the request without
497
+ * accidentally performing the same operation a second time. Passing the same value to a
498
+ * later call to an operation requires that you also pass the same value for all other
499
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
500
+ * value.</a>.</p>
501
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
502
+ * you.</p>
431
503
  */
432
504
  clientToken?: string;
433
505
  /**
434
- * <p>The version of the RAM permissions to associate with the resource share.</p>
506
+ * <p>Specifies the version of the RAM permission to associate with the resource share. If you don't
507
+ * specify this parameter, the operation uses the version designated as the default.</p>
435
508
  */
436
509
  permissionVersion?: number;
437
510
  }
@@ -443,11 +516,15 @@ export declare namespace AssociateResourceSharePermissionRequest {
443
516
  }
444
517
  export interface AssociateResourceSharePermissionResponse {
445
518
  /**
446
- * <p>Indicates whether the request succeeded.</p>
519
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
520
+ * A value of <code>false</code> indicates that the request failed.</p>
447
521
  */
448
522
  returnValue?: boolean;
449
523
  /**
450
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
524
+ * <p>The idempotency identifier associated with this request. If you
525
+ * want to repeat the same operation in an idempotent manner then you must include this
526
+ * value in the <code>clientToken</code> request parameter of that later call. All other
527
+ * parameters must also have the same values that you used in the first call.</p>
451
528
  */
452
529
  clientToken?: string;
453
530
  }
@@ -458,15 +535,22 @@ export declare namespace AssociateResourceSharePermissionResponse {
458
535
  const filterSensitiveLog: (obj: AssociateResourceSharePermissionResponse) => any;
459
536
  }
460
537
  /**
461
- * <p>Information about a tag.</p>
538
+ * <p>A structure containing a tag. A tag is metadata that you can attach to your resources
539
+ * to help organize and categorize them. You can also use them to help you secure your
540
+ * 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
541
+ * using tags</a>.</p>
542
+ * <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
543
+ * <i>Amazon Web Services General Reference Guide</i>.</p>
462
544
  */
463
545
  export interface Tag {
464
546
  /**
465
- * <p>The key of the tag.</p>
547
+ * <p>The key, or name, attached to the tag. Every tag must have a key. Key names are case
548
+ * sensitive.</p>
466
549
  */
467
550
  key?: string;
468
551
  /**
469
- * <p>The value of the tag.</p>
552
+ * <p>The string value attached to the tag. The value can be an empty string. Key values are
553
+ * case sensitive.</p>
470
554
  */
471
555
  value?: string;
472
556
  }
@@ -478,57 +562,79 @@ export declare namespace Tag {
478
562
  }
479
563
  export interface CreateResourceShareRequest {
480
564
  /**
481
- * <p>The name of the resource share.</p>
565
+ * <p>Specifies the name of the resource share.</p>
482
566
  */
483
567
  name: string | undefined;
484
568
  /**
485
- * <p>The ARNs of the resources to associate with the resource share.</p>
569
+ * <p>Specifies a list of one or more ARNs of the resources to associate with the
570
+ * resource share.</p>
486
571
  */
487
572
  resourceArns?: string[];
488
573
  /**
489
- * <p>The principals to associate with the resource share. The possible values are:</p>
574
+ * <p>Specifies a list of one or more principals to associate with the resource share.</p>
575
+ * <p>You can include the following values:</p>
490
576
  * <ul>
491
577
  * <li>
492
- * <p>An Amazon Web Services account ID</p>
578
+ * <p>An Amazon Web Services account ID, for example: <code>123456789012</code>
579
+ * </p>
493
580
  * </li>
494
581
  * <li>
495
- * <p>An Amazon Resource Name (ARN) of an organization in Organizations</p>
582
+ * <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:
583
+ * <code>organizations::123456789012:organization/o-exampleorgid</code>
584
+ * </p>
496
585
  * </li>
497
586
  * <li>
498
- * <p>An ARN of an organizational unit (OU) in Organizations</p>
587
+ * <p>An ARN of an organizational unit (OU) in Organizations, for example:
588
+ * <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code>
589
+ * </p>
499
590
  * </li>
500
591
  * <li>
501
- * <p>An ARN of an IAM role</p>
592
+ * <p>An ARN of an IAM role, for example:
593
+ * <code>iam::123456789012:role/rolename</code>
594
+ * </p>
502
595
  * </li>
503
596
  * <li>
504
- * <p>An ARN of an IAM user</p>
597
+ * <p>An ARN of an IAM user, for example:
598
+ * <code>iam::123456789012user/username</code>
599
+ * </p>
505
600
  * </li>
506
601
  * </ul>
507
602
  * <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
603
+ * <p>Not all resource types can be shared with IAM roles and users.
604
+ * 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
605
  * Guide</i>.</p>
511
- * </note>
606
+ * </note>
512
607
  */
513
608
  principals?: string[];
514
609
  /**
515
- * <p>One or more tags.</p>
610
+ * <p>Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to
611
+ * the resources associated with the resource share.</p>
516
612
  */
517
613
  tags?: Tag[];
518
614
  /**
519
- * <p>Indicates whether principals outside your organization in Organizations can be associated
520
- * with a resource share.</p>
615
+ * <p>Specifies whether principals outside your organization in Organizations can be associated
616
+ * with a resource share. A value of <code>true</code> lets you share with individual Amazon Web Services accounts
617
+ * that are <i>not</i> in your organization. A value of <code>false</code>
618
+ * only has meaning if your account is a member of an Amazon Web Services Organization. The default value
619
+ * is <code>true</code>.</p>
521
620
  */
522
621
  allowExternalPrincipals?: boolean;
523
622
  /**
524
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
623
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
624
+ * ensure the idempotency of the request. This lets you safely retry the request without
625
+ * accidentally performing the same operation a second time. Passing the same value to a
626
+ * later call to an operation requires that you also pass the same value for all other
627
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
628
+ * value.</a>.</p>
629
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
630
+ * you.</p>
525
631
  */
526
632
  clientToken?: string;
527
633
  /**
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>
634
+ * <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
635
+ * not specify an ARN for the permission, RAM automatically attaches the default version
636
+ * of the permission for each resource type. You can associate only one permission with
637
+ * each resource type included in the resource share.</p>
532
638
  */
533
639
  permissionArns?: string[];
534
640
  }
@@ -541,11 +647,11 @@ export declare namespace CreateResourceShareRequest {
541
647
  export declare type ResourceShareFeatureSet = "CREATED_FROM_POLICY" | "PROMOTING_TO_STANDARD" | "STANDARD";
542
648
  export declare type ResourceShareStatus = "ACTIVE" | "DELETED" | "DELETING" | "FAILED" | "PENDING";
543
649
  /**
544
- * <p>Describes a resource share.</p>
650
+ * <p>Describes a resource share in RAM.</p>
545
651
  */
546
652
  export interface ResourceShare {
547
653
  /**
548
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
654
+ * <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
655
  */
550
656
  resourceShareArn?: string;
551
657
  /**
@@ -562,7 +668,7 @@ export interface ResourceShare {
562
668
  */
563
669
  allowExternalPrincipals?: boolean;
564
670
  /**
565
- * <p>The status of the resource share.</p>
671
+ * <p>The current status of the resource share.</p>
566
672
  */
567
673
  status?: ResourceShareStatus | string;
568
674
  /**
@@ -570,15 +676,15 @@ export interface ResourceShare {
570
676
  */
571
677
  statusMessage?: string;
572
678
  /**
573
- * <p>The tags for the resource share.</p>
679
+ * <p>The tag key and value pairs attached to the resource share.</p>
574
680
  */
575
681
  tags?: Tag[];
576
682
  /**
577
- * <p>The time when the resource share was created.</p>
683
+ * <p>The date and time when the resource share was created.</p>
578
684
  */
579
685
  creationTime?: Date;
580
686
  /**
581
- * <p>The time when the resource share was last updated.</p>
687
+ * <p>The date and time when the resource share was last updated.</p>
582
688
  */
583
689
  lastUpdatedTime?: Date;
584
690
  /**
@@ -587,9 +693,9 @@ export interface ResourceShare {
587
693
  * <li>
588
694
  * <p>
589
695
  * <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>
696
+ * Identity and Access Management (IAM) resource-based permission policy attached to the resource.
697
+ * This type of resource share is visible only to the Amazon Web Services account that created it. You
698
+ * can't modify it in RAM unless you promote it. For more information, see <a>PromoteResourceShareCreatedFromPolicy</a>.</p>
593
699
  * </li>
594
700
  * <li>
595
701
  * <p>
@@ -599,8 +705,8 @@ export interface ResourceShare {
599
705
  * <li>
600
706
  * <p>
601
707
  * <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>
708
+ * console or APIs. These resource shares are visible to all principals you share the resource share
709
+ * with. You can modify these resource shares in RAM using the console or APIs.</p>
604
710
  * </li>
605
711
  * </ul>
606
712
  */
@@ -614,11 +720,14 @@ export declare namespace ResourceShare {
614
720
  }
615
721
  export interface CreateResourceShareResponse {
616
722
  /**
617
- * <p>Information about the resource share.</p>
723
+ * <p>An object with information about the new resource share.</p>
618
724
  */
619
725
  resourceShare?: ResourceShare;
620
726
  /**
621
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
727
+ * <p>The idempotency identifier associated with this request. If you
728
+ * want to repeat the same operation in an idempotent manner then you must include this
729
+ * value in the <code>clientToken</code> request parameter of that later call. All other
730
+ * parameters must also have the same values that you used in the first call.</p>
622
731
  */
623
732
  clientToken?: string;
624
733
  }
@@ -629,7 +738,7 @@ export declare namespace CreateResourceShareResponse {
629
738
  const filterSensitiveLog: (obj: CreateResourceShareResponse) => any;
630
739
  }
631
740
  /**
632
- * <p>The specified tag is a reserved word and cannot be used.</p>
741
+ * <p>The specified tag key is a reserved word and can't be used.</p>
633
742
  */
634
743
  export interface TagPolicyViolationException extends __SmithyException, $MetadataBearer {
635
744
  name: "TagPolicyViolationException";
@@ -644,11 +753,18 @@ export declare namespace TagPolicyViolationException {
644
753
  }
645
754
  export interface DeleteResourceShareRequest {
646
755
  /**
647
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
756
+ * <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
757
  */
649
758
  resourceShareArn: string | undefined;
650
759
  /**
651
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
760
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
761
+ * ensure the idempotency of the request. This lets you safely retry the request without
762
+ * accidentally performing the same operation a second time. Passing the same value to a
763
+ * later call to an operation requires that you also pass the same value for all other
764
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
765
+ * value.</a>.</p>
766
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
767
+ * you.</p>
652
768
  */
653
769
  clientToken?: string;
654
770
  }
@@ -660,11 +776,15 @@ export declare namespace DeleteResourceShareRequest {
660
776
  }
661
777
  export interface DeleteResourceShareResponse {
662
778
  /**
663
- * <p>Indicates whether the request succeeded.</p>
779
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
780
+ * A value of <code>false</code> indicates that the request failed.</p>
664
781
  */
665
782
  returnValue?: boolean;
666
783
  /**
667
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
784
+ * <p>The idempotency identifier associated with this request. If you
785
+ * want to repeat the same operation in an idempotent manner then you must include this
786
+ * value in the <code>clientToken</code> request parameter of that later call. All other
787
+ * parameters must also have the same values that you used in the first call.</p>
668
788
  */
669
789
  clientToken?: string;
670
790
  }
@@ -676,19 +796,61 @@ export declare namespace DeleteResourceShareResponse {
676
796
  }
677
797
  export interface DisassociateResourceShareRequest {
678
798
  /**
679
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
799
+ * <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
800
  */
681
801
  resourceShareArn: string | undefined;
682
802
  /**
683
- * <p>The Amazon Resource Names (ARNs) of the resources.</p>
803
+ * <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
804
+ * the resource share. After the operation runs, these resources are no longer shared with principals
805
+ * outside of the Amazon Web Services account that created the resources.</p>
684
806
  */
685
807
  resourceArns?: string[];
686
808
  /**
687
- * <p>The principals.</p>
809
+ * <p>Specifies a list of one or more principals that no longer are to have access to the
810
+ * resources in this resource share.</p>
811
+ * <p>You can include the following values:</p>
812
+ * <ul>
813
+ * <li>
814
+ * <p>An Amazon Web Services account ID, for example: <code>123456789012</code>
815
+ * </p>
816
+ * </li>
817
+ * <li>
818
+ * <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:
819
+ * <code>organizations::123456789012:organization/o-exampleorgid</code>
820
+ * </p>
821
+ * </li>
822
+ * <li>
823
+ * <p>An ARN of an organizational unit (OU) in Organizations, for example:
824
+ * <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code>
825
+ * </p>
826
+ * </li>
827
+ * <li>
828
+ * <p>An ARN of an IAM role, for example:
829
+ * <code>iam::123456789012:role/rolename</code>
830
+ * </p>
831
+ * </li>
832
+ * <li>
833
+ * <p>An ARN of an IAM user, for example:
834
+ * <code>iam::123456789012user/username</code>
835
+ * </p>
836
+ * </li>
837
+ * </ul>
838
+ * <note>
839
+ * <p>Not all resource types can be shared with IAM roles and users.
840
+ * 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
841
+ * Guide</i>.</p>
842
+ * </note>
688
843
  */
689
844
  principals?: string[];
690
845
  /**
691
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
846
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
847
+ * ensure the idempotency of the request. This lets you safely retry the request without
848
+ * accidentally performing the same operation a second time. Passing the same value to a
849
+ * later call to an operation requires that you also pass the same value for all other
850
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
851
+ * value.</a>.</p>
852
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
853
+ * you.</p>
692
854
  */
693
855
  clientToken?: string;
694
856
  }
@@ -700,11 +862,15 @@ export declare namespace DisassociateResourceShareRequest {
700
862
  }
701
863
  export interface DisassociateResourceShareResponse {
702
864
  /**
703
- * <p>Information about the associations.</p>
865
+ * <p>An array of objects that contain information about the updated associations for this
866
+ * resource share.</p>
704
867
  */
705
868
  resourceShareAssociations?: ResourceShareAssociation[];
706
869
  /**
707
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
870
+ * <p>The idempotency identifier associated with this request. If you
871
+ * want to repeat the same operation in an idempotent manner then you must include this
872
+ * value in the <code>clientToken</code> request parameter of that later call. All other
873
+ * parameters must also have the same values that you used in the first call.</p>
708
874
  */
709
875
  clientToken?: string;
710
876
  }
@@ -716,15 +882,23 @@ export declare namespace DisassociateResourceShareResponse {
716
882
  }
717
883
  export interface DisassociateResourceSharePermissionRequest {
718
884
  /**
719
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
885
+ * <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
886
  */
721
887
  resourceShareArn: string | undefined;
722
888
  /**
723
- * <p>The Amazon Resource Name (ARN) of the permission to disassociate from the resource share.</p>
889
+ * <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
890
+ * take effect immediately.</p>
724
891
  */
725
892
  permissionArn: string | undefined;
726
893
  /**
727
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
894
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
895
+ * ensure the idempotency of the request. This lets you safely retry the request without
896
+ * accidentally performing the same operation a second time. Passing the same value to a
897
+ * later call to an operation requires that you also pass the same value for all other
898
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
899
+ * value.</a>.</p>
900
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
901
+ * you.</p>
728
902
  */
729
903
  clientToken?: string;
730
904
  }
@@ -736,11 +910,15 @@ export declare namespace DisassociateResourceSharePermissionRequest {
736
910
  }
737
911
  export interface DisassociateResourceSharePermissionResponse {
738
912
  /**
739
- * <p>Indicates whether the request succeeded.</p>
913
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
914
+ * A value of <code>false</code> indicates that the request failed.</p>
740
915
  */
741
916
  returnValue?: boolean;
742
917
  /**
743
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
918
+ * <p>The idempotency identifier associated with this request. If you
919
+ * want to repeat the same operation in an idempotent manner then you must include this
920
+ * value in the <code>clientToken</code> request parameter of that later call. All other
921
+ * parameters must also have the same values that you used in the first call.</p>
744
922
  */
745
923
  clientToken?: string;
746
924
  }
@@ -760,7 +938,8 @@ export declare namespace EnableSharingWithAwsOrganizationRequest {
760
938
  }
761
939
  export interface EnableSharingWithAwsOrganizationResponse {
762
940
  /**
763
- * <p>Indicates whether the request succeeded.</p>
941
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
942
+ * A value of <code>false</code> indicates that the request failed.</p>
764
943
  */
765
944
  returnValue?: boolean;
766
945
  }
@@ -772,11 +951,14 @@ export declare namespace EnableSharingWithAwsOrganizationResponse {
772
951
  }
773
952
  export interface GetPermissionRequest {
774
953
  /**
775
- * <p>The Amazon Resource Name (ARN) of the permission.</p>
954
+ * <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.
955
+ * 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
956
+ * then choose the name of the permission. The ARN is displayed on the detail page.</p>
776
957
  */
777
958
  permissionArn: string | undefined;
778
959
  /**
779
- * <p>The identifier for the version of the permission.</p>
960
+ * <p>Specifies identifier for the version of the RAM permission to retrieve. If you don't
961
+ * specify this parameter, the operation retrieves the default version.</p>
780
962
  */
781
963
  permissionVersion?: number;
782
964
  }
@@ -791,30 +973,30 @@ export declare namespace GetPermissionRequest {
791
973
  */
792
974
  export interface ResourceSharePermissionDetail {
793
975
  /**
794
- * <p>The Amazon Resource Name (ARN) of the permission.</p>
976
+ * <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
977
  */
796
978
  arn?: string;
797
979
  /**
798
- * <p>The identifier for the version of the permission.</p>
980
+ * <p>The version of the permission represented in this structure.</p>
799
981
  */
800
982
  version?: string;
801
983
  /**
802
- * <p>Specifies whether the version of the permission is set to the default version for this
803
- * permission.</p>
984
+ * <p>Specifies whether the version of the permission represented in this structure is the
985
+ * default version for this permission.</p>
804
986
  */
805
987
  defaultVersion?: boolean;
806
988
  /**
807
- * <p>The name of the permission.</p>
989
+ * <p>The name of this permission.</p>
808
990
  */
809
991
  name?: string;
810
992
  /**
811
- * <p>The resource type to which the permission applies.</p>
993
+ * <p>The resource type to which this permission applies.</p>
812
994
  */
813
995
  resourceType?: string;
814
996
  /**
815
997
  * <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>
998
+ * whether the specified actions are allowed or denied. The <code>actions</code> list the
999
+ * operations to which the principal is granted or denied access.</p>
818
1000
  */
819
1001
  permission?: string;
820
1002
  /**
@@ -826,8 +1008,8 @@ export interface ResourceSharePermissionDetail {
826
1008
  */
827
1009
  lastUpdatedTime?: Date;
828
1010
  /**
829
- * <p>Specifies whether the version of the permission is set to the default version for this
830
- * resource type.</p>
1011
+ * <p>Specifies whether the version of the permission represented in this structure is the
1012
+ * default version for all resources of this resource type.</p>
831
1013
  */
832
1014
  isResourceTypeDefault?: boolean;
833
1015
  }
@@ -839,7 +1021,7 @@ export declare namespace ResourceSharePermissionDetail {
839
1021
  }
840
1022
  export interface GetPermissionResponse {
841
1023
  /**
842
- * <p>Information about the permission.</p>
1024
+ * <p>An object that contains information about the permission.</p>
843
1025
  */
844
1026
  permission?: ResourceSharePermissionDetail;
845
1027
  }
@@ -851,20 +1033,31 @@ export declare namespace GetPermissionResponse {
851
1033
  }
852
1034
  export interface GetResourcePoliciesRequest {
853
1035
  /**
854
- * <p>The Amazon Resource Names (ARNs) of the resources.</p>
1036
+ * <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
1037
  */
856
1038
  resourceArns: string[] | undefined;
857
1039
  /**
858
- * <p>The principal.</p>
1040
+ * <p>Specifies the principal.</p>
859
1041
  */
860
1042
  principal?: string;
861
1043
  /**
862
- * <p>The token for the next page of results.</p>
1044
+ * <p>Specifies that you want to receive the next page of results. Valid
1045
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1046
+ * did, it indicates that more output is available. Set this parameter to the value
1047
+ * provided by the previous call's <code>NextToken</code> response to request the
1048
+ * next page of results.</p>
863
1049
  */
864
1050
  nextToken?: string;
865
1051
  /**
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>
1052
+ * <p>Specifies the total number of results that you want included on each page
1053
+ * of the response. If you do not include this parameter, it defaults to a value that is
1054
+ * specific to the operation. If additional items exist beyond the number you specify, the
1055
+ * <code>NextToken</code> response element is returned with a value (not null).
1056
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1057
+ * call to the operation to get the next part of the results. Note that the service might
1058
+ * return fewer results than the maximum even when there are more results available. You
1059
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1060
+ * of the results.</p>
868
1061
  */
869
1062
  maxResults?: number;
870
1063
  }
@@ -876,11 +1069,15 @@ export declare namespace GetResourcePoliciesRequest {
876
1069
  }
877
1070
  export interface GetResourcePoliciesResponse {
878
1071
  /**
879
- * <p>A key policy document, in JSON format.</p>
1072
+ * <p>An array of resource policy documents in JSON format.</p>
880
1073
  */
881
1074
  policies?: string[];
882
1075
  /**
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>
1076
+ * <p>If present, this value indicates that more output is available than
1077
+ * is included in the current response. Use this value in the <code>NextToken</code>
1078
+ * request parameter in a subsequent call to the operation to get the next part of the
1079
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1080
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
884
1081
  */
885
1082
  nextToken?: string;
886
1083
  }
@@ -891,7 +1088,7 @@ export declare namespace GetResourcePoliciesResponse {
891
1088
  const filterSensitiveLog: (obj: GetResourcePoliciesResponse) => any;
892
1089
  }
893
1090
  /**
894
- * <p>The specified value for NextToken is not valid.</p>
1091
+ * <p>The specified value for <code>NextToken</code> is not valid.</p>
895
1092
  */
896
1093
  export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
897
1094
  name: "InvalidNextTokenException";
@@ -905,7 +1102,7 @@ export declare namespace InvalidNextTokenException {
905
1102
  const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
906
1103
  }
907
1104
  /**
908
- * <p>An Amazon Resource Name (ARN) was not found.</p>
1105
+ * <p>The specified Amazon Resource Name (ARN) was not found.</p>
909
1106
  */
910
1107
  export interface ResourceArnNotFoundException extends __SmithyException, $MetadataBearer {
911
1108
  name: "ResourceArnNotFoundException";
@@ -920,36 +1117,63 @@ export declare namespace ResourceArnNotFoundException {
920
1117
  }
921
1118
  export interface GetResourceShareAssociationsRequest {
922
1119
  /**
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>
1120
+ * <p>Specifies whether you want to retrieve the associations that involve a specified
1121
+ * resource or principal.</p>
1122
+ * <ul>
1123
+ * <li>
1124
+ * <p>
1125
+ * <code>PRINCIPAL</code> – list the principals that are associated with
1126
+ * the specified resource share.</p>
1127
+ * </li>
1128
+ * <li>
1129
+ * <p>
1130
+ * <code>RESOURCE</code> – list the resources that are associated with the
1131
+ * specified resource share.</p>
1132
+ * </li>
1133
+ * </ul>
926
1134
  */
927
1135
  associationType: ResourceShareAssociationType | string | undefined;
928
1136
  /**
929
- * <p>The Amazon Resource Names (ARN) of the resource shares.</p>
1137
+ * <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
1138
+ * retrieve.</p>
930
1139
  */
931
1140
  resourceShareArns?: string[];
932
1141
  /**
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>
1142
+ * <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>
1143
+ * <p>You cannot specify this parameter if the association type is
1144
+ * <code>PRINCIPAL</code>.</p>
935
1145
  */
936
1146
  resourceArn?: string;
937
1147
  /**
938
- * <p>The principal. You cannot specify this parameter if the association type is
939
- * <code>RESOURCE</code>.</p>
1148
+ * <p>Specifies the ID of the principal whose resource shares you want to retrieve. This can be an
1149
+ * 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
1150
+ * individual IAM user or role.</p>
1151
+ * <p>You cannot specify this parameter if the association type is
1152
+ * <code>RESOURCE</code>.</p>
940
1153
  */
941
1154
  principal?: string;
942
1155
  /**
943
- * <p>The association status.</p>
1156
+ * <p>Specifies that you want to retrieve only associations with this status.</p>
944
1157
  */
945
1158
  associationStatus?: ResourceShareAssociationStatus | string;
946
1159
  /**
947
- * <p>The token for the next page of results.</p>
1160
+ * <p>Specifies that you want to receive the next page of results. Valid
1161
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1162
+ * did, it indicates that more output is available. Set this parameter to the value
1163
+ * provided by the previous call's <code>NextToken</code> response to request the
1164
+ * next page of results.</p>
948
1165
  */
949
1166
  nextToken?: string;
950
1167
  /**
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>
1168
+ * <p>Specifies the total number of results that you want included on each page
1169
+ * of the response. If you do not include this parameter, it defaults to a value that is
1170
+ * specific to the operation. If additional items exist beyond the number you specify, the
1171
+ * <code>NextToken</code> response element is returned with a value (not null).
1172
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1173
+ * call to the operation to get the next part of the results. Note that the service might
1174
+ * return fewer results than the maximum even when there are more results available. You
1175
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1176
+ * of the results.</p>
953
1177
  */
954
1178
  maxResults?: number;
955
1179
  }
@@ -961,11 +1185,15 @@ export declare namespace GetResourceShareAssociationsRequest {
961
1185
  }
962
1186
  export interface GetResourceShareAssociationsResponse {
963
1187
  /**
964
- * <p>Information about the associations.</p>
1188
+ * <p>An array of objects that contain the details about the associations.</p>
965
1189
  */
966
1190
  resourceShareAssociations?: ResourceShareAssociation[];
967
1191
  /**
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>
1192
+ * <p>If present, this value indicates that more output is available than
1193
+ * is included in the current response. Use this value in the <code>NextToken</code>
1194
+ * request parameter in a subsequent call to the operation to get the next part of the
1195
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1196
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
969
1197
  */
970
1198
  nextToken?: string;
971
1199
  }
@@ -977,20 +1205,33 @@ export declare namespace GetResourceShareAssociationsResponse {
977
1205
  }
978
1206
  export interface GetResourceShareInvitationsRequest {
979
1207
  /**
980
- * <p>The Amazon Resource Names (ARN) of the invitations.</p>
1208
+ * <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
1209
  */
982
1210
  resourceShareInvitationArns?: string[];
983
1211
  /**
984
- * <p>The Amazon Resource Names (ARN) of the resource shares.</p>
1212
+ * <p>Specifies that you want details about invitations only for the resource shares described by this
1213
+ * list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
1214
+ * </p>
985
1215
  */
986
1216
  resourceShareArns?: string[];
987
1217
  /**
988
- * <p>The token for the next page of results.</p>
1218
+ * <p>Specifies that you want to receive the next page of results. Valid
1219
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1220
+ * did, it indicates that more output is available. Set this parameter to the value
1221
+ * provided by the previous call's <code>NextToken</code> response to request the
1222
+ * next page of results.</p>
989
1223
  */
990
1224
  nextToken?: string;
991
1225
  /**
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>
1226
+ * <p>Specifies the total number of results that you want included on each page
1227
+ * of the response. If you do not include this parameter, it defaults to a value that is
1228
+ * specific to the operation. If additional items exist beyond the number you specify, the
1229
+ * <code>NextToken</code> response element is returned with a value (not null).
1230
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1231
+ * call to the operation to get the next part of the results. Note that the service might
1232
+ * return fewer results than the maximum even when there are more results available. You
1233
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1234
+ * of the results.</p>
994
1235
  */
995
1236
  maxResults?: number;
996
1237
  }
@@ -1002,11 +1243,15 @@ export declare namespace GetResourceShareInvitationsRequest {
1002
1243
  }
1003
1244
  export interface GetResourceShareInvitationsResponse {
1004
1245
  /**
1005
- * <p>Information about the invitations.</p>
1246
+ * <p>An array of objects that contain the details about the invitations.</p>
1006
1247
  */
1007
1248
  resourceShareInvitations?: ResourceShareInvitation[];
1008
1249
  /**
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>
1250
+ * <p>If present, this value indicates that more output is available than
1251
+ * is included in the current response. Use this value in the <code>NextToken</code>
1252
+ * request parameter in a subsequent call to the operation to get the next part of the
1253
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1254
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1010
1255
  */
1011
1256
  nextToken?: string;
1012
1257
  }
@@ -1017,7 +1262,7 @@ export declare namespace GetResourceShareInvitationsResponse {
1017
1262
  const filterSensitiveLog: (obj: GetResourceShareInvitationsResponse) => any;
1018
1263
  }
1019
1264
  /**
1020
- * <p>The specified value for MaxResults is not valid.</p>
1265
+ * <p>The specified value for <code>MaxResults</code> is not valid.</p>
1021
1266
  */
1022
1267
  export interface InvalidMaxResultsException extends __SmithyException, $MetadataBearer {
1023
1268
  name: "InvalidMaxResultsException";
@@ -1035,15 +1280,17 @@ export declare enum ResourceOwner {
1035
1280
  SELF = "SELF"
1036
1281
  }
1037
1282
  /**
1038
- * <p>Used to filter information based on tags.</p>
1283
+ * <p>A tag key and optional list of possible values that you can use to filter results for
1284
+ * tagged resources.</p>
1039
1285
  */
1040
1286
  export interface TagFilter {
1041
1287
  /**
1042
- * <p>The tag key.</p>
1288
+ * <p>The tag key. This must have a valid string value and can't be empty.</p>
1043
1289
  */
1044
1290
  tagKey?: string;
1045
1291
  /**
1046
- * <p>The tag values.</p>
1292
+ * <p>A list of zero or more tag values. If no values are provided, then the filter matches
1293
+ * any tag with the specified key, regardless of its value.</p>
1047
1294
  */
1048
1295
  tagValues?: string[];
1049
1296
  }
@@ -1055,37 +1302,68 @@ export declare namespace TagFilter {
1055
1302
  }
1056
1303
  export interface GetResourceSharesRequest {
1057
1304
  /**
1058
- * <p>The Amazon Resource Names (ARNs) of the resource shares.</p>
1305
+ * <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
1306
  */
1060
1307
  resourceShareArns?: string[];
1061
1308
  /**
1062
- * <p>The status of the resource share.</p>
1309
+ * <p>Specifies that you want to retrieve details of only those resource shares that have this
1310
+ * status.</p>
1063
1311
  */
1064
1312
  resourceShareStatus?: ResourceShareStatus | string;
1065
1313
  /**
1066
- * <p>The type of owner.</p>
1314
+ * <p>Specifies that you want to retrieve details of only those resource shares that match the
1315
+ * following:</p>
1316
+ * <ul>
1317
+ * <li>
1318
+ * <p>
1319
+ * <b>
1320
+ * <code>SELF</code>
1321
+ * </b> – resources that you
1322
+ * are sharing</p>
1323
+ * </li>
1324
+ * <li>
1325
+ * <p>
1326
+ * <b>
1327
+ * <code>OTHER-ACCOUNTS</code>
1328
+ * </b> –
1329
+ * resources that other accounts share with you</p>
1330
+ * </li>
1331
+ * </ul>
1067
1332
  */
1068
1333
  resourceOwner: ResourceOwner | string | undefined;
1069
1334
  /**
1070
- * <p>The name of the resource share.</p>
1335
+ * <p>Specifies the name of an individual resource share that you want to retrieve details
1336
+ * about.</p>
1071
1337
  */
1072
1338
  name?: string;
1073
1339
  /**
1074
- * <p>One or more tag filters.</p>
1340
+ * <p>Specifies that you want to retrieve details of only those resource shares that match the
1341
+ * specified tag keys and values.</p>
1075
1342
  */
1076
1343
  tagFilters?: TagFilter[];
1077
1344
  /**
1078
- * <p>The token for the next page of results.</p>
1345
+ * <p>Specifies that you want to receive the next page of results. Valid
1346
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1347
+ * did, it indicates that more output is available. Set this parameter to the value
1348
+ * provided by the previous call's <code>NextToken</code> response to request the
1349
+ * next page of results.</p>
1079
1350
  */
1080
1351
  nextToken?: string;
1081
1352
  /**
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>
1353
+ * <p>Specifies the total number of results that you want included on each page
1354
+ * of the response. If you do not include this parameter, it defaults to a value that is
1355
+ * specific to the operation. If additional items exist beyond the number you specify, the
1356
+ * <code>NextToken</code> response element is returned with a value (not null).
1357
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1358
+ * call to the operation to get the next part of the results. Note that the service might
1359
+ * return fewer results than the maximum even when there are more results available. You
1360
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1361
+ * of the results.</p>
1084
1362
  */
1085
1363
  maxResults?: number;
1086
1364
  /**
1087
- * <p>The Amazon Resource Name (ARN) of the RAM permission that is associated with the
1088
- * resource share.</p>
1365
+ * <p>Specifies that you want to retrieve details of only those resource shares that use the RAM
1366
+ * 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
1367
  */
1090
1368
  permissionArn?: string;
1091
1369
  }
@@ -1097,11 +1375,15 @@ export declare namespace GetResourceSharesRequest {
1097
1375
  }
1098
1376
  export interface GetResourceSharesResponse {
1099
1377
  /**
1100
- * <p>Information about the resource shares.</p>
1378
+ * <p>An array of objects that contain the information about the resource shares.</p>
1101
1379
  */
1102
1380
  resourceShares?: ResourceShare[];
1103
1381
  /**
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>
1382
+ * <p>If present, this value indicates that more output is available than
1383
+ * is included in the current response. Use this value in the <code>NextToken</code>
1384
+ * request parameter in a subsequent call to the operation to get the next part of the
1385
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1386
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1105
1387
  */
1106
1388
  nextToken?: string;
1107
1389
  }
@@ -1111,20 +1393,59 @@ export declare namespace GetResourceSharesResponse {
1111
1393
  */
1112
1394
  const filterSensitiveLog: (obj: GetResourceSharesResponse) => any;
1113
1395
  }
1396
+ export declare enum ResourceRegionScopeFilter {
1397
+ ALL = "ALL",
1398
+ GLOBAL = "GLOBAL",
1399
+ REGIONAL = "REGIONAL"
1400
+ }
1114
1401
  export interface ListPendingInvitationResourcesRequest {
1115
1402
  /**
1116
- * <p>The Amazon Resource Name (ARN) of the invitation.</p>
1403
+ * <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
1404
  */
1118
1405
  resourceShareInvitationArn: string | undefined;
1119
1406
  /**
1120
- * <p>The token for the next page of results.</p>
1407
+ * <p>Specifies that you want to receive the next page of results. Valid
1408
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1409
+ * did, it indicates that more output is available. Set this parameter to the value
1410
+ * provided by the previous call's <code>NextToken</code> response to request the
1411
+ * next page of results.</p>
1121
1412
  */
1122
1413
  nextToken?: string;
1123
1414
  /**
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>
1415
+ * <p>Specifies the total number of results that you want included on each page
1416
+ * of the response. If you do not include this parameter, it defaults to a value that is
1417
+ * specific to the operation. If additional items exist beyond the number you specify, the
1418
+ * <code>NextToken</code> response element is returned with a value (not null).
1419
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1420
+ * call to the operation to get the next part of the results. Note that the service might
1421
+ * return fewer results than the maximum even when there are more results available. You
1422
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1423
+ * of the results.</p>
1126
1424
  */
1127
1425
  maxResults?: number;
1426
+ /**
1427
+ * <p>Specifies that you want the results to include only
1428
+ * resources that have the specified scope.</p>
1429
+ * <ul>
1430
+ * <li>
1431
+ * <p>
1432
+ * <code>ALL</code> – the results include both global and
1433
+ * regional resources or resource types.</p>
1434
+ * </li>
1435
+ * <li>
1436
+ * <p>
1437
+ * <code>GLOBAL</code> – the results include only global
1438
+ * resources or resource types.</p>
1439
+ * </li>
1440
+ * <li>
1441
+ * <p>
1442
+ * <code>REGIONAL</code> – the results include only regional
1443
+ * resources or resource types.</p>
1444
+ * </li>
1445
+ * </ul>
1446
+ * <p>The default value is <code>ALL</code>.</p>
1447
+ */
1448
+ resourceRegionScope?: ResourceRegionScopeFilter | string;
1128
1449
  }
1129
1450
  export declare namespace ListPendingInvitationResourcesRequest {
1130
1451
  /**
@@ -1132,30 +1453,36 @@ export declare namespace ListPendingInvitationResourcesRequest {
1132
1453
  */
1133
1454
  const filterSensitiveLog: (obj: ListPendingInvitationResourcesRequest) => any;
1134
1455
  }
1456
+ export declare enum ResourceRegionScope {
1457
+ GLOBAL = "GLOBAL",
1458
+ REGIONAL = "REGIONAL"
1459
+ }
1135
1460
  export declare type ResourceStatus = "AVAILABLE" | "LIMIT_EXCEEDED" | "PENDING" | "UNAVAILABLE" | "ZONAL_RESOURCE_INACCESSIBLE";
1136
1461
  /**
1137
- * <p>Describes a resource associated with a resource share.</p>
1462
+ * <p>Describes a resource associated with a resource share in RAM.</p>
1138
1463
  */
1139
1464
  export interface Resource {
1140
1465
  /**
1141
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
1466
+ * <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
1467
  */
1143
1468
  arn?: string;
1144
1469
  /**
1145
- * <p>The resource type.</p>
1470
+ * <p>The resource type. This takes the form of:
1471
+ * <code>service-code</code>:<code>resource-code</code>
1472
+ * </p>
1146
1473
  */
1147
1474
  type?: string;
1148
1475
  /**
1149
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
1476
+ * <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
1477
  */
1151
1478
  resourceShareArn?: string;
1152
1479
  /**
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>
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 resource group. This value is available only if the resource is
1481
+ * part of a resource group.</p>
1155
1482
  */
1156
1483
  resourceGroupArn?: string;
1157
1484
  /**
1158
- * <p>The status of the resource.</p>
1485
+ * <p>The current status of the resource.</p>
1159
1486
  */
1160
1487
  status?: ResourceStatus | string;
1161
1488
  /**
@@ -1163,13 +1490,30 @@ export interface Resource {
1163
1490
  */
1164
1491
  statusMessage?: string;
1165
1492
  /**
1166
- * <p>The time when the resource was associated with the resource share.</p>
1493
+ * <p>The date and time when the resource was associated with the resource share.</p>
1167
1494
  */
1168
1495
  creationTime?: Date;
1169
1496
  /**
1170
- * <p>The time when the association was last updated.</p>
1497
+ * <p>The date an time when the association was last updated.</p>
1171
1498
  */
1172
1499
  lastUpdatedTime?: Date;
1500
+ /**
1501
+ * <p>Specifies the scope of visibility of this resource:</p>
1502
+ * <ul>
1503
+ * <li>
1504
+ * <p>
1505
+ * <b>REGIONAL</b> – The resource can be
1506
+ * accessed only by using requests that target the Amazon Web Services Region in which the
1507
+ * resource exists.</p>
1508
+ * </li>
1509
+ * <li>
1510
+ * <p>
1511
+ * <b>GLOBAL</b> – The resource can be accessed
1512
+ * from any Amazon Web Services Region.</p>
1513
+ * </li>
1514
+ * </ul>
1515
+ */
1516
+ resourceRegionScope?: ResourceRegionScope | string;
1173
1517
  }
1174
1518
  export declare namespace Resource {
1175
1519
  /**
@@ -1179,11 +1523,16 @@ export declare namespace Resource {
1179
1523
  }
1180
1524
  export interface ListPendingInvitationResourcesResponse {
1181
1525
  /**
1182
- * <p>Information about the resources included the resource share.</p>
1526
+ * <p>An array of objects that contain the information about the resources included the
1527
+ * specified resource share.</p>
1183
1528
  */
1184
1529
  resources?: Resource[];
1185
1530
  /**
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>
1531
+ * <p>If present, this value indicates that more output is available than
1532
+ * is included in the current response. Use this value in the <code>NextToken</code>
1533
+ * request parameter in a subsequent call to the operation to get the next part of the
1534
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1535
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1187
1536
  */
1188
1537
  nextToken?: string;
1189
1538
  }
@@ -1209,17 +1558,30 @@ export declare namespace MissingRequiredParameterException {
1209
1558
  }
1210
1559
  export interface ListPermissionsRequest {
1211
1560
  /**
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>
1561
+ * <p>Specifies that you want to list permissions for only the specified resource type. For
1562
+ * example, to list only permissions that apply to EC2 subnets, specify
1563
+ * <code>ec2:Subnet</code>. You can use the <a>ListResourceTypes</a>
1564
+ * operation to get the specific string required.</p>
1214
1565
  */
1215
1566
  resourceType?: string;
1216
1567
  /**
1217
- * <p>The token for the next page of results.</p>
1568
+ * <p>Specifies that you want to receive the next page of results. Valid
1569
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1570
+ * did, it indicates that more output is available. Set this parameter to the value
1571
+ * provided by the previous call's <code>NextToken</code> response to request the
1572
+ * next page of results.</p>
1218
1573
  */
1219
1574
  nextToken?: string;
1220
1575
  /**
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>
1576
+ * <p>Specifies the total number of results that you want included on each page
1577
+ * of the response. If you do not include this parameter, it defaults to a value that is
1578
+ * specific to the operation. If additional items exist beyond the number you specify, the
1579
+ * <code>NextToken</code> response element is returned with a value (not null).
1580
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1581
+ * call to the operation to get the next part of the results. Note that the service might
1582
+ * return fewer results than the maximum even when there are more results available. You
1583
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1584
+ * of the results.</p>
1223
1585
  */
1224
1586
  maxResults?: number;
1225
1587
  }
@@ -1230,28 +1592,29 @@ export declare namespace ListPermissionsRequest {
1230
1592
  const filterSensitiveLog: (obj: ListPermissionsRequest) => any;
1231
1593
  }
1232
1594
  /**
1233
- * <p>Information about a permission that is associated with a resource share.</p>
1595
+ * <p>Information about an RAM permission that is associated with a resource share and any of its
1596
+ * resources of a specified type.</p>
1234
1597
  */
1235
1598
  export interface ResourceSharePermissionSummary {
1236
1599
  /**
1237
- * <p>The Amazon Resource Name (ARN) of the permission.</p>
1600
+ * <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
1601
  */
1239
1602
  arn?: string;
1240
1603
  /**
1241
- * <p>The identifier for the version of the permission.</p>
1604
+ * <p>The version of the permission represented in this structure.</p>
1242
1605
  */
1243
1606
  version?: string;
1244
1607
  /**
1245
- * <p>Specifies whether the version of the permission is set to the default version for this
1246
- * permission.</p>
1608
+ * <p>Specifies whether the version of the permission represented in this structure is the
1609
+ * default version for this permission.</p>
1247
1610
  */
1248
1611
  defaultVersion?: boolean;
1249
1612
  /**
1250
- * <p>The name of the permission.</p>
1613
+ * <p>The name of this permission.</p>
1251
1614
  */
1252
1615
  name?: string;
1253
1616
  /**
1254
- * <p>The type of resource to which the permission applies.</p>
1617
+ * <p>The type of resource to which this permission applies.</p>
1255
1618
  */
1256
1619
  resourceType?: string;
1257
1620
  /**
@@ -1267,8 +1630,8 @@ export interface ResourceSharePermissionSummary {
1267
1630
  */
1268
1631
  lastUpdatedTime?: Date;
1269
1632
  /**
1270
- * <p>Specifies whether the version of the permission is set to the default version for this
1271
- * resource type.</p>
1633
+ * <p>Specifies whether the version of the permission represented in this structure is the
1634
+ * default version for all resources of this resource type.</p>
1272
1635
  */
1273
1636
  isResourceTypeDefault?: boolean;
1274
1637
  }
@@ -1280,11 +1643,15 @@ export declare namespace ResourceSharePermissionSummary {
1280
1643
  }
1281
1644
  export interface ListPermissionsResponse {
1282
1645
  /**
1283
- * <p>Information about the permissions.</p>
1646
+ * <p>An array of objects with information about the permissions.</p>
1284
1647
  */
1285
1648
  permissions?: ResourceSharePermissionSummary[];
1286
1649
  /**
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>
1650
+ * <p>If present, this value indicates that more output is available than
1651
+ * is included in the current response. Use this value in the <code>NextToken</code>
1652
+ * request parameter in a subsequent call to the operation to get the next part of the
1653
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1654
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1288
1655
  */
1289
1656
  nextToken?: string;
1290
1657
  }
@@ -1296,34 +1663,96 @@ export declare namespace ListPermissionsResponse {
1296
1663
  }
1297
1664
  export interface ListPrincipalsRequest {
1298
1665
  /**
1299
- * <p>The type of owner.</p>
1666
+ * <p>Specifies that you want to list information for only resource shares that match the
1667
+ * following:</p>
1668
+ * <ul>
1669
+ * <li>
1670
+ * <p>
1671
+ * <b>
1672
+ * <code>SELF</code>
1673
+ * </b> – resources that you
1674
+ * are sharing</p>
1675
+ * </li>
1676
+ * <li>
1677
+ * <p>
1678
+ * <b>
1679
+ * <code>OTHER-ACCOUNTS</code>
1680
+ * </b> –
1681
+ * resources that other accounts share with you</p>
1682
+ * </li>
1683
+ * </ul>
1300
1684
  */
1301
1685
  resourceOwner: ResourceOwner | string | undefined;
1302
1686
  /**
1303
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
1687
+ * <p>Specifies that you want to list principal information for the resource share with the specified
1688
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resoure Name (ARN)</a>.</p>
1304
1689
  */
1305
1690
  resourceArn?: string;
1306
1691
  /**
1307
- * <p>The principals.</p>
1692
+ * <p>Specifies that you want to list information for only the listed principals.</p>
1693
+ * <p>You can include the following values:</p>
1694
+ * <ul>
1695
+ * <li>
1696
+ * <p>An Amazon Web Services account ID, for example: <code>123456789012</code>
1697
+ * </p>
1698
+ * </li>
1699
+ * <li>
1700
+ * <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:
1701
+ * <code>organizations::123456789012:organization/o-exampleorgid</code>
1702
+ * </p>
1703
+ * </li>
1704
+ * <li>
1705
+ * <p>An ARN of an organizational unit (OU) in Organizations, for example:
1706
+ * <code>organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123</code>
1707
+ * </p>
1708
+ * </li>
1709
+ * <li>
1710
+ * <p>An ARN of an IAM role, for example:
1711
+ * <code>iam::123456789012:role/rolename</code>
1712
+ * </p>
1713
+ * </li>
1714
+ * <li>
1715
+ * <p>An ARN of an IAM user, for example:
1716
+ * <code>iam::123456789012user/username</code>
1717
+ * </p>
1718
+ * </li>
1719
+ * </ul>
1720
+ * <note>
1721
+ * <p>Not all resource types can be shared with IAM roles and users.
1722
+ * 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
1723
+ * Guide</i>.</p>
1724
+ * </note>
1308
1725
  */
1309
1726
  principals?: string[];
1310
1727
  /**
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>
1728
+ * <p>Specifies that you want to list information for only principals associated with resource shares
1729
+ * that include the specified resource type.</p>
1730
+ * <p>For a list of valid values, query the <a>ListResourceTypes</a> operation.</p>
1314
1731
  */
1315
1732
  resourceType?: string;
1316
1733
  /**
1317
- * <p>The Amazon Resource Names (ARN) of the resource shares.</p>
1734
+ * <p>Specifies that you want to list information for only principals associated with the
1735
+ * 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
1736
  */
1319
1737
  resourceShareArns?: string[];
1320
1738
  /**
1321
- * <p>The token for the next page of results.</p>
1739
+ * <p>Specifies that you want to receive the next page of results. Valid
1740
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1741
+ * did, it indicates that more output is available. Set this parameter to the value
1742
+ * provided by the previous call's <code>NextToken</code> response to request the
1743
+ * next page of results.</p>
1322
1744
  */
1323
1745
  nextToken?: string;
1324
1746
  /**
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>
1747
+ * <p>Specifies the total number of results that you want included on each page
1748
+ * of the response. If you do not include this parameter, it defaults to a value that is
1749
+ * specific to the operation. If additional items exist beyond the number you specify, the
1750
+ * <code>NextToken</code> response element is returned with a value (not null).
1751
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1752
+ * call to the operation to get the next part of the results. Note that the service might
1753
+ * return fewer results than the maximum even when there are more results available. You
1754
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1755
+ * of the results.</p>
1327
1756
  */
1328
1757
  maxResults?: number;
1329
1758
  }
@@ -1342,15 +1771,15 @@ export interface Principal {
1342
1771
  */
1343
1772
  id?: string;
1344
1773
  /**
1345
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
1774
+ * <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
1775
  */
1347
1776
  resourceShareArn?: string;
1348
1777
  /**
1349
- * <p>The time when the principal was associated with the resource share.</p>
1778
+ * <p>The date and time when the principal was associated with the resource share.</p>
1350
1779
  */
1351
1780
  creationTime?: Date;
1352
1781
  /**
1353
- * <p>The time when the association was last updated.</p>
1782
+ * <p>The date and time when the association was last updated.</p>
1354
1783
  */
1355
1784
  lastUpdatedTime?: Date;
1356
1785
  /**
@@ -1367,11 +1796,15 @@ export declare namespace Principal {
1367
1796
  }
1368
1797
  export interface ListPrincipalsResponse {
1369
1798
  /**
1370
- * <p>The principals.</p>
1799
+ * <p>An array of objects that contain the details about the principals.</p>
1371
1800
  */
1372
1801
  principals?: Principal[];
1373
1802
  /**
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>
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>
1375
1808
  */
1376
1809
  nextToken?: string;
1377
1810
  }
@@ -1397,36 +1830,89 @@ export declare namespace InvalidResourceTypeException {
1397
1830
  }
1398
1831
  export interface ListResourcesRequest {
1399
1832
  /**
1400
- * <p>The type of owner.</p>
1833
+ * <p>Specifies that you want to list only the resource shares that match the following:</p>
1834
+ * <ul>
1835
+ * <li>
1836
+ * <p>
1837
+ * <b>
1838
+ * <code>SELF</code>
1839
+ * </b> – resources that you
1840
+ * are sharing</p>
1841
+ * </li>
1842
+ * <li>
1843
+ * <p>
1844
+ * <b>
1845
+ * <code>OTHER-ACCOUNTS</code>
1846
+ * </b> –
1847
+ * resources that other accounts share with you</p>
1848
+ * </li>
1849
+ * </ul>
1401
1850
  */
1402
1851
  resourceOwner: ResourceOwner | string | undefined;
1403
1852
  /**
1404
- * <p>The principal.</p>
1853
+ * <p>Specifies that you want to list only the resource shares that are associated with the specified
1854
+ * principal.</p>
1405
1855
  */
1406
1856
  principal?: string;
1407
1857
  /**
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>
1858
+ * <p>Specifies that you want to list only the resource shares that include resources of the specified
1859
+ * resource type.</p>
1860
+ * <p>For valid values, query the <a>ListResourceTypes</a> operation.</p>
1411
1861
  */
1412
1862
  resourceType?: string;
1413
1863
  /**
1414
- * <p>The Amazon Resource Names (ARNs) of the resources.</p>
1864
+ * <p>Specifies that you want to list only the resource shares that include resources with the
1865
+ * specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
1415
1866
  */
1416
1867
  resourceArns?: string[];
1417
1868
  /**
1418
- * <p>The Amazon Resource Names (ARN) of the resource shares.</p>
1869
+ * <p>Specifies that you want to list only resources in the resource shares identified by the
1870
+ * specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
1419
1871
  */
1420
1872
  resourceShareArns?: string[];
1421
1873
  /**
1422
- * <p>The token for the next page of results.</p>
1874
+ * <p>Specifies that you want to receive the next page of results. Valid
1875
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1876
+ * did, it indicates that more output is available. Set this parameter to the value
1877
+ * provided by the previous call's <code>NextToken</code> response to request the
1878
+ * next page of results.</p>
1423
1879
  */
1424
1880
  nextToken?: string;
1425
1881
  /**
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>
1882
+ * <p>Specifies the total number of results that you want included on each page
1883
+ * of the response. If you do not include this parameter, it defaults to a value that is
1884
+ * specific to the operation. If additional items exist beyond the number you specify, the
1885
+ * <code>NextToken</code> response element is returned with a value (not null).
1886
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1887
+ * call to the operation to get the next part of the results. Note that the service might
1888
+ * return fewer results than the maximum even when there are more results available. You
1889
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1890
+ * of the results.</p>
1428
1891
  */
1429
1892
  maxResults?: number;
1893
+ /**
1894
+ * <p>Specifies that you want the results to include only
1895
+ * resources that have the specified scope.</p>
1896
+ * <ul>
1897
+ * <li>
1898
+ * <p>
1899
+ * <code>ALL</code> – the results include both global and
1900
+ * regional resources or resource types.</p>
1901
+ * </li>
1902
+ * <li>
1903
+ * <p>
1904
+ * <code>GLOBAL</code> – the results include only global
1905
+ * resources or resource types.</p>
1906
+ * </li>
1907
+ * <li>
1908
+ * <p>
1909
+ * <code>REGIONAL</code> – the results include only regional
1910
+ * resources or resource types.</p>
1911
+ * </li>
1912
+ * </ul>
1913
+ * <p>The default value is <code>ALL</code>.</p>
1914
+ */
1915
+ resourceRegionScope?: ResourceRegionScopeFilter | string;
1430
1916
  }
1431
1917
  export declare namespace ListResourcesRequest {
1432
1918
  /**
@@ -1436,11 +1922,15 @@ export declare namespace ListResourcesRequest {
1436
1922
  }
1437
1923
  export interface ListResourcesResponse {
1438
1924
  /**
1439
- * <p>Information about the resources.</p>
1925
+ * <p>An array of objects that contain information about the resources.</p>
1440
1926
  */
1441
1927
  resources?: Resource[];
1442
1928
  /**
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>
1929
+ * <p>If present, this value indicates that more output is available than
1930
+ * is included in the current response. Use this value in the <code>NextToken</code>
1931
+ * request parameter in a subsequent call to the operation to get the next part of the
1932
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1933
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1444
1934
  */
1445
1935
  nextToken?: string;
1446
1936
  }
@@ -1452,16 +1942,28 @@ export declare namespace ListResourcesResponse {
1452
1942
  }
1453
1943
  export interface ListResourceSharePermissionsRequest {
1454
1944
  /**
1455
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
1945
+ * <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
1946
+ * permissions.</p>
1456
1947
  */
1457
1948
  resourceShareArn: string | undefined;
1458
1949
  /**
1459
- * <p>The token for the next page of results.</p>
1950
+ * <p>Specifies that you want to receive the next page of results. Valid
1951
+ * only if you received a <code>NextToken</code> response in the previous request. If you
1952
+ * did, it indicates that more output is available. Set this parameter to the value
1953
+ * provided by the previous call's <code>NextToken</code> response to request the
1954
+ * next page of results.</p>
1460
1955
  */
1461
1956
  nextToken?: string;
1462
1957
  /**
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>
1958
+ * <p>Specifies the total number of results that you want included on each page
1959
+ * of the response. If you do not include this parameter, it defaults to a value that is
1960
+ * specific to the operation. If additional items exist beyond the number you specify, the
1961
+ * <code>NextToken</code> response element is returned with a value (not null).
1962
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
1963
+ * call to the operation to get the next part of the results. Note that the service might
1964
+ * return fewer results than the maximum even when there are more results available. You
1965
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
1966
+ * of the results.</p>
1465
1967
  */
1466
1968
  maxResults?: number;
1467
1969
  }
@@ -1473,11 +1975,15 @@ export declare namespace ListResourceSharePermissionsRequest {
1473
1975
  }
1474
1976
  export interface ListResourceSharePermissionsResponse {
1475
1977
  /**
1476
- * <p>The permissions associated with the resource share.</p>
1978
+ * <p>An array of objects that describe the permissions associated with the resource share.</p>
1477
1979
  */
1478
1980
  permissions?: ResourceSharePermissionSummary[];
1479
1981
  /**
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>
1982
+ * <p>If present, this value indicates that more output is available than
1983
+ * is included in the current response. Use this value in the <code>NextToken</code>
1984
+ * request parameter in a subsequent call to the operation to get the next part of the
1985
+ * output. You should repeat this until the <code>NextToken</code> response element comes
1986
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1481
1987
  */
1482
1988
  nextToken?: string;
1483
1989
  }
@@ -1489,14 +1995,48 @@ export declare namespace ListResourceSharePermissionsResponse {
1489
1995
  }
1490
1996
  export interface ListResourceTypesRequest {
1491
1997
  /**
1492
- * <p>The token for the next page of results.</p>
1998
+ * <p>Specifies that you want to receive the next page of results. Valid
1999
+ * only if you received a <code>NextToken</code> response in the previous request. If you
2000
+ * did, it indicates that more output is available. Set this parameter to the value
2001
+ * provided by the previous call's <code>NextToken</code> response to request the
2002
+ * next page of results.</p>
1493
2003
  */
1494
2004
  nextToken?: string;
1495
2005
  /**
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>
2006
+ * <p>Specifies the total number of results that you want included on each page
2007
+ * of the response. If you do not include this parameter, it defaults to a value that is
2008
+ * specific to the operation. If additional items exist beyond the number you specify, the
2009
+ * <code>NextToken</code> response element is returned with a value (not null).
2010
+ * Include the specified value as the <code>NextToken</code> request parameter in the next
2011
+ * call to the operation to get the next part of the results. Note that the service might
2012
+ * return fewer results than the maximum even when there are more results available. You
2013
+ * should check <code>NextToken</code> after every operation to ensure that you receive all
2014
+ * of the results.</p>
1498
2015
  */
1499
2016
  maxResults?: number;
2017
+ /**
2018
+ * <p>Specifies that you want the results to include only
2019
+ * resources that have the specified scope.</p>
2020
+ * <ul>
2021
+ * <li>
2022
+ * <p>
2023
+ * <code>ALL</code> – the results include both global and
2024
+ * regional resources or resource types.</p>
2025
+ * </li>
2026
+ * <li>
2027
+ * <p>
2028
+ * <code>GLOBAL</code> – the results include only global
2029
+ * resources or resource types.</p>
2030
+ * </li>
2031
+ * <li>
2032
+ * <p>
2033
+ * <code>REGIONAL</code> – the results include only regional
2034
+ * resources or resource types.</p>
2035
+ * </li>
2036
+ * </ul>
2037
+ * <p>The default value is <code>ALL</code>.</p>
2038
+ */
2039
+ resourceRegionScope?: ResourceRegionScopeFilter | string;
1500
2040
  }
1501
2041
  export declare namespace ListResourceTypesRequest {
1502
2042
  /**
@@ -1505,18 +2045,35 @@ export declare namespace ListResourceTypesRequest {
1505
2045
  const filterSensitiveLog: (obj: ListResourceTypesRequest) => any;
1506
2046
  }
1507
2047
  /**
1508
- * <p>Information about the shareable resource types and the Amazon Web Services services to which they
1509
- * belong.</p>
2048
+ * <p>Information about a shareable resource type and the Amazon Web Services service to which resources
2049
+ * of that type belong.</p>
1510
2050
  */
1511
2051
  export interface ServiceNameAndResourceType {
1512
2052
  /**
1513
- * <p>The shareable resource types.</p>
2053
+ * <p>The type of the resource.</p>
1514
2054
  */
1515
2055
  resourceType?: string;
1516
2056
  /**
1517
- * <p>The name of the Amazon Web Services services to which the resources belong.</p>
2057
+ * <p>The name of the Amazon Web Services service to which resources of this type belong.</p>
1518
2058
  */
1519
2059
  serviceName?: string;
2060
+ /**
2061
+ * <p>Specifies the scope of visibility of resources of this type:</p>
2062
+ * <ul>
2063
+ * <li>
2064
+ * <p>
2065
+ * <b>REGIONAL</b> – The resource can be
2066
+ * accessed only by using requests that target the Amazon Web Services Region in which the
2067
+ * resource exists.</p>
2068
+ * </li>
2069
+ * <li>
2070
+ * <p>
2071
+ * <b>GLOBAL</b> – The resource can be accessed
2072
+ * from any Amazon Web Services Region.</p>
2073
+ * </li>
2074
+ * </ul>
2075
+ */
2076
+ resourceRegionScope?: ResourceRegionScope | string;
1520
2077
  }
1521
2078
  export declare namespace ServiceNameAndResourceType {
1522
2079
  /**
@@ -1526,11 +2083,16 @@ export declare namespace ServiceNameAndResourceType {
1526
2083
  }
1527
2084
  export interface ListResourceTypesResponse {
1528
2085
  /**
1529
- * <p>The shareable resource types supported by RAM.</p>
2086
+ * <p>An array of objects that contain information about the resource types that can be
2087
+ * shared using RAM.</p>
1530
2088
  */
1531
2089
  resourceTypes?: ServiceNameAndResourceType[];
1532
2090
  /**
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>
2091
+ * <p>If present, this value indicates that more output is available than
2092
+ * is included in the current response. Use this value in the <code>NextToken</code>
2093
+ * request parameter in a subsequent call to the operation to get the next part of the
2094
+ * output. You should repeat this until the <code>NextToken</code> response element comes
2095
+ * back as <code>null</code>. This indicates that this is the last page of results.</p>
1534
2096
  */
1535
2097
  nextToken?: string;
1536
2098
  }
@@ -1542,7 +2104,7 @@ export declare namespace ListResourceTypesResponse {
1542
2104
  }
1543
2105
  export interface PromoteResourceShareCreatedFromPolicyRequest {
1544
2106
  /**
1545
- * <p>The Amazon Resource Name (ARN) of the resource share to promote.</p>
2107
+ * <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
2108
  */
1547
2109
  resourceShareArn: string | undefined;
1548
2110
  }
@@ -1554,7 +2116,8 @@ export declare namespace PromoteResourceShareCreatedFromPolicyRequest {
1554
2116
  }
1555
2117
  export interface PromoteResourceShareCreatedFromPolicyResponse {
1556
2118
  /**
1557
- * <p>Indicates whether the request succeeded.</p>
2119
+ * <p>A return value of <code>true</code> indicates that the request succeeded.
2120
+ * A value of <code>false</code> indicates that the request failed.</p>
1558
2121
  */
1559
2122
  returnValue?: boolean;
1560
2123
  }
@@ -1566,11 +2129,18 @@ export declare namespace PromoteResourceShareCreatedFromPolicyResponse {
1566
2129
  }
1567
2130
  export interface RejectResourceShareInvitationRequest {
1568
2131
  /**
1569
- * <p>The Amazon Resource Name (ARN) of the invitation.</p>
2132
+ * <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
2133
  */
1571
2134
  resourceShareInvitationArn: string | undefined;
1572
2135
  /**
1573
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
2136
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
2137
+ * ensure the idempotency of the request. This lets you safely retry the request without
2138
+ * accidentally performing the same operation a second time. Passing the same value to a
2139
+ * later call to an operation requires that you also pass the same value for all other
2140
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
2141
+ * value.</a>.</p>
2142
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
2143
+ * you.</p>
1574
2144
  */
1575
2145
  clientToken?: string;
1576
2146
  }
@@ -1582,11 +2152,14 @@ export declare namespace RejectResourceShareInvitationRequest {
1582
2152
  }
1583
2153
  export interface RejectResourceShareInvitationResponse {
1584
2154
  /**
1585
- * <p>Information about the invitation.</p>
2155
+ * <p>An object that contains the details about the rejected invitation.</p>
1586
2156
  */
1587
2157
  resourceShareInvitation?: ResourceShareInvitation;
1588
2158
  /**
1589
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
2159
+ * <p>The idempotency identifier associated with this request. If you
2160
+ * want to repeat the same operation in an idempotent manner then you must include this
2161
+ * value in the <code>clientToken</code> request parameter of that later call. All other
2162
+ * parameters must also have the same values that you used in the first call.</p>
1590
2163
  */
1591
2164
  clientToken?: string;
1592
2165
  }
@@ -1597,7 +2170,7 @@ export declare namespace RejectResourceShareInvitationResponse {
1597
2170
  const filterSensitiveLog: (obj: RejectResourceShareInvitationResponse) => any;
1598
2171
  }
1599
2172
  /**
1600
- * <p>The requested tags exceed the limit for your account.</p>
2173
+ * <p>This request would exceed the limit for tags for your account.</p>
1601
2174
  */
1602
2175
  export interface TagLimitExceededException extends __SmithyException, $MetadataBearer {
1603
2176
  name: "TagLimitExceededException";
@@ -1612,11 +2185,12 @@ export declare namespace TagLimitExceededException {
1612
2185
  }
1613
2186
  export interface TagResourceRequest {
1614
2187
  /**
1615
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
2188
+ * <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
2189
  */
1617
2190
  resourceShareArn: string | undefined;
1618
2191
  /**
1619
- * <p>One or more tags.</p>
2192
+ * <p>A list of one or more tag key and value pairs. The tag key must be present and not be
2193
+ * an empty string. The tag value must be present but can be an empty string.</p>
1620
2194
  */
1621
2195
  tags: Tag[] | undefined;
1622
2196
  }
@@ -1636,11 +2210,12 @@ export declare namespace TagResourceResponse {
1636
2210
  }
1637
2211
  export interface UntagResourceRequest {
1638
2212
  /**
1639
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
2213
+ * <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
2214
+ * removed from the resource share, not the resources in the resource share.</p>
1640
2215
  */
1641
2216
  resourceShareArn: string | undefined;
1642
2217
  /**
1643
- * <p>The tag keys of the tags to remove.</p>
2218
+ * <p>Specifies a list of one or more tag keys that you want to remove.</p>
1644
2219
  */
1645
2220
  tagKeys: string[] | undefined;
1646
2221
  }
@@ -1660,20 +2235,27 @@ export declare namespace UntagResourceResponse {
1660
2235
  }
1661
2236
  export interface UpdateResourceShareRequest {
1662
2237
  /**
1663
- * <p>The Amazon Resource Name (ARN) of the resource share.</p>
2238
+ * <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
2239
  */
1665
2240
  resourceShareArn: string | undefined;
1666
2241
  /**
1667
- * <p>The name of the resource share.</p>
2242
+ * <p>If specified, the new name that you want to attach to the resource share.</p>
1668
2243
  */
1669
2244
  name?: string;
1670
2245
  /**
1671
- * <p>Indicates whether principals outside your organization in Organizations can be associated
2246
+ * <p>Specifies whether principals outside your organization in Organizations can be associated
1672
2247
  * with a resource share.</p>
1673
2248
  */
1674
2249
  allowExternalPrincipals?: boolean;
1675
2250
  /**
1676
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
2251
+ * <p>Specifies a unique, case-sensitive identifier that you provide to
2252
+ * ensure the idempotency of the request. This lets you safely retry the request without
2253
+ * accidentally performing the same operation a second time. Passing the same value to a
2254
+ * later call to an operation requires that you also pass the same value for all other
2255
+ * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
2256
+ * value.</a>.</p>
2257
+ * <p>If you don't provide this value, then Amazon Web Services generates a random one for
2258
+ * you.</p>
1677
2259
  */
1678
2260
  clientToken?: string;
1679
2261
  }
@@ -1689,7 +2271,10 @@ export interface UpdateResourceShareResponse {
1689
2271
  */
1690
2272
  resourceShare?: ResourceShare;
1691
2273
  /**
1692
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
2274
+ * <p>The idempotency identifier associated with this request. If you
2275
+ * want to repeat the same operation in an idempotent manner then you must include this
2276
+ * value in the <code>clientToken</code> request parameter of that later call. All other
2277
+ * parameters must also have the same values that you used in the first call.</p>
1693
2278
  */
1694
2279
  clientToken?: string;
1695
2280
  }