aws-sdk-ram 1.31.0 → 1.35.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.
@@ -19,12 +19,28 @@ module Aws::RAM
19
19
  # }
20
20
  #
21
21
  # @!attribute [rw] resource_share_invitation_arn
22
- # The Amazon Resource Name (ARN) of the invitation.
22
+ # The [Amazon Resoure Name (ARN)][1] of the invitation that you want
23
+ # to accept.
24
+ #
25
+ #
26
+ #
27
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
23
28
  # @return [String]
24
29
  #
25
30
  # @!attribute [rw] client_token
26
- # A unique, case-sensitive identifier that you provide to ensure the
27
- # idempotency of the request.
31
+ # Specifies a unique, case-sensitive identifier that you provide to
32
+ # ensure the idempotency of the request. This lets you safely retry
33
+ # the request without accidentally performing the same operation a
34
+ # second time. Passing the same value to a later call to an operation
35
+ # requires that you also pass the same value for all other parameters.
36
+ # We recommend that you use a [UUID type of value.][1].
37
+ #
38
+ # If you don't provide this value, then Amazon Web Services generates
39
+ # a random one for you.
40
+ #
41
+ #
42
+ #
43
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
28
44
  # @return [String]
29
45
  #
30
46
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AcceptResourceShareInvitationRequest AWS API Documentation
@@ -37,12 +53,15 @@ module Aws::RAM
37
53
  end
38
54
 
39
55
  # @!attribute [rw] resource_share_invitation
40
- # Information about the invitation.
56
+ # An object that contains information about the specified invitation.
41
57
  # @return [Types::ResourceShareInvitation]
42
58
  #
43
59
  # @!attribute [rw] client_token
44
- # A unique, case-sensitive identifier that you provide to ensure the
45
- # idempotency of the request.
60
+ # The idempotency identifier associated with this request. If you want
61
+ # to repeat the same operation in an idempotent manner then you must
62
+ # include this value in the `clientToken` request parameter of that
63
+ # later call. All other parameters must also have the same values that
64
+ # you used in the first call.
46
65
  # @return [String]
47
66
  #
48
67
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AcceptResourceShareInvitationResponse AWS API Documentation
@@ -66,29 +85,62 @@ module Aws::RAM
66
85
  # }
67
86
  #
68
87
  # @!attribute [rw] resource_share_arn
69
- # The Amazon Resource Name (ARN) of the resource share.
88
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
89
+ # to which you want to add or replace permissions.
90
+ #
91
+ #
92
+ #
93
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
70
94
  # @return [String]
71
95
  #
72
96
  # @!attribute [rw] permission_arn
73
- # The Amazon Resource Name (ARN) of the RAM permission to associate
74
- # with the resource share.
97
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the RAM permission
98
+ # to associate with the resource share. To find the ARN for a
99
+ # permission, use either the ListPermissions operation or go to the
100
+ # [Permissions library][2] page in the RAM console and then choose the
101
+ # name of the permission. The ARN is displayed on the detail page.
102
+ #
103
+ #
104
+ #
105
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
106
+ # [2]: https://console.aws.amazon.com/ram/home#Permissions:
75
107
  # @return [String]
76
108
  #
77
109
  # @!attribute [rw] replace
78
- # Indicates whether the permission should replace the permissions that
79
- # are currently associated with the resource share. Use `true` to
80
- # replace the current permissions. Use `false` to add the permission
81
- # to the current permission.
110
+ # Specifies whether the specified permission should replace or add to
111
+ # the existing permission associated with the resource share. Use
112
+ # `true` to replace the current permissions. Use `false` to add the
113
+ # permission to the current permission. The default value is `false`.
114
+ #
115
+ # <note markdown="1"> A resource share can have only one permission per resource type. If
116
+ # a resource share already has a permission for the specified resource
117
+ # type and you don't set `replace` to `true` then the operation
118
+ # returns an error. This helps prevent accidental overwriting of a
119
+ # permission.
120
+ #
121
+ # </note>
82
122
  # @return [Boolean]
83
123
  #
84
124
  # @!attribute [rw] client_token
85
- # A unique, case-sensitive identifier that you provide to ensure the
86
- # idempotency of the request.
125
+ # Specifies a unique, case-sensitive identifier that you provide to
126
+ # ensure the idempotency of the request. This lets you safely retry
127
+ # the request without accidentally performing the same operation a
128
+ # second time. Passing the same value to a later call to an operation
129
+ # requires that you also pass the same value for all other parameters.
130
+ # We recommend that you use a [UUID type of value.][1].
131
+ #
132
+ # If you don't provide this value, then Amazon Web Services generates
133
+ # a random one for you.
134
+ #
135
+ #
136
+ #
137
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
87
138
  # @return [String]
88
139
  #
89
140
  # @!attribute [rw] permission_version
90
- # The version of the RAM permissions to associate with the resource
91
- # share.
141
+ # Specifies the version of the RAM permission to associate with the
142
+ # resource share. If you don't specify this parameter, the operation
143
+ # uses the version designated as the default.
92
144
  # @return [Integer]
93
145
  #
94
146
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceSharePermissionRequest AWS API Documentation
@@ -104,12 +156,16 @@ module Aws::RAM
104
156
  end
105
157
 
106
158
  # @!attribute [rw] return_value
107
- # Indicates whether the request succeeded.
159
+ # A return value of `true` indicates that the request succeeded. A
160
+ # value of `false` indicates that the request failed.
108
161
  # @return [Boolean]
109
162
  #
110
163
  # @!attribute [rw] client_token
111
- # A unique, case-sensitive identifier that you provide to ensure the
112
- # idempotency of the request.
164
+ # The idempotency identifier associated with this request. If you want
165
+ # to repeat the same operation in an idempotent manner then you must
166
+ # include this value in the `clientToken` request parameter of that
167
+ # later call. All other parameters must also have the same values that
168
+ # you used in the first call.
113
169
  # @return [String]
114
170
  #
115
171
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceSharePermissionResponse AWS API Documentation
@@ -132,41 +188,76 @@ module Aws::RAM
132
188
  # }
133
189
  #
134
190
  # @!attribute [rw] resource_share_arn
135
- # The Amazon Resource Name (ARN) of the resource share.
191
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
192
+ # that you want to add principals or resources to.
193
+ #
194
+ #
195
+ #
196
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
136
197
  # @return [String]
137
198
  #
138
199
  # @!attribute [rw] resource_arns
139
- # The Amazon Resource Names (ARNs) of the resources.
200
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] of the
201
+ # resources that you want to share. This can be `null` if you want to
202
+ # add only principals.
203
+ #
204
+ #
205
+ #
206
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
140
207
  # @return [Array<String>]
141
208
  #
142
209
  # @!attribute [rw] principals
143
- # The principals to associate with the resource share. The possible
144
- # values are:
210
+ # Specifies a list of principals to whom you want to the resource
211
+ # share. This can be `null` if you want to add only resources.
212
+ #
213
+ # What the principals can do with the resources in the share is
214
+ # determined by the RAM permissions that you associate with the
215
+ # resource share. See AssociateResourceSharePermission.
145
216
  #
146
- # * An Amazon Web Services account ID
217
+ # You can include the following values:
147
218
  #
148
- # * An Amazon Resource Name (ARN) of an organization in Organizations
219
+ # * An Amazon Web Services account ID, for example: `123456789012`
149
220
  #
150
- # * An ARN of an organizational unit (OU) in Organizations
221
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
222
+ # Organizations, for example:
223
+ # `organizations::123456789012:organization/o-exampleorgid`
151
224
  #
152
- # * An ARN of an IAM role
225
+ # * An ARN of an organizational unit (OU) in Organizations, for
226
+ # example:
227
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
153
228
  #
154
- # * An ARN of an IAM user
229
+ # * An ARN of an IAM role, for example:
230
+ # `iam::123456789012:role/rolename`
155
231
  #
156
- # <note markdown="1"> Not all resource types can be shared with IAM roles and IAM users.
157
- # For more information, see [Sharing with IAM roles and IAM users][1]
158
- # in the *Resource Access Manager User Guide*.
232
+ # * An ARN of an IAM user, for example:
233
+ # `iam::123456789012user/username`
234
+ #
235
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
236
+ # more information, see [Sharing with IAM roles and users][2] in the
237
+ # *Resource Access Manager User Guide*.
159
238
  #
160
239
  # </note>
161
240
  #
162
241
  #
163
242
  #
164
- # [1]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
243
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
244
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
165
245
  # @return [Array<String>]
166
246
  #
167
247
  # @!attribute [rw] client_token
168
- # A unique, case-sensitive identifier that you provide to ensure the
169
- # idempotency of the request.
248
+ # Specifies a unique, case-sensitive identifier that you provide to
249
+ # ensure the idempotency of the request. This lets you safely retry
250
+ # the request without accidentally performing the same operation a
251
+ # second time. Passing the same value to a later call to an operation
252
+ # requires that you also pass the same value for all other parameters.
253
+ # We recommend that you use a [UUID type of value.][1].
254
+ #
255
+ # If you don't provide this value, then Amazon Web Services generates
256
+ # a random one for you.
257
+ #
258
+ #
259
+ #
260
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
170
261
  # @return [String]
171
262
  #
172
263
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceShareRequest AWS API Documentation
@@ -181,12 +272,15 @@ module Aws::RAM
181
272
  end
182
273
 
183
274
  # @!attribute [rw] resource_share_associations
184
- # Information about the associations.
275
+ # An array of objects that contain information about the associations.
185
276
  # @return [Array<Types::ResourceShareAssociation>]
186
277
  #
187
278
  # @!attribute [rw] client_token
188
- # A unique, case-sensitive identifier that you provide to ensure the
189
- # idempotency of the request.
279
+ # The idempotency identifier associated with this request. If you want
280
+ # to repeat the same operation in an idempotent manner then you must
281
+ # include this value in the `clientToken` request parameter of that
282
+ # later call. All other parameters must also have the same values that
283
+ # you used in the first call.
190
284
  # @return [String]
191
285
  #
192
286
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceShareResponse AWS API Documentation
@@ -217,58 +311,90 @@ module Aws::RAM
217
311
  # }
218
312
  #
219
313
  # @!attribute [rw] name
220
- # The name of the resource share.
314
+ # Specifies the name of the resource share.
221
315
  # @return [String]
222
316
  #
223
317
  # @!attribute [rw] resource_arns
224
- # The ARNs of the resources to associate with the resource share.
318
+ # Specifies a list of one or more ARNs of the resources to associate
319
+ # with the resource share.
225
320
  # @return [Array<String>]
226
321
  #
227
322
  # @!attribute [rw] principals
228
- # The principals to associate with the resource share. The possible
229
- # values are:
323
+ # Specifies a list of one or more principals to associate with the
324
+ # resource share.
325
+ #
326
+ # You can include the following values:
230
327
  #
231
- # * An Amazon Web Services account ID
328
+ # * An Amazon Web Services account ID, for example: `123456789012`
232
329
  #
233
- # * An Amazon Resource Name (ARN) of an organization in Organizations
330
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
331
+ # Organizations, for example:
332
+ # `organizations::123456789012:organization/o-exampleorgid`
234
333
  #
235
- # * An ARN of an organizational unit (OU) in Organizations
334
+ # * An ARN of an organizational unit (OU) in Organizations, for
335
+ # example:
336
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
236
337
  #
237
- # * An ARN of an IAM role
338
+ # * An ARN of an IAM role, for example:
339
+ # `iam::123456789012:role/rolename`
238
340
  #
239
- # * An ARN of an IAM user
341
+ # * An ARN of an IAM user, for example:
342
+ # `iam::123456789012user/username`
240
343
  #
241
- # <note markdown="1"> Not all resource types can be shared with IAM roles and IAM users.
242
- # For more information, see [Sharing with IAM roles and IAM users][1]
243
- # in the *Resource Access Manager User Guide*.
344
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
345
+ # more information, see [Sharing with IAM roles and users][2] in the
346
+ # *Resource Access Manager User Guide*.
244
347
  #
245
348
  # </note>
246
349
  #
247
350
  #
248
351
  #
249
- # [1]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
352
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
353
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
250
354
  # @return [Array<String>]
251
355
  #
252
356
  # @!attribute [rw] tags
253
- # One or more tags.
357
+ # Specifies one or more tags to attach to the resource share itself.
358
+ # It doesn't attach the tags to the resources associated with the
359
+ # resource share.
254
360
  # @return [Array<Types::Tag>]
255
361
  #
256
362
  # @!attribute [rw] allow_external_principals
257
- # Indicates whether principals outside your organization in
258
- # Organizations can be associated with a resource share.
363
+ # Specifies whether principals outside your organization in
364
+ # Organizations can be associated with a resource share. A value of
365
+ # `true` lets you share with individual Amazon Web Services accounts
366
+ # that are *not* in your organization. A value of `false` only has
367
+ # meaning if your account is a member of an Amazon Web Services
368
+ # Organization. The default value is `true`.
259
369
  # @return [Boolean]
260
370
  #
261
371
  # @!attribute [rw] client_token
262
- # A unique, case-sensitive identifier that you provide to ensure the
263
- # idempotency of the request.
372
+ # Specifies a unique, case-sensitive identifier that you provide to
373
+ # ensure the idempotency of the request. This lets you safely retry
374
+ # the request without accidentally performing the same operation a
375
+ # second time. Passing the same value to a later call to an operation
376
+ # requires that you also pass the same value for all other parameters.
377
+ # We recommend that you use a [UUID type of value.][1].
378
+ #
379
+ # If you don't provide this value, then Amazon Web Services generates
380
+ # a random one for you.
381
+ #
382
+ #
383
+ #
384
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
264
385
  # @return [String]
265
386
  #
266
387
  # @!attribute [rw] permission_arns
267
- # The Amazon Resource Names (ARNs) of the permissions to associate
268
- # with the resource share. If you do not specify an ARN for the
269
- # permission, RAM automatically attaches the default version of the
270
- # permission for each resource type. Only one permission can be
271
- # associated with each resource type in a resource share.
388
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the RAM
389
+ # permission to associate with the resource share. If you do not
390
+ # specify an ARN for the permission, RAM automatically attaches the
391
+ # default version of the permission for each resource type. You can
392
+ # associate only one permission with each resource type included in
393
+ # the resource share.
394
+ #
395
+ #
396
+ #
397
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
272
398
  # @return [Array<String>]
273
399
  #
274
400
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShareRequest AWS API Documentation
@@ -286,12 +412,15 @@ module Aws::RAM
286
412
  end
287
413
 
288
414
  # @!attribute [rw] resource_share
289
- # Information about the resource share.
415
+ # An object with information about the new resource share.
290
416
  # @return [Types::ResourceShare]
291
417
  #
292
418
  # @!attribute [rw] client_token
293
- # A unique, case-sensitive identifier that you provide to ensure the
294
- # idempotency of the request.
419
+ # The idempotency identifier associated with this request. If you want
420
+ # to repeat the same operation in an idempotent manner then you must
421
+ # include this value in the `clientToken` request parameter of that
422
+ # later call. All other parameters must also have the same values that
423
+ # you used in the first call.
295
424
  # @return [String]
296
425
  #
297
426
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShareResponse AWS API Documentation
@@ -312,12 +441,28 @@ module Aws::RAM
312
441
  # }
313
442
  #
314
443
  # @!attribute [rw] resource_share_arn
315
- # The Amazon Resource Name (ARN) of the resource share.
444
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
445
+ # to delete.
446
+ #
447
+ #
448
+ #
449
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
316
450
  # @return [String]
317
451
  #
318
452
  # @!attribute [rw] client_token
319
- # A unique, case-sensitive identifier that you provide to ensure the
320
- # idempotency of the request.
453
+ # Specifies a unique, case-sensitive identifier that you provide to
454
+ # ensure the idempotency of the request. This lets you safely retry
455
+ # the request without accidentally performing the same operation a
456
+ # second time. Passing the same value to a later call to an operation
457
+ # requires that you also pass the same value for all other parameters.
458
+ # We recommend that you use a [UUID type of value.][1].
459
+ #
460
+ # If you don't provide this value, then Amazon Web Services generates
461
+ # a random one for you.
462
+ #
463
+ #
464
+ #
465
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
321
466
  # @return [String]
322
467
  #
323
468
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DeleteResourceShareRequest AWS API Documentation
@@ -330,12 +475,16 @@ module Aws::RAM
330
475
  end
331
476
 
332
477
  # @!attribute [rw] return_value
333
- # Indicates whether the request succeeded.
478
+ # A return value of `true` indicates that the request succeeded. A
479
+ # value of `false` indicates that the request failed.
334
480
  # @return [Boolean]
335
481
  #
336
482
  # @!attribute [rw] client_token
337
- # A unique, case-sensitive identifier that you provide to ensure the
338
- # idempotency of the request.
483
+ # The idempotency identifier associated with this request. If you want
484
+ # to repeat the same operation in an idempotent manner then you must
485
+ # include this value in the `clientToken` request parameter of that
486
+ # later call. All other parameters must also have the same values that
487
+ # you used in the first call.
339
488
  # @return [String]
340
489
  #
341
490
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DeleteResourceShareResponse AWS API Documentation
@@ -357,17 +506,38 @@ module Aws::RAM
357
506
  # }
358
507
  #
359
508
  # @!attribute [rw] resource_share_arn
360
- # The Amazon Resource Name (ARN) of the resource share.
509
+ # The [Amazon Resoure Name (ARN)][1] of the resource share from which
510
+ # you want to disassociate a permission.
511
+ #
512
+ #
513
+ #
514
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
361
515
  # @return [String]
362
516
  #
363
517
  # @!attribute [rw] permission_arn
364
- # The Amazon Resource Name (ARN) of the permission to disassociate
365
- # from the resource share.
518
+ # The [Amazon Resoure Name (ARN)][1] of the permission to disassociate
519
+ # from the resource share. Changes to permissions take effect
520
+ # immediately.
521
+ #
522
+ #
523
+ #
524
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
366
525
  # @return [String]
367
526
  #
368
527
  # @!attribute [rw] client_token
369
- # A unique, case-sensitive identifier that you provide to ensure the
370
- # idempotency of the request.
528
+ # Specifies a unique, case-sensitive identifier that you provide to
529
+ # ensure the idempotency of the request. This lets you safely retry
530
+ # the request without accidentally performing the same operation a
531
+ # second time. Passing the same value to a later call to an operation
532
+ # requires that you also pass the same value for all other parameters.
533
+ # We recommend that you use a [UUID type of value.][1].
534
+ #
535
+ # If you don't provide this value, then Amazon Web Services generates
536
+ # a random one for you.
537
+ #
538
+ #
539
+ #
540
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
371
541
  # @return [String]
372
542
  #
373
543
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceSharePermissionRequest AWS API Documentation
@@ -381,12 +551,16 @@ module Aws::RAM
381
551
  end
382
552
 
383
553
  # @!attribute [rw] return_value
384
- # Indicates whether the request succeeded.
554
+ # A return value of `true` indicates that the request succeeded. A
555
+ # value of `false` indicates that the request failed.
385
556
  # @return [Boolean]
386
557
  #
387
558
  # @!attribute [rw] client_token
388
- # A unique, case-sensitive identifier that you provide to ensure the
389
- # idempotency of the request.
559
+ # The idempotency identifier associated with this request. If you want
560
+ # to repeat the same operation in an idempotent manner then you must
561
+ # include this value in the `clientToken` request parameter of that
562
+ # later call. All other parameters must also have the same values that
563
+ # you used in the first call.
390
564
  # @return [String]
391
565
  #
392
566
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceSharePermissionResponse AWS API Documentation
@@ -409,20 +583,74 @@ module Aws::RAM
409
583
  # }
410
584
  #
411
585
  # @!attribute [rw] resource_share_arn
412
- # The Amazon Resource Name (ARN) of the resource share.
586
+ # Specifies [Amazon Resoure Name (ARN)][1] of the resource share that
587
+ # you want to remove resources from.
588
+ #
589
+ #
590
+ #
591
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
413
592
  # @return [String]
414
593
  #
415
594
  # @!attribute [rw] resource_arns
416
- # The Amazon Resource Names (ARNs) of the resources.
595
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] for one or
596
+ # more resources that you want to remove from the resource share.
597
+ # After the operation runs, these resources are no longer shared with
598
+ # principals outside of the Amazon Web Services account that created
599
+ # the resources.
600
+ #
601
+ #
602
+ #
603
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
417
604
  # @return [Array<String>]
418
605
  #
419
606
  # @!attribute [rw] principals
420
- # The principals.
607
+ # Specifies a list of one or more principals that no longer are to
608
+ # have access to the resources in this resource share.
609
+ #
610
+ # You can include the following values:
611
+ #
612
+ # * An Amazon Web Services account ID, for example: `123456789012`
613
+ #
614
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
615
+ # Organizations, for example:
616
+ # `organizations::123456789012:organization/o-exampleorgid`
617
+ #
618
+ # * An ARN of an organizational unit (OU) in Organizations, for
619
+ # example:
620
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
621
+ #
622
+ # * An ARN of an IAM role, for example:
623
+ # `iam::123456789012:role/rolename`
624
+ #
625
+ # * An ARN of an IAM user, for example:
626
+ # `iam::123456789012user/username`
627
+ #
628
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
629
+ # more information, see [Sharing with IAM roles and users][2] in the
630
+ # *Resource Access Manager User Guide*.
631
+ #
632
+ # </note>
633
+ #
634
+ #
635
+ #
636
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
637
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
421
638
  # @return [Array<String>]
422
639
  #
423
640
  # @!attribute [rw] client_token
424
- # A unique, case-sensitive identifier that you provide to ensure the
425
- # idempotency of the request.
641
+ # Specifies a unique, case-sensitive identifier that you provide to
642
+ # ensure the idempotency of the request. This lets you safely retry
643
+ # the request without accidentally performing the same operation a
644
+ # second time. Passing the same value to a later call to an operation
645
+ # requires that you also pass the same value for all other parameters.
646
+ # We recommend that you use a [UUID type of value.][1].
647
+ #
648
+ # If you don't provide this value, then Amazon Web Services generates
649
+ # a random one for you.
650
+ #
651
+ #
652
+ #
653
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
426
654
  # @return [String]
427
655
  #
428
656
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceShareRequest AWS API Documentation
@@ -437,12 +665,16 @@ module Aws::RAM
437
665
  end
438
666
 
439
667
  # @!attribute [rw] resource_share_associations
440
- # Information about the associations.
668
+ # An array of objects that contain information about the updated
669
+ # associations for this resource share.
441
670
  # @return [Array<Types::ResourceShareAssociation>]
442
671
  #
443
672
  # @!attribute [rw] client_token
444
- # A unique, case-sensitive identifier that you provide to ensure the
445
- # idempotency of the request.
673
+ # The idempotency identifier associated with this request. If you want
674
+ # to repeat the same operation in an idempotent manner then you must
675
+ # include this value in the `clientToken` request parameter of that
676
+ # later call. All other parameters must also have the same values that
677
+ # you used in the first call.
446
678
  # @return [String]
447
679
  #
448
680
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceShareResponse AWS API Documentation
@@ -461,7 +693,8 @@ module Aws::RAM
461
693
  class EnableSharingWithAwsOrganizationRequest < Aws::EmptyStructure; end
462
694
 
463
695
  # @!attribute [rw] return_value
464
- # Indicates whether the request succeeded.
696
+ # A return value of `true` indicates that the request succeeded. A
697
+ # value of `false` indicates that the request failed.
465
698
  # @return [Boolean]
466
699
  #
467
700
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/EnableSharingWithAwsOrganizationResponse AWS API Documentation
@@ -481,11 +714,22 @@ module Aws::RAM
481
714
  # }
482
715
  #
483
716
  # @!attribute [rw] permission_arn
484
- # The Amazon Resource Name (ARN) of the permission.
717
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the permission whose
718
+ # contents you want to retrieve. To find the ARN for a permission, use
719
+ # either the ListPermissions operation or go to the [Permissions
720
+ # library][2] page in the RAM console and then choose the name of the
721
+ # permission. The ARN is displayed on the detail page.
722
+ #
723
+ #
724
+ #
725
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
726
+ # [2]: https://console.aws.amazon.com/ram/home#Permissions:
485
727
  # @return [String]
486
728
  #
487
729
  # @!attribute [rw] permission_version
488
- # The identifier for the version of the permission.
730
+ # Specifies identifier for the version of the RAM permission to
731
+ # retrieve. If you don't specify this parameter, the operation
732
+ # retrieves the default version.
489
733
  # @return [Integer]
490
734
  #
491
735
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetPermissionRequest AWS API Documentation
@@ -498,7 +742,7 @@ module Aws::RAM
498
742
  end
499
743
 
500
744
  # @!attribute [rw] permission
501
- # Information about the permission.
745
+ # An object that contains information about the permission.
502
746
  # @return [Types::ResourceSharePermissionDetail]
503
747
  #
504
748
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetPermissionResponse AWS API Documentation
@@ -520,21 +764,37 @@ module Aws::RAM
520
764
  # }
521
765
  #
522
766
  # @!attribute [rw] resource_arns
523
- # The Amazon Resource Names (ARNs) of the resources.
767
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the resources
768
+ # whose policies you want to retrieve.
769
+ #
770
+ #
771
+ #
772
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
524
773
  # @return [Array<String>]
525
774
  #
526
775
  # @!attribute [rw] principal
527
- # The principal.
776
+ # Specifies the principal.
528
777
  # @return [String]
529
778
  #
530
779
  # @!attribute [rw] next_token
531
- # The token for the next page of results.
780
+ # Specifies that you want to receive the next page of results. Valid
781
+ # only if you received a `NextToken` response in the previous request.
782
+ # If you did, it indicates that more output is available. Set this
783
+ # parameter to the value provided by the previous call's `NextToken`
784
+ # response to request the next page of results.
532
785
  # @return [String]
533
786
  #
534
787
  # @!attribute [rw] max_results
535
- # The maximum number of results to return with a single call. To
536
- # retrieve the remaining results, make another call with the returned
537
- # `nextToken` value.
788
+ # Specifies the total number of results that you want included on each
789
+ # page of the response. If you do not include this parameter, it
790
+ # defaults to a value that is specific to the operation. If additional
791
+ # items exist beyond the number you specify, the `NextToken` response
792
+ # element is returned with a value (not null). Include the specified
793
+ # value as the `NextToken` request parameter in the next call to the
794
+ # operation to get the next part of the results. Note that the service
795
+ # might return fewer results than the maximum even when there are more
796
+ # results available. You should check `NextToken` after every
797
+ # operation to ensure that you receive all of the results.
538
798
  # @return [Integer]
539
799
  #
540
800
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourcePoliciesRequest AWS API Documentation
@@ -549,12 +809,16 @@ module Aws::RAM
549
809
  end
550
810
 
551
811
  # @!attribute [rw] policies
552
- # A key policy document, in JSON format.
812
+ # An array of resource policy documents in JSON format.
553
813
  # @return [Array<String>]
554
814
  #
555
815
  # @!attribute [rw] next_token
556
- # The token to use to retrieve the next page of results. This value is
557
- # `null` when there are no more results to return.
816
+ # If present, this value indicates that more output is available than
817
+ # is included in the current response. Use this value in the
818
+ # `NextToken` request parameter in a subsequent call to the operation
819
+ # to get the next part of the output. You should repeat this until the
820
+ # `NextToken` response element comes back as `null`. This indicates
821
+ # that this is the last page of results.
558
822
  # @return [String]
559
823
  #
560
824
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourcePoliciesResponse AWS API Documentation
@@ -580,38 +844,75 @@ module Aws::RAM
580
844
  # }
581
845
  #
582
846
  # @!attribute [rw] association_type
583
- # The association type. Specify `PRINCIPAL` to list the principals
584
- # that are associated with the specified resource share. Specify
585
- # `RESOURCE` to list the resources that are associated with the
586
- # specified resource share.
847
+ # Specifies whether you want to retrieve the associations that involve
848
+ # a specified resource or principal.
849
+ #
850
+ # * `PRINCIPAL` – list the principals that are associated with the
851
+ # specified resource share.
852
+ #
853
+ # * `RESOURCE` – list the resources that are associated with the
854
+ # specified resource share.
587
855
  # @return [String]
588
856
  #
589
857
  # @!attribute [rw] resource_share_arns
590
- # The Amazon Resource Names (ARN) of the resource shares.
858
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] of the
859
+ # resource share whose associations you want to retrieve.
860
+ #
861
+ #
862
+ #
863
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
591
864
  # @return [Array<String>]
592
865
  #
593
866
  # @!attribute [rw] resource_arn
594
- # The Amazon Resource Name (ARN) of the resource. You cannot specify
595
- # this parameter if the association type is `PRINCIPAL`.
867
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource whose
868
+ # resource shares you want to retrieve.
869
+ #
870
+ # You cannot specify this parameter if the association type is
871
+ # `PRINCIPAL`.
872
+ #
873
+ #
874
+ #
875
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
596
876
  # @return [String]
597
877
  #
598
878
  # @!attribute [rw] principal
599
- # The principal. You cannot specify this parameter if the association
600
- # type is `RESOURCE`.
879
+ # Specifies the ID of the principal whose resource shares you want to
880
+ # retrieve. This can be an Amazon Web Services account ID, an
881
+ # organization ID, an organizational unit ID, or the [Amazon Resoure
882
+ # Name (ARN)][1] of an individual IAM user or role.
883
+ #
884
+ # You cannot specify this parameter if the association type is
885
+ # `RESOURCE`.
886
+ #
887
+ #
888
+ #
889
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
601
890
  # @return [String]
602
891
  #
603
892
  # @!attribute [rw] association_status
604
- # The association status.
893
+ # Specifies that you want to retrieve only associations with this
894
+ # status.
605
895
  # @return [String]
606
896
  #
607
897
  # @!attribute [rw] next_token
608
- # The token for the next page of results.
898
+ # Specifies that you want to receive the next page of results. Valid
899
+ # only if you received a `NextToken` response in the previous request.
900
+ # If you did, it indicates that more output is available. Set this
901
+ # parameter to the value provided by the previous call's `NextToken`
902
+ # response to request the next page of results.
609
903
  # @return [String]
610
904
  #
611
905
  # @!attribute [rw] max_results
612
- # The maximum number of results to return with a single call. To
613
- # retrieve the remaining results, make another call with the returned
614
- # `nextToken` value.
906
+ # Specifies the total number of results that you want included on each
907
+ # page of the response. If you do not include this parameter, it
908
+ # defaults to a value that is specific to the operation. If additional
909
+ # items exist beyond the number you specify, the `NextToken` response
910
+ # element is returned with a value (not null). Include the specified
911
+ # value as the `NextToken` request parameter in the next call to the
912
+ # operation to get the next part of the results. Note that the service
913
+ # might return fewer results than the maximum even when there are more
914
+ # results available. You should check `NextToken` after every
915
+ # operation to ensure that you receive all of the results.
615
916
  # @return [Integer]
616
917
  #
617
918
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareAssociationsRequest AWS API Documentation
@@ -629,12 +930,16 @@ module Aws::RAM
629
930
  end
630
931
 
631
932
  # @!attribute [rw] resource_share_associations
632
- # Information about the associations.
933
+ # An array of objects that contain the details about the associations.
633
934
  # @return [Array<Types::ResourceShareAssociation>]
634
935
  #
635
936
  # @!attribute [rw] next_token
636
- # The token to use to retrieve the next page of results. This value is
637
- # `null` when there are no more results to return.
937
+ # If present, this value indicates that more output is available than
938
+ # is included in the current response. Use this value in the
939
+ # `NextToken` request parameter in a subsequent call to the operation
940
+ # to get the next part of the output. You should repeat this until the
941
+ # `NextToken` response element comes back as `null`. This indicates
942
+ # that this is the last page of results.
638
943
  # @return [String]
639
944
  #
640
945
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareAssociationsResponse AWS API Documentation
@@ -657,21 +962,43 @@ module Aws::RAM
657
962
  # }
658
963
  #
659
964
  # @!attribute [rw] resource_share_invitation_arns
660
- # The Amazon Resource Names (ARN) of the invitations.
965
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the resource
966
+ # share invitations you want information about.
967
+ #
968
+ #
969
+ #
970
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
661
971
  # @return [Array<String>]
662
972
  #
663
973
  # @!attribute [rw] resource_share_arns
664
- # The Amazon Resource Names (ARN) of the resource shares.
974
+ # Specifies that you want details about invitations only for the
975
+ # resource shares described by this list of [Amazon Resource Names
976
+ # (ARNs)][1]
977
+ #
978
+ #
979
+ #
980
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
665
981
  # @return [Array<String>]
666
982
  #
667
983
  # @!attribute [rw] next_token
668
- # The token for the next page of results.
984
+ # Specifies that you want to receive the next page of results. Valid
985
+ # only if you received a `NextToken` response in the previous request.
986
+ # If you did, it indicates that more output is available. Set this
987
+ # parameter to the value provided by the previous call's `NextToken`
988
+ # response to request the next page of results.
669
989
  # @return [String]
670
990
  #
671
991
  # @!attribute [rw] max_results
672
- # The maximum number of results to return with a single call. To
673
- # retrieve the remaining results, make another call with the returned
674
- # `nextToken` value.
992
+ # Specifies the total number of results that you want included on each
993
+ # page of the response. If you do not include this parameter, it
994
+ # defaults to a value that is specific to the operation. If additional
995
+ # items exist beyond the number you specify, the `NextToken` response
996
+ # element is returned with a value (not null). Include the specified
997
+ # value as the `NextToken` request parameter in the next call to the
998
+ # operation to get the next part of the results. Note that the service
999
+ # might return fewer results than the maximum even when there are more
1000
+ # results available. You should check `NextToken` after every
1001
+ # operation to ensure that you receive all of the results.
675
1002
  # @return [Integer]
676
1003
  #
677
1004
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareInvitationsRequest AWS API Documentation
@@ -686,12 +1013,16 @@ module Aws::RAM
686
1013
  end
687
1014
 
688
1015
  # @!attribute [rw] resource_share_invitations
689
- # Information about the invitations.
1016
+ # An array of objects that contain the details about the invitations.
690
1017
  # @return [Array<Types::ResourceShareInvitation>]
691
1018
  #
692
1019
  # @!attribute [rw] next_token
693
- # The token to use to retrieve the next page of results. This value is
694
- # `null` when there are no more results to return.
1020
+ # If present, this value indicates that more output is available than
1021
+ # is included in the current response. Use this value in the
1022
+ # `NextToken` request parameter in a subsequent call to the operation
1023
+ # to get the next part of the output. You should repeat this until the
1024
+ # `NextToken` response element comes back as `null`. This indicates
1025
+ # that this is the last page of results.
695
1026
  # @return [String]
696
1027
  #
697
1028
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareInvitationsResponse AWS API Documentation
@@ -723,38 +1054,68 @@ module Aws::RAM
723
1054
  # }
724
1055
  #
725
1056
  # @!attribute [rw] resource_share_arns
726
- # The Amazon Resource Names (ARNs) of the resource shares.
1057
+ # Specifies the [Amazon Resource Names (ARNs)][1] of individual
1058
+ # resource shares that you want information about.
1059
+ #
1060
+ #
1061
+ #
1062
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
727
1063
  # @return [Array<String>]
728
1064
  #
729
1065
  # @!attribute [rw] resource_share_status
730
- # The status of the resource share.
1066
+ # Specifies that you want to retrieve details of only those resource
1067
+ # shares that have this status.
731
1068
  # @return [String]
732
1069
  #
733
1070
  # @!attribute [rw] resource_owner
734
- # The type of owner.
1071
+ # Specifies that you want to retrieve details of only those resource
1072
+ # shares that match the following:
1073
+ #
1074
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1075
+ #
1076
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other
1077
+ # accounts share with you
735
1078
  # @return [String]
736
1079
  #
737
1080
  # @!attribute [rw] name
738
- # The name of the resource share.
1081
+ # Specifies the name of an individual resource share that you want to
1082
+ # retrieve details about.
739
1083
  # @return [String]
740
1084
  #
741
1085
  # @!attribute [rw] tag_filters
742
- # One or more tag filters.
1086
+ # Specifies that you want to retrieve details of only those resource
1087
+ # shares that match the specified tag keys and values.
743
1088
  # @return [Array<Types::TagFilter>]
744
1089
  #
745
1090
  # @!attribute [rw] next_token
746
- # The token for the next page of results.
1091
+ # Specifies that you want to receive the next page of results. Valid
1092
+ # only if you received a `NextToken` response in the previous request.
1093
+ # If you did, it indicates that more output is available. Set this
1094
+ # parameter to the value provided by the previous call's `NextToken`
1095
+ # response to request the next page of results.
747
1096
  # @return [String]
748
1097
  #
749
1098
  # @!attribute [rw] max_results
750
- # The maximum number of results to return with a single call. To
751
- # retrieve the remaining results, make another call with the returned
752
- # `nextToken` value.
1099
+ # Specifies the total number of results that you want included on each
1100
+ # page of the response. If you do not include this parameter, it
1101
+ # defaults to a value that is specific to the operation. If additional
1102
+ # items exist beyond the number you specify, the `NextToken` response
1103
+ # element is returned with a value (not null). Include the specified
1104
+ # value as the `NextToken` request parameter in the next call to the
1105
+ # operation to get the next part of the results. Note that the service
1106
+ # might return fewer results than the maximum even when there are more
1107
+ # results available. You should check `NextToken` after every
1108
+ # operation to ensure that you receive all of the results.
753
1109
  # @return [Integer]
754
1110
  #
755
1111
  # @!attribute [rw] permission_arn
756
- # The Amazon Resource Name (ARN) of the RAM permission that is
757
- # associated with the resource share.
1112
+ # Specifies that you want to retrieve details of only those resource
1113
+ # shares that use the RAM permission with this [Amazon Resoure Name
1114
+ # (ARN)][1].
1115
+ #
1116
+ #
1117
+ #
1118
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
758
1119
  # @return [String]
759
1120
  #
760
1121
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceSharesRequest AWS API Documentation
@@ -773,12 +1134,17 @@ module Aws::RAM
773
1134
  end
774
1135
 
775
1136
  # @!attribute [rw] resource_shares
776
- # Information about the resource shares.
1137
+ # An array of objects that contain the information about the resource
1138
+ # shares.
777
1139
  # @return [Array<Types::ResourceShare>]
778
1140
  #
779
1141
  # @!attribute [rw] next_token
780
- # The token to use to retrieve the next page of results. This value is
781
- # `null` when there are no more results to return.
1142
+ # If present, this value indicates that more output is available than
1143
+ # is included in the current response. Use this value in the
1144
+ # `NextToken` request parameter in a subsequent call to the operation
1145
+ # to get the next part of the output. You should repeat this until the
1146
+ # `NextToken` response element comes back as `null`. This indicates
1147
+ # that this is the last page of results.
782
1148
  # @return [String]
783
1149
  #
784
1150
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceSharesResponse AWS API Documentation
@@ -790,9 +1156,9 @@ module Aws::RAM
790
1156
  include Aws::Structure
791
1157
  end
792
1158
 
793
- # A client token input parameter was reused with an operation, but at
794
- # least one of the other input parameters is different from the previous
795
- # call to the operation.
1159
+ # The client token input parameter was matched one used with a previous
1160
+ # call to the operation, but at least one of the other input parameters
1161
+ # is different from the previous call.
796
1162
  #
797
1163
  # @!attribute [rw] message
798
1164
  # @return [String]
@@ -805,7 +1171,7 @@ module Aws::RAM
805
1171
  include Aws::Structure
806
1172
  end
807
1173
 
808
- # A client token is not valid.
1174
+ # The client token is not valid.
809
1175
  #
810
1176
  # @!attribute [rw] message
811
1177
  # @return [String]
@@ -818,7 +1184,7 @@ module Aws::RAM
818
1184
  include Aws::Structure
819
1185
  end
820
1186
 
821
- # The specified value for MaxResults is not valid.
1187
+ # The specified value for `MaxResults` is not valid.
822
1188
  #
823
1189
  # @!attribute [rw] message
824
1190
  # @return [String]
@@ -831,7 +1197,7 @@ module Aws::RAM
831
1197
  include Aws::Structure
832
1198
  end
833
1199
 
834
- # The specified value for NextToken is not valid.
1200
+ # The specified value for `NextToken` is not valid.
835
1201
  #
836
1202
  # @!attribute [rw] message
837
1203
  # @return [String]
@@ -890,39 +1256,79 @@ module Aws::RAM
890
1256
  # resource_share_invitation_arn: "String", # required
891
1257
  # next_token: "String",
892
1258
  # max_results: 1,
1259
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
893
1260
  # }
894
1261
  #
895
1262
  # @!attribute [rw] resource_share_invitation_arn
896
- # The Amazon Resource Name (ARN) of the invitation.
1263
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the invitation. You
1264
+ # can use GetResourceShareInvitations to find the ARN of the
1265
+ # invitation.
1266
+ #
1267
+ #
1268
+ #
1269
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
897
1270
  # @return [String]
898
1271
  #
899
1272
  # @!attribute [rw] next_token
900
- # The token for the next page of results.
1273
+ # Specifies that you want to receive the next page of results. Valid
1274
+ # only if you received a `NextToken` response in the previous request.
1275
+ # If you did, it indicates that more output is available. Set this
1276
+ # parameter to the value provided by the previous call's `NextToken`
1277
+ # response to request the next page of results.
901
1278
  # @return [String]
902
1279
  #
903
1280
  # @!attribute [rw] max_results
904
- # The maximum number of results to return with a single call. To
905
- # retrieve the remaining results, make another call with the returned
906
- # `nextToken` value.
1281
+ # Specifies the total number of results that you want included on each
1282
+ # page of the response. If you do not include this parameter, it
1283
+ # defaults to a value that is specific to the operation. If additional
1284
+ # items exist beyond the number you specify, the `NextToken` response
1285
+ # element is returned with a value (not null). Include the specified
1286
+ # value as the `NextToken` request parameter in the next call to the
1287
+ # operation to get the next part of the results. Note that the service
1288
+ # might return fewer results than the maximum even when there are more
1289
+ # results available. You should check `NextToken` after every
1290
+ # operation to ensure that you receive all of the results.
907
1291
  # @return [Integer]
908
1292
  #
1293
+ # @!attribute [rw] resource_region_scope
1294
+ # Specifies that you want the results to include only resources that
1295
+ # have the specified scope.
1296
+ #
1297
+ # * `ALL` – the results include both global and regional resources or
1298
+ # resource types.
1299
+ #
1300
+ # * `GLOBAL` – the results include only global resources or resource
1301
+ # types.
1302
+ #
1303
+ # * `REGIONAL` – the results include only regional resources or
1304
+ # resource types.
1305
+ #
1306
+ # The default value is `ALL`.
1307
+ # @return [String]
1308
+ #
909
1309
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPendingInvitationResourcesRequest AWS API Documentation
910
1310
  #
911
1311
  class ListPendingInvitationResourcesRequest < Struct.new(
912
1312
  :resource_share_invitation_arn,
913
1313
  :next_token,
914
- :max_results)
1314
+ :max_results,
1315
+ :resource_region_scope)
915
1316
  SENSITIVE = []
916
1317
  include Aws::Structure
917
1318
  end
918
1319
 
919
1320
  # @!attribute [rw] resources
920
- # Information about the resources included the resource share.
1321
+ # An array of objects that contain the information about the resources
1322
+ # included the specified resource share.
921
1323
  # @return [Array<Types::Resource>]
922
1324
  #
923
1325
  # @!attribute [rw] next_token
924
- # The token to use to retrieve the next page of results. This value is
925
- # `null` when there are no more results to return.
1326
+ # If present, this value indicates that more output is available than
1327
+ # is included in the current response. Use this value in the
1328
+ # `NextToken` request parameter in a subsequent call to the operation
1329
+ # to get the next part of the output. You should repeat this until the
1330
+ # `NextToken` response element comes back as `null`. This indicates
1331
+ # that this is the last page of results.
926
1332
  # @return [String]
927
1333
  #
928
1334
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPendingInvitationResourcesResponse AWS API Documentation
@@ -944,19 +1350,31 @@ module Aws::RAM
944
1350
  # }
945
1351
  #
946
1352
  # @!attribute [rw] resource_type
947
- # Specifies the resource type for which to list permissions. For
948
- # example, to list only permissions that apply to EC2 subnets, specify
949
- # `ec2:Subnet`.
1353
+ # Specifies that you want to list permissions for only the specified
1354
+ # resource type. For example, to list only permissions that apply to
1355
+ # EC2 subnets, specify `ec2:Subnet`. You can use the ListResourceTypes
1356
+ # operation to get the specific string required.
950
1357
  # @return [String]
951
1358
  #
952
1359
  # @!attribute [rw] next_token
953
- # The token for the next page of results.
1360
+ # Specifies that you want to receive the next page of results. Valid
1361
+ # only if you received a `NextToken` response in the previous request.
1362
+ # If you did, it indicates that more output is available. Set this
1363
+ # parameter to the value provided by the previous call's `NextToken`
1364
+ # response to request the next page of results.
954
1365
  # @return [String]
955
1366
  #
956
1367
  # @!attribute [rw] max_results
957
- # The maximum number of results to return with a single call. To
958
- # retrieve the remaining results, make another call with the returned
959
- # `nextToken` value.
1368
+ # Specifies the total number of results that you want included on each
1369
+ # page of the response. If you do not include this parameter, it
1370
+ # defaults to a value that is specific to the operation. If additional
1371
+ # items exist beyond the number you specify, the `NextToken` response
1372
+ # element is returned with a value (not null). Include the specified
1373
+ # value as the `NextToken` request parameter in the next call to the
1374
+ # operation to get the next part of the results. Note that the service
1375
+ # might return fewer results than the maximum even when there are more
1376
+ # results available. You should check `NextToken` after every
1377
+ # operation to ensure that you receive all of the results.
960
1378
  # @return [Integer]
961
1379
  #
962
1380
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionsRequest AWS API Documentation
@@ -970,12 +1388,16 @@ module Aws::RAM
970
1388
  end
971
1389
 
972
1390
  # @!attribute [rw] permissions
973
- # Information about the permissions.
1391
+ # An array of objects with information about the permissions.
974
1392
  # @return [Array<Types::ResourceSharePermissionSummary>]
975
1393
  #
976
1394
  # @!attribute [rw] next_token
977
- # The token to use to retrieve the next page of results. This value is
978
- # `null` when there are no more results to return.
1395
+ # If present, this value indicates that more output is available than
1396
+ # is included in the current response. Use this value in the
1397
+ # `NextToken` request parameter in a subsequent call to the operation
1398
+ # to get the next part of the output. You should repeat this until the
1399
+ # `NextToken` response element comes back as `null`. This indicates
1400
+ # that this is the last page of results.
979
1401
  # @return [String]
980
1402
  #
981
1403
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionsResponse AWS API Documentation
@@ -1001,51 +1423,95 @@ module Aws::RAM
1001
1423
  # }
1002
1424
  #
1003
1425
  # @!attribute [rw] resource_owner
1004
- # The type of owner.
1426
+ # Specifies that you want to list information for only resource shares
1427
+ # that match the following:
1428
+ #
1429
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1430
+ #
1431
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other
1432
+ # accounts share with you
1005
1433
  # @return [String]
1006
1434
  #
1007
1435
  # @!attribute [rw] resource_arn
1008
- # The Amazon Resource Name (ARN) of the resource.
1436
+ # Specifies that you want to list principal information for the
1437
+ # resource share with the specified [Amazon Resoure Name (ARN)][1].
1438
+ #
1439
+ #
1440
+ #
1441
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1009
1442
  # @return [String]
1010
1443
  #
1011
1444
  # @!attribute [rw] principals
1012
- # The principals.
1445
+ # Specifies that you want to list information for only the listed
1446
+ # principals.
1447
+ #
1448
+ # You can include the following values:
1449
+ #
1450
+ # * An Amazon Web Services account ID, for example: `123456789012`
1451
+ #
1452
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
1453
+ # Organizations, for example:
1454
+ # `organizations::123456789012:organization/o-exampleorgid`
1455
+ #
1456
+ # * An ARN of an organizational unit (OU) in Organizations, for
1457
+ # example:
1458
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
1459
+ #
1460
+ # * An ARN of an IAM role, for example:
1461
+ # `iam::123456789012:role/rolename`
1462
+ #
1463
+ # * An ARN of an IAM user, for example:
1464
+ # `iam::123456789012user/username`
1465
+ #
1466
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
1467
+ # more information, see [Sharing with IAM roles and users][2] in the
1468
+ # *Resource Access Manager User Guide*.
1469
+ #
1470
+ # </note>
1471
+ #
1472
+ #
1473
+ #
1474
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1475
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
1013
1476
  # @return [Array<String>]
1014
1477
  #
1015
1478
  # @!attribute [rw] resource_type
1016
- # The resource type.
1017
- #
1018
- # Valid values: `acm-pca:CertificateAuthority` \| `appmesh:Mesh` \|
1019
- # `codebuild:Project` \| `codebuild:ReportGroup` \|
1020
- # `ec2:CapacityReservation` \| `ec2:DedicatedHost` \|
1021
- # `ec2:LocalGatewayRouteTable` \| `ec2:PrefixList` \| `ec2:Subnet` \|
1022
- # `ec2:TrafficMirrorTarget` \| `ec2:TransitGateway` \|
1023
- # `imagebuilder:Component` \| `imagebuilder:Image` \|
1024
- # `imagebuilder:ImageRecipe` \| `imagebuilder:ContainerRecipe` \|
1025
- # `glue:Catalog` \| `glue:Database` \| `glue:Table` \|
1026
- # `license-manager:LicenseConfiguration` I
1027
- # `network-firewall:FirewallPolicy` \|
1028
- # `network-firewall:StatefulRuleGroup` \|
1029
- # `network-firewall:StatelessRuleGroup` \| `outposts:Outpost` \|
1030
- # `resource-groups:Group` \| `rds:Cluster` \|
1031
- # `route53resolver:FirewallRuleGroup`
1032
- # \|`route53resolver:ResolverQueryLogConfig` \|
1033
- # `route53resolver:ResolverRule` \| `s3-outposts:Outpost` \|
1034
- # `ssm-contacts:Contact` \| `ssm-incidents:ResponsePlan`
1479
+ # Specifies that you want to list information for only principals
1480
+ # associated with resource shares that include the specified resource
1481
+ # type.
1482
+ #
1483
+ # For a list of valid values, query the ListResourceTypes operation.
1035
1484
  # @return [String]
1036
1485
  #
1037
1486
  # @!attribute [rw] resource_share_arns
1038
- # The Amazon Resource Names (ARN) of the resource shares.
1487
+ # Specifies that you want to list information for only principals
1488
+ # associated with the resource shares specified by a list the [Amazon
1489
+ # Resource Names (ARNs)][1].
1490
+ #
1491
+ #
1492
+ #
1493
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1039
1494
  # @return [Array<String>]
1040
1495
  #
1041
1496
  # @!attribute [rw] next_token
1042
- # The token for the next page of results.
1497
+ # Specifies that you want to receive the next page of results. Valid
1498
+ # only if you received a `NextToken` response in the previous request.
1499
+ # If you did, it indicates that more output is available. Set this
1500
+ # parameter to the value provided by the previous call's `NextToken`
1501
+ # response to request the next page of results.
1043
1502
  # @return [String]
1044
1503
  #
1045
1504
  # @!attribute [rw] max_results
1046
- # The maximum number of results to return with a single call. To
1047
- # retrieve the remaining results, make another call with the returned
1048
- # `nextToken` value.
1505
+ # Specifies the total number of results that you want included on each
1506
+ # page of the response. If you do not include this parameter, it
1507
+ # defaults to a value that is specific to the operation. If additional
1508
+ # items exist beyond the number you specify, the `NextToken` response
1509
+ # element is returned with a value (not null). Include the specified
1510
+ # value as the `NextToken` request parameter in the next call to the
1511
+ # operation to get the next part of the results. Note that the service
1512
+ # might return fewer results than the maximum even when there are more
1513
+ # results available. You should check `NextToken` after every
1514
+ # operation to ensure that you receive all of the results.
1049
1515
  # @return [Integer]
1050
1516
  #
1051
1517
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPrincipalsRequest AWS API Documentation
@@ -1063,12 +1529,16 @@ module Aws::RAM
1063
1529
  end
1064
1530
 
1065
1531
  # @!attribute [rw] principals
1066
- # The principals.
1532
+ # An array of objects that contain the details about the principals.
1067
1533
  # @return [Array<Types::Principal>]
1068
1534
  #
1069
1535
  # @!attribute [rw] next_token
1070
- # The token to use to retrieve the next page of results. This value is
1071
- # `null` when there are no more results to return.
1536
+ # If present, this value indicates that more output is available than
1537
+ # is included in the current response. Use this value in the
1538
+ # `NextToken` request parameter in a subsequent call to the operation
1539
+ # to get the next part of the output. You should repeat this until the
1540
+ # `NextToken` response element comes back as `null`. This indicates
1541
+ # that this is the last page of results.
1072
1542
  # @return [String]
1073
1543
  #
1074
1544
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPrincipalsResponse AWS API Documentation
@@ -1090,17 +1560,33 @@ module Aws::RAM
1090
1560
  # }
1091
1561
  #
1092
1562
  # @!attribute [rw] resource_share_arn
1093
- # The Amazon Resource Name (ARN) of the resource share.
1563
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
1564
+ # for which you want to retrieve the associated permissions.
1565
+ #
1566
+ #
1567
+ #
1568
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1094
1569
  # @return [String]
1095
1570
  #
1096
1571
  # @!attribute [rw] next_token
1097
- # The token for the next page of results.
1572
+ # Specifies that you want to receive the next page of results. Valid
1573
+ # only if you received a `NextToken` response in the previous request.
1574
+ # If you did, it indicates that more output is available. Set this
1575
+ # parameter to the value provided by the previous call's `NextToken`
1576
+ # response to request the next page of results.
1098
1577
  # @return [String]
1099
1578
  #
1100
1579
  # @!attribute [rw] max_results
1101
- # The maximum number of results to return with a single call. To
1102
- # retrieve the remaining results, make another call with the returned
1103
- # `nextToken` value.
1580
+ # Specifies the total number of results that you want included on each
1581
+ # page of the response. If you do not include this parameter, it
1582
+ # defaults to a value that is specific to the operation. If additional
1583
+ # items exist beyond the number you specify, the `NextToken` response
1584
+ # element is returned with a value (not null). Include the specified
1585
+ # value as the `NextToken` request parameter in the next call to the
1586
+ # operation to get the next part of the results. Note that the service
1587
+ # might return fewer results than the maximum even when there are more
1588
+ # results available. You should check `NextToken` after every
1589
+ # operation to ensure that you receive all of the results.
1104
1590
  # @return [Integer]
1105
1591
  #
1106
1592
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceSharePermissionsRequest AWS API Documentation
@@ -1114,12 +1600,17 @@ module Aws::RAM
1114
1600
  end
1115
1601
 
1116
1602
  # @!attribute [rw] permissions
1117
- # The permissions associated with the resource share.
1603
+ # An array of objects that describe the permissions associated with
1604
+ # the resource share.
1118
1605
  # @return [Array<Types::ResourceSharePermissionSummary>]
1119
1606
  #
1120
1607
  # @!attribute [rw] next_token
1121
- # The token to use to retrieve the next page of results. This value is
1122
- # `null` when there are no more results to return.
1608
+ # If present, this value indicates that more output is available than
1609
+ # is included in the current response. Use this value in the
1610
+ # `NextToken` request parameter in a subsequent call to the operation
1611
+ # to get the next part of the output. You should repeat this until the
1612
+ # `NextToken` response element comes back as `null`. This indicates
1613
+ # that this is the last page of results.
1123
1614
  # @return [String]
1124
1615
  #
1125
1616
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceSharePermissionsResponse AWS API Documentation
@@ -1137,34 +1628,68 @@ module Aws::RAM
1137
1628
  # {
1138
1629
  # next_token: "String",
1139
1630
  # max_results: 1,
1631
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
1140
1632
  # }
1141
1633
  #
1142
1634
  # @!attribute [rw] next_token
1143
- # The token for the next page of results.
1635
+ # Specifies that you want to receive the next page of results. Valid
1636
+ # only if you received a `NextToken` response in the previous request.
1637
+ # If you did, it indicates that more output is available. Set this
1638
+ # parameter to the value provided by the previous call's `NextToken`
1639
+ # response to request the next page of results.
1144
1640
  # @return [String]
1145
1641
  #
1146
1642
  # @!attribute [rw] max_results
1147
- # The maximum number of results to return with a single call. To
1148
- # retrieve the remaining results, make another call with the returned
1149
- # `nextToken` value.
1643
+ # Specifies the total number of results that you want included on each
1644
+ # page of the response. If you do not include this parameter, it
1645
+ # defaults to a value that is specific to the operation. If additional
1646
+ # items exist beyond the number you specify, the `NextToken` response
1647
+ # element is returned with a value (not null). Include the specified
1648
+ # value as the `NextToken` request parameter in the next call to the
1649
+ # operation to get the next part of the results. Note that the service
1650
+ # might return fewer results than the maximum even when there are more
1651
+ # results available. You should check `NextToken` after every
1652
+ # operation to ensure that you receive all of the results.
1150
1653
  # @return [Integer]
1151
1654
  #
1655
+ # @!attribute [rw] resource_region_scope
1656
+ # Specifies that you want the results to include only resources that
1657
+ # have the specified scope.
1658
+ #
1659
+ # * `ALL` – the results include both global and regional resources or
1660
+ # resource types.
1661
+ #
1662
+ # * `GLOBAL` – the results include only global resources or resource
1663
+ # types.
1664
+ #
1665
+ # * `REGIONAL` – the results include only regional resources or
1666
+ # resource types.
1667
+ #
1668
+ # The default value is `ALL`.
1669
+ # @return [String]
1670
+ #
1152
1671
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypesRequest AWS API Documentation
1153
1672
  #
1154
1673
  class ListResourceTypesRequest < Struct.new(
1155
1674
  :next_token,
1156
- :max_results)
1675
+ :max_results,
1676
+ :resource_region_scope)
1157
1677
  SENSITIVE = []
1158
1678
  include Aws::Structure
1159
1679
  end
1160
1680
 
1161
1681
  # @!attribute [rw] resource_types
1162
- # The shareable resource types supported by RAM.
1682
+ # An array of objects that contain information about the resource
1683
+ # types that can be shared using RAM.
1163
1684
  # @return [Array<Types::ServiceNameAndResourceType>]
1164
1685
  #
1165
1686
  # @!attribute [rw] next_token
1166
- # The token to use to retrieve the next page of results. This value is
1167
- # `null` when there are no more results to return.
1687
+ # If present, this value indicates that more output is available than
1688
+ # is included in the current response. Use this value in the
1689
+ # `NextToken` request parameter in a subsequent call to the operation
1690
+ # to get the next part of the output. You should repeat this until the
1691
+ # `NextToken` response element comes back as `null`. This indicates
1692
+ # that this is the last page of results.
1168
1693
  # @return [String]
1169
1694
  #
1170
1695
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypesResponse AWS API Documentation
@@ -1187,56 +1712,88 @@ module Aws::RAM
1187
1712
  # resource_share_arns: ["String"],
1188
1713
  # next_token: "String",
1189
1714
  # max_results: 1,
1715
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
1190
1716
  # }
1191
1717
  #
1192
1718
  # @!attribute [rw] resource_owner
1193
- # The type of owner.
1719
+ # Specifies that you want to list only the resource shares that match
1720
+ # the following:
1721
+ #
1722
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1723
+ #
1724
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other
1725
+ # accounts share with you
1194
1726
  # @return [String]
1195
1727
  #
1196
1728
  # @!attribute [rw] principal
1197
- # The principal.
1729
+ # Specifies that you want to list only the resource shares that are
1730
+ # associated with the specified principal.
1198
1731
  # @return [String]
1199
1732
  #
1200
1733
  # @!attribute [rw] resource_type
1201
- # The resource type.
1202
- #
1203
- # Valid values: `acm-pca:CertificateAuthority` \| `appmesh:Mesh` \|
1204
- # `codebuild:Project` \| `codebuild:ReportGroup` \|
1205
- # `ec2:CapacityReservation` \| `ec2:DedicatedHost` \|
1206
- # `ec2:LocalGatewayRouteTable` \| `ec2:PrefixList` \| `ec2:Subnet` \|
1207
- # `ec2:TrafficMirrorTarget` \| `ec2:TransitGateway` \|
1208
- # `imagebuilder:Component` \| `imagebuilder:Image` \|
1209
- # `imagebuilder:ImageRecipe` \| `imagebuilder:ContainerRecipe` \|
1210
- # `glue:Catalog` \| `glue:Database` \| `glue:Table` \|
1211
- # `license-manager:LicenseConfiguration` I
1212
- # `network-firewall:FirewallPolicy` \|
1213
- # `network-firewall:StatefulRuleGroup` \|
1214
- # `network-firewall:StatelessRuleGroup` \| `outposts:Outpost` \|
1215
- # `resource-groups:Group` \| `rds:Cluster` \|
1216
- # `route53resolver:FirewallRuleGroup`
1217
- # \|`route53resolver:ResolverQueryLogConfig` \|
1218
- # `route53resolver:ResolverRule` \| `s3-outposts:Outpost` \|
1219
- # `ssm-contacts:Contact` \| `ssm-incidents:ResponsePlan`
1734
+ # Specifies that you want to list only the resource shares that
1735
+ # include resources of the specified resource type.
1736
+ #
1737
+ # For valid values, query the ListResourceTypes operation.
1220
1738
  # @return [String]
1221
1739
  #
1222
1740
  # @!attribute [rw] resource_arns
1223
- # The Amazon Resource Names (ARNs) of the resources.
1741
+ # Specifies that you want to list only the resource shares that
1742
+ # include resources with the specified [Amazon Resource Names
1743
+ # (ARNs)][1].
1744
+ #
1745
+ #
1746
+ #
1747
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1224
1748
  # @return [Array<String>]
1225
1749
  #
1226
1750
  # @!attribute [rw] resource_share_arns
1227
- # The Amazon Resource Names (ARN) of the resource shares.
1751
+ # Specifies that you want to list only resources in the resource
1752
+ # shares identified by the specified [Amazon Resource Names
1753
+ # (ARNs)][1].
1754
+ #
1755
+ #
1756
+ #
1757
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1228
1758
  # @return [Array<String>]
1229
1759
  #
1230
1760
  # @!attribute [rw] next_token
1231
- # The token for the next page of results.
1761
+ # Specifies that you want to receive the next page of results. Valid
1762
+ # only if you received a `NextToken` response in the previous request.
1763
+ # If you did, it indicates that more output is available. Set this
1764
+ # parameter to the value provided by the previous call's `NextToken`
1765
+ # response to request the next page of results.
1232
1766
  # @return [String]
1233
1767
  #
1234
1768
  # @!attribute [rw] max_results
1235
- # The maximum number of results to return with a single call. To
1236
- # retrieve the remaining results, make another call with the returned
1237
- # `nextToken` value.
1769
+ # Specifies the total number of results that you want included on each
1770
+ # page of the response. If you do not include this parameter, it
1771
+ # defaults to a value that is specific to the operation. If additional
1772
+ # items exist beyond the number you specify, the `NextToken` response
1773
+ # element is returned with a value (not null). Include the specified
1774
+ # value as the `NextToken` request parameter in the next call to the
1775
+ # operation to get the next part of the results. Note that the service
1776
+ # might return fewer results than the maximum even when there are more
1777
+ # results available. You should check `NextToken` after every
1778
+ # operation to ensure that you receive all of the results.
1238
1779
  # @return [Integer]
1239
1780
  #
1781
+ # @!attribute [rw] resource_region_scope
1782
+ # Specifies that you want the results to include only resources that
1783
+ # have the specified scope.
1784
+ #
1785
+ # * `ALL` – the results include both global and regional resources or
1786
+ # resource types.
1787
+ #
1788
+ # * `GLOBAL` – the results include only global resources or resource
1789
+ # types.
1790
+ #
1791
+ # * `REGIONAL` – the results include only regional resources or
1792
+ # resource types.
1793
+ #
1794
+ # The default value is `ALL`.
1795
+ # @return [String]
1796
+ #
1240
1797
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourcesRequest AWS API Documentation
1241
1798
  #
1242
1799
  class ListResourcesRequest < Struct.new(
@@ -1246,18 +1803,23 @@ module Aws::RAM
1246
1803
  :resource_arns,
1247
1804
  :resource_share_arns,
1248
1805
  :next_token,
1249
- :max_results)
1806
+ :max_results,
1807
+ :resource_region_scope)
1250
1808
  SENSITIVE = []
1251
1809
  include Aws::Structure
1252
1810
  end
1253
1811
 
1254
1812
  # @!attribute [rw] resources
1255
- # Information about the resources.
1813
+ # An array of objects that contain information about the resources.
1256
1814
  # @return [Array<Types::Resource>]
1257
1815
  #
1258
1816
  # @!attribute [rw] next_token
1259
- # The token to use to retrieve the next page of results. This value is
1260
- # `null` when there are no more results to return.
1817
+ # If present, this value indicates that more output is available than
1818
+ # is included in the current response. Use this value in the
1819
+ # `NextToken` request parameter in a subsequent call to the operation
1820
+ # to get the next part of the output. You should repeat this until the
1821
+ # `NextToken` response element comes back as `null`. This indicates
1822
+ # that this is the last page of results.
1261
1823
  # @return [String]
1262
1824
  #
1263
1825
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourcesResponse AWS API Documentation
@@ -1315,15 +1877,21 @@ module Aws::RAM
1315
1877
  # @return [String]
1316
1878
  #
1317
1879
  # @!attribute [rw] resource_share_arn
1318
- # The Amazon Resource Name (ARN) of the resource share.
1880
+ # The [Amazon Resoure Name (ARN)][1] of a resource share the principal
1881
+ # is associated with.
1882
+ #
1883
+ #
1884
+ #
1885
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1319
1886
  # @return [String]
1320
1887
  #
1321
1888
  # @!attribute [rw] creation_time
1322
- # The time when the principal was associated with the resource share.
1889
+ # The date and time when the principal was associated with the
1890
+ # resource share.
1323
1891
  # @return [Time]
1324
1892
  #
1325
1893
  # @!attribute [rw] last_updated_time
1326
- # The time when the association was last updated.
1894
+ # The date and time when the association was last updated.
1327
1895
  # @return [Time]
1328
1896
  #
1329
1897
  # @!attribute [rw] external
@@ -1352,7 +1920,12 @@ module Aws::RAM
1352
1920
  # }
1353
1921
  #
1354
1922
  # @!attribute [rw] resource_share_arn
1355
- # The Amazon Resource Name (ARN) of the resource share to promote.
1923
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
1924
+ # to promote.
1925
+ #
1926
+ #
1927
+ #
1928
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1356
1929
  # @return [String]
1357
1930
  #
1358
1931
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/PromoteResourceShareCreatedFromPolicyRequest AWS API Documentation
@@ -1364,7 +1937,8 @@ module Aws::RAM
1364
1937
  end
1365
1938
 
1366
1939
  # @!attribute [rw] return_value
1367
- # Indicates whether the request succeeded.
1940
+ # A return value of `true` indicates that the request succeeded. A
1941
+ # value of `false` indicates that the request failed.
1368
1942
  # @return [Boolean]
1369
1943
  #
1370
1944
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/PromoteResourceShareCreatedFromPolicyResponse AWS API Documentation
@@ -1384,12 +1958,28 @@ module Aws::RAM
1384
1958
  # }
1385
1959
  #
1386
1960
  # @!attribute [rw] resource_share_invitation_arn
1387
- # The Amazon Resource Name (ARN) of the invitation.
1961
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the invitation that
1962
+ # you want to reject.
1963
+ #
1964
+ #
1965
+ #
1966
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1388
1967
  # @return [String]
1389
1968
  #
1390
1969
  # @!attribute [rw] client_token
1391
- # A unique, case-sensitive identifier that you provide to ensure the
1392
- # idempotency of the request.
1970
+ # Specifies a unique, case-sensitive identifier that you provide to
1971
+ # ensure the idempotency of the request. This lets you safely retry
1972
+ # the request without accidentally performing the same operation a
1973
+ # second time. Passing the same value to a later call to an operation
1974
+ # requires that you also pass the same value for all other parameters.
1975
+ # We recommend that you use a [UUID type of value.][1].
1976
+ #
1977
+ # If you don't provide this value, then Amazon Web Services generates
1978
+ # a random one for you.
1979
+ #
1980
+ #
1981
+ #
1982
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
1393
1983
  # @return [String]
1394
1984
  #
1395
1985
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/RejectResourceShareInvitationRequest AWS API Documentation
@@ -1402,12 +1992,15 @@ module Aws::RAM
1402
1992
  end
1403
1993
 
1404
1994
  # @!attribute [rw] resource_share_invitation
1405
- # Information about the invitation.
1995
+ # An object that contains the details about the rejected invitation.
1406
1996
  # @return [Types::ResourceShareInvitation]
1407
1997
  #
1408
1998
  # @!attribute [rw] client_token
1409
- # A unique, case-sensitive identifier that you provide to ensure the
1410
- # idempotency of the request.
1999
+ # The idempotency identifier associated with this request. If you want
2000
+ # to repeat the same operation in an idempotent manner then you must
2001
+ # include this value in the `clientToken` request parameter of that
2002
+ # later call. All other parameters must also have the same values that
2003
+ # you used in the first call.
1411
2004
  # @return [String]
1412
2005
  #
1413
2006
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/RejectResourceShareInvitationResponse AWS API Documentation
@@ -1419,27 +2012,41 @@ module Aws::RAM
1419
2012
  include Aws::Structure
1420
2013
  end
1421
2014
 
1422
- # Describes a resource associated with a resource share.
2015
+ # Describes a resource associated with a resource share in RAM.
1423
2016
  #
1424
2017
  # @!attribute [rw] arn
1425
- # The Amazon Resource Name (ARN) of the resource.
2018
+ # The [Amazon Resoure Name (ARN)][1] of the resource.
2019
+ #
2020
+ #
2021
+ #
2022
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1426
2023
  # @return [String]
1427
2024
  #
1428
2025
  # @!attribute [rw] type
1429
- # The resource type.
2026
+ # The resource type. This takes the form of:
2027
+ # `service-code`\:`resource-code`
1430
2028
  # @return [String]
1431
2029
  #
1432
2030
  # @!attribute [rw] resource_share_arn
1433
- # The Amazon Resource Name (ARN) of the resource share.
2031
+ # The [Amazon Resoure Name (ARN)][1] of the resource share this
2032
+ # resource is associated with.
2033
+ #
2034
+ #
2035
+ #
2036
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1434
2037
  # @return [String]
1435
2038
  #
1436
2039
  # @!attribute [rw] resource_group_arn
1437
- # The Amazon Resource Name (ARN) of the resource group. This value is
1438
- # returned only if the resource is a resource group.
2040
+ # The [Amazon Resoure Name (ARN)][1] of the resource group. This value
2041
+ # is available only if the resource is part of a resource group.
2042
+ #
2043
+ #
2044
+ #
2045
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1439
2046
  # @return [String]
1440
2047
  #
1441
2048
  # @!attribute [rw] status
1442
- # The status of the resource.
2049
+ # The current status of the resource.
1443
2050
  # @return [String]
1444
2051
  #
1445
2052
  # @!attribute [rw] status_message
@@ -1447,13 +2054,25 @@ module Aws::RAM
1447
2054
  # @return [String]
1448
2055
  #
1449
2056
  # @!attribute [rw] creation_time
1450
- # The time when the resource was associated with the resource share.
2057
+ # The date and time when the resource was associated with the resource
2058
+ # share.
1451
2059
  # @return [Time]
1452
2060
  #
1453
2061
  # @!attribute [rw] last_updated_time
1454
- # The time when the association was last updated.
2062
+ # The date an time when the association was last updated.
1455
2063
  # @return [Time]
1456
2064
  #
2065
+ # @!attribute [rw] resource_region_scope
2066
+ # Specifies the scope of visibility of this resource:
2067
+ #
2068
+ # * **REGIONAL** – The resource can be accessed only by using requests
2069
+ # that target the Amazon Web Services Region in which the resource
2070
+ # exists.
2071
+ #
2072
+ # * **GLOBAL** – The resource can be accessed from any Amazon Web
2073
+ # Services Region.
2074
+ # @return [String]
2075
+ #
1457
2076
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/Resource AWS API Documentation
1458
2077
  #
1459
2078
  class Resource < Struct.new(
@@ -1464,12 +2083,13 @@ module Aws::RAM
1464
2083
  :status,
1465
2084
  :status_message,
1466
2085
  :creation_time,
1467
- :last_updated_time)
2086
+ :last_updated_time,
2087
+ :resource_region_scope)
1468
2088
  SENSITIVE = []
1469
2089
  include Aws::Structure
1470
2090
  end
1471
2091
 
1472
- # An Amazon Resource Name (ARN) was not found.
2092
+ # The specified Amazon Resource Name (ARN) was not found.
1473
2093
  #
1474
2094
  # @!attribute [rw] message
1475
2095
  # @return [String]
@@ -1482,10 +2102,14 @@ module Aws::RAM
1482
2102
  include Aws::Structure
1483
2103
  end
1484
2104
 
1485
- # Describes a resource share.
2105
+ # Describes a resource share in RAM.
1486
2106
  #
1487
2107
  # @!attribute [rw] resource_share_arn
1488
- # The Amazon Resource Name (ARN) of the resource share.
2108
+ # The [Amazon Resoure Name (ARN)][1] of the resource share
2109
+ #
2110
+ #
2111
+ #
2112
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1489
2113
  # @return [String]
1490
2114
  #
1491
2115
  # @!attribute [rw] name
@@ -1503,7 +2127,7 @@ module Aws::RAM
1503
2127
  # @return [Boolean]
1504
2128
  #
1505
2129
  # @!attribute [rw] status
1506
- # The status of the resource share.
2130
+ # The current status of the resource share.
1507
2131
  # @return [String]
1508
2132
  #
1509
2133
  # @!attribute [rw] status_message
@@ -1511,15 +2135,15 @@ module Aws::RAM
1511
2135
  # @return [String]
1512
2136
  #
1513
2137
  # @!attribute [rw] tags
1514
- # The tags for the resource share.
2138
+ # The tag key and value pairs attached to the resource share.
1515
2139
  # @return [Array<Types::Tag>]
1516
2140
  #
1517
2141
  # @!attribute [rw] creation_time
1518
- # The time when the resource share was created.
2142
+ # The date and time when the resource share was created.
1519
2143
  # @return [Time]
1520
2144
  #
1521
2145
  # @!attribute [rw] last_updated_time
1522
- # The time when the resource share was last updated.
2146
+ # The date and time when the resource share was last updated.
1523
2147
  # @return [Time]
1524
2148
  #
1525
2149
  # @!attribute [rw] feature_set
@@ -1527,10 +2151,12 @@ module Aws::RAM
1527
2151
  # include:
1528
2152
  #
1529
2153
  # * `CREATED_FROM_POLICY` - Indicates that the resource share was
1530
- # created from an Amazon Web Services Identity and Access Management
1531
- # (Amazon Web Services IAM) policy attached to a resource. These
1532
- # resource shares are visible only to the Amazon Web Services
1533
- # account that created it. They cannot be modified in RAM.
2154
+ # created from an Identity and Access Management (IAM)
2155
+ # resource-based permission policy attached to the resource. This
2156
+ # type of resource share is visible only to the Amazon Web Services
2157
+ # account that created it. You can't modify it in RAM unless you
2158
+ # promote it. For more information, see
2159
+ # PromoteResourceShareCreatedFromPolicy.
1534
2160
  #
1535
2161
  # * `PROMOTING_TO_STANDARD` - The resource share is in the process of
1536
2162
  # being promoted. For more information, see
@@ -1538,7 +2164,8 @@ module Aws::RAM
1538
2164
  #
1539
2165
  # * `STANDARD` - Indicates that the resource share was created in RAM
1540
2166
  # using the console or APIs. These resource shares are visible to
1541
- # all principals. They can be modified in RAM.
2167
+ # all principals you share the resource share with. You can modify
2168
+ # these resource shares in RAM using the console or APIs.
1542
2169
  # @return [String]
1543
2170
  #
1544
2171
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceShare AWS API Documentation
@@ -1558,10 +2185,15 @@ module Aws::RAM
1558
2185
  include Aws::Structure
1559
2186
  end
1560
2187
 
1561
- # Describes an association with a resource share.
2188
+ # Describes an association with a resource share and either a principal
2189
+ # or a resource.
1562
2190
  #
1563
2191
  # @!attribute [rw] resource_share_arn
1564
- # The Amazon Resource Name (ARN) of the resource share.
2192
+ # The [Amazon Resoure Name (ARN)][1] of the resource share.
2193
+ #
2194
+ #
2195
+ #
2196
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1565
2197
  # @return [String]
1566
2198
  #
1567
2199
  # @!attribute [rw] resource_share_name
@@ -1569,27 +2201,35 @@ module Aws::RAM
1569
2201
  # @return [String]
1570
2202
  #
1571
2203
  # @!attribute [rw] associated_entity
1572
- # The associated entity. For resource associations, this is the Amazon
1573
- # Resource Name (ARN) of the resource. For principal associations,
1574
- # this is one of the following:
2204
+ # The associated entity. This can be either of the following:
2205
+ #
2206
+ # * For a resource association, this is the [Amazon Resoure Name
2207
+ # (ARN)][1] of the resource.
2208
+ #
2209
+ # * For principal associations, this is one of the following:
1575
2210
  #
1576
- # * An Amazon Web Services account ID
2211
+ # * The ID of an Amazon Web Services account
1577
2212
  #
1578
- # * An ARN of an organization in Organizations
2213
+ # * The [Amazon Resoure Name (ARN)][1] of an organization in
2214
+ # Organizations
1579
2215
  #
1580
- # * An ARN of an organizational unit (OU) in Organizations
2216
+ # * The ARN of an organizational unit (OU) in Organizations
1581
2217
  #
1582
- # * An ARN of an IAM role
2218
+ # * The ARN of an IAM role
1583
2219
  #
1584
- # * An ARN of an IAM user
2220
+ # * The ARN of an IAM user
2221
+ #
2222
+ #
2223
+ #
2224
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1585
2225
  # @return [String]
1586
2226
  #
1587
2227
  # @!attribute [rw] association_type
1588
- # The association type.
2228
+ # The type of entity included in this association.
1589
2229
  # @return [String]
1590
2230
  #
1591
2231
  # @!attribute [rw] status
1592
- # The status of the association.
2232
+ # The current status of the association.
1593
2233
  # @return [String]
1594
2234
  #
1595
2235
  # @!attribute [rw] status_message
@@ -1597,11 +2237,11 @@ module Aws::RAM
1597
2237
  # @return [String]
1598
2238
  #
1599
2239
  # @!attribute [rw] creation_time
1600
- # The time when the association was created.
2240
+ # The date and time when the association was created.
1601
2241
  # @return [Time]
1602
2242
  #
1603
2243
  # @!attribute [rw] last_updated_time
1604
- # The time when the association was last updated.
2244
+ # The date and time when the association was last updated.
1605
2245
  # @return [Time]
1606
2246
  #
1607
2247
  # @!attribute [rw] external
@@ -1626,10 +2266,15 @@ module Aws::RAM
1626
2266
  include Aws::Structure
1627
2267
  end
1628
2268
 
1629
- # Describes an invitation to join a resource share.
2269
+ # Describes an invitation for an Amazon Web Services account to join a
2270
+ # resource share.
1630
2271
  #
1631
2272
  # @!attribute [rw] resource_share_invitation_arn
1632
- # The Amazon Resource Name (ARN) of the invitation.
2273
+ # The [Amazon Resoure Name (ARN)][1] of the invitation.
2274
+ #
2275
+ #
2276
+ #
2277
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1633
2278
  # @return [String]
1634
2279
  #
1635
2280
  # @!attribute [rw] resource_share_name
@@ -1637,7 +2282,11 @@ module Aws::RAM
1637
2282
  # @return [String]
1638
2283
  #
1639
2284
  # @!attribute [rw] resource_share_arn
1640
- # The Amazon Resource Name (ARN) of the resource share.
2285
+ # The [Amazon Resoure Name (ARN)][1] of the resource share
2286
+ #
2287
+ #
2288
+ #
2289
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1641
2290
  # @return [String]
1642
2291
  #
1643
2292
  # @!attribute [rw] sender_account_id
@@ -1654,21 +2303,21 @@ module Aws::RAM
1654
2303
  # @return [Time]
1655
2304
  #
1656
2305
  # @!attribute [rw] status
1657
- # The status of the invitation.
2306
+ # The current status of the invitation.
1658
2307
  # @return [String]
1659
2308
  #
1660
2309
  # @!attribute [rw] resource_share_associations
1661
2310
  # To view the resources associated with a pending resource share
1662
- # invitation, use [ ListPendingInvitationResources][1].
1663
- #
1664
- #
1665
- #
1666
- # [1]: https://docs.aws.amazon.com/ram/latest/APIReference/API_ListPendingInvitationResources.html
2311
+ # invitation, use ListPendingInvitationResources.
1667
2312
  # @return [Array<Types::ResourceShareAssociation>]
1668
2313
  #
1669
2314
  # @!attribute [rw] receiver_arn
1670
- # The Amazon Resource Name (ARN) of the IAM user or IAM role that
2315
+ # The [Amazon Resoure Name (ARN)][1] of the IAM user or role that
1671
2316
  # received the invitation.
2317
+ #
2318
+ #
2319
+ #
2320
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1672
2321
  # @return [String]
1673
2322
  #
1674
2323
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceShareInvitation AWS API Documentation
@@ -1687,7 +2336,7 @@ module Aws::RAM
1687
2336
  include Aws::Structure
1688
2337
  end
1689
2338
 
1690
- # The invitation was already accepted.
2339
+ # The specified invitation was already accepted.
1691
2340
  #
1692
2341
  # @!attribute [rw] message
1693
2342
  # @return [String]
@@ -1700,7 +2349,7 @@ module Aws::RAM
1700
2349
  include Aws::Structure
1701
2350
  end
1702
2351
 
1703
- # The invitation was already rejected.
2352
+ # The specified invitation was already rejected.
1704
2353
  #
1705
2354
  # @!attribute [rw] message
1706
2355
  # @return [String]
@@ -1713,7 +2362,8 @@ module Aws::RAM
1713
2362
  include Aws::Structure
1714
2363
  end
1715
2364
 
1716
- # The Amazon Resource Name (ARN) for an invitation was not found.
2365
+ # The specified Amazon Resource Name (ARN) for an invitation was not
2366
+ # found.
1717
2367
  #
1718
2368
  # @!attribute [rw] message
1719
2369
  # @return [String]
@@ -1726,7 +2376,7 @@ module Aws::RAM
1726
2376
  include Aws::Structure
1727
2377
  end
1728
2378
 
1729
- # The invitation is expired.
2379
+ # The specified invitation is expired.
1730
2380
  #
1731
2381
  # @!attribute [rw] message
1732
2382
  # @return [String]
@@ -1739,7 +2389,8 @@ module Aws::RAM
1739
2389
  include Aws::Structure
1740
2390
  end
1741
2391
 
1742
- # The requested resource share exceeds the limit for your account.
2392
+ # This request would exceed the limit for resource shares for your
2393
+ # account.
1743
2394
  #
1744
2395
  # @!attribute [rw] message
1745
2396
  # @return [String]
@@ -1755,31 +2406,35 @@ module Aws::RAM
1755
2406
  # Information about an RAM permission.
1756
2407
  #
1757
2408
  # @!attribute [rw] arn
1758
- # The Amazon Resource Name (ARN) of the permission.
2409
+ # The [Amazon Resoure Name (ARN)][1] of this RAM permission.
2410
+ #
2411
+ #
2412
+ #
2413
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1759
2414
  # @return [String]
1760
2415
  #
1761
2416
  # @!attribute [rw] version
1762
- # The identifier for the version of the permission.
2417
+ # The version of the permission represented in this structure.
1763
2418
  # @return [String]
1764
2419
  #
1765
2420
  # @!attribute [rw] default_version
1766
- # Specifies whether the version of the permission is set to the
1767
- # default version for this permission.
2421
+ # Specifies whether the version of the permission represented in this
2422
+ # structure is the default version for this permission.
1768
2423
  # @return [Boolean]
1769
2424
  #
1770
2425
  # @!attribute [rw] name
1771
- # The name of the permission.
2426
+ # The name of this permission.
1772
2427
  # @return [String]
1773
2428
  #
1774
2429
  # @!attribute [rw] resource_type
1775
- # The resource type to which the permission applies.
2430
+ # The resource type to which this permission applies.
1776
2431
  # @return [String]
1777
2432
  #
1778
2433
  # @!attribute [rw] permission
1779
2434
  # The permission's effect and actions in JSON format. The `effect`
1780
- # indicates whether the actions are allowed or denied. The `actions`
1781
- # list the API actions to which the principal is granted or denied
1782
- # access.
2435
+ # indicates whether the specified actions are allowed or denied. The
2436
+ # `actions` list the operations to which the principal is granted or
2437
+ # denied access.
1783
2438
  # @return [String]
1784
2439
  #
1785
2440
  # @!attribute [rw] creation_time
@@ -1791,8 +2446,9 @@ module Aws::RAM
1791
2446
  # @return [Time]
1792
2447
  #
1793
2448
  # @!attribute [rw] is_resource_type_default
1794
- # Specifies whether the version of the permission is set to the
1795
- # default version for this resource type.
2449
+ # Specifies whether the version of the permission represented in this
2450
+ # structure is the default version for all resources of this resource
2451
+ # type.
1796
2452
  # @return [Boolean]
1797
2453
  #
1798
2454
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceSharePermissionDetail AWS API Documentation
@@ -1811,28 +2467,33 @@ module Aws::RAM
1811
2467
  include Aws::Structure
1812
2468
  end
1813
2469
 
1814
- # Information about a permission that is associated with a resource
1815
- # share.
2470
+ # Information about an RAM permission that is associated with a resource
2471
+ # share and any of its resources of a specified type.
1816
2472
  #
1817
2473
  # @!attribute [rw] arn
1818
- # The Amazon Resource Name (ARN) of the permission.
2474
+ # The [Amazon Resoure Name (ARN)][1] of the permission you want
2475
+ # information about.
2476
+ #
2477
+ #
2478
+ #
2479
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1819
2480
  # @return [String]
1820
2481
  #
1821
2482
  # @!attribute [rw] version
1822
- # The identifier for the version of the permission.
2483
+ # The version of the permission represented in this structure.
1823
2484
  # @return [String]
1824
2485
  #
1825
2486
  # @!attribute [rw] default_version
1826
- # Specifies whether the version of the permission is set to the
1827
- # default version for this permission.
2487
+ # Specifies whether the version of the permission represented in this
2488
+ # structure is the default version for this permission.
1828
2489
  # @return [Boolean]
1829
2490
  #
1830
2491
  # @!attribute [rw] name
1831
- # The name of the permission.
2492
+ # The name of this permission.
1832
2493
  # @return [String]
1833
2494
  #
1834
2495
  # @!attribute [rw] resource_type
1835
- # The type of resource to which the permission applies.
2496
+ # The type of resource to which this permission applies.
1836
2497
  # @return [String]
1837
2498
  #
1838
2499
  # @!attribute [rw] status
@@ -1848,8 +2509,9 @@ module Aws::RAM
1848
2509
  # @return [Time]
1849
2510
  #
1850
2511
  # @!attribute [rw] is_resource_type_default
1851
- # Specifies whether the version of the permission is set to the
1852
- # default version for this resource type.
2512
+ # Specifies whether the version of the permission represented in this
2513
+ # structure is the default version for all resources of this resource
2514
+ # type.
1853
2515
  # @return [Boolean]
1854
2516
  #
1855
2517
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceSharePermissionSummary AWS API Documentation
@@ -1882,23 +2544,35 @@ module Aws::RAM
1882
2544
  include Aws::Structure
1883
2545
  end
1884
2546
 
1885
- # Information about the shareable resource types and the Amazon Web
1886
- # Services services to which they belong.
2547
+ # Information about a shareable resource type and the Amazon Web
2548
+ # Services service to which resources of that type belong.
1887
2549
  #
1888
2550
  # @!attribute [rw] resource_type
1889
- # The shareable resource types.
2551
+ # The type of the resource.
1890
2552
  # @return [String]
1891
2553
  #
1892
2554
  # @!attribute [rw] service_name
1893
- # The name of the Amazon Web Services services to which the resources
1894
- # belong.
2555
+ # The name of the Amazon Web Services service to which resources of
2556
+ # this type belong.
2557
+ # @return [String]
2558
+ #
2559
+ # @!attribute [rw] resource_region_scope
2560
+ # Specifies the scope of visibility of resources of this type:
2561
+ #
2562
+ # * **REGIONAL** – The resource can be accessed only by using requests
2563
+ # that target the Amazon Web Services Region in which the resource
2564
+ # exists.
2565
+ #
2566
+ # * **GLOBAL** – The resource can be accessed from any Amazon Web
2567
+ # Services Region.
1895
2568
  # @return [String]
1896
2569
  #
1897
2570
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ServiceNameAndResourceType AWS API Documentation
1898
2571
  #
1899
2572
  class ServiceNameAndResourceType < Struct.new(
1900
2573
  :resource_type,
1901
- :service_name)
2574
+ :service_name,
2575
+ :resource_region_scope)
1902
2576
  SENSITIVE = []
1903
2577
  include Aws::Structure
1904
2578
  end
@@ -1916,7 +2590,18 @@ module Aws::RAM
1916
2590
  include Aws::Structure
1917
2591
  end
1918
2592
 
1919
- # Information about a tag.
2593
+ # A structure containing a tag. A tag is metadata that you can attach to
2594
+ # your resources to help organize and categorize them. You can also use
2595
+ # them to help you secure your resources. For more information, see
2596
+ # [Controlling access to Amazon Web Services resources using tags][1].
2597
+ #
2598
+ # For more information about tags, see [Tagging Amazon Web Services
2599
+ # resources][2] in the *Amazon Web Services General Reference Guide*.
2600
+ #
2601
+ #
2602
+ #
2603
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html
2604
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
1920
2605
  #
1921
2606
  # @note When making an API call, you may pass Tag
1922
2607
  # data as a hash:
@@ -1927,11 +2612,13 @@ module Aws::RAM
1927
2612
  # }
1928
2613
  #
1929
2614
  # @!attribute [rw] key
1930
- # The key of the tag.
2615
+ # The key, or name, attached to the tag. Every tag must have a key.
2616
+ # Key names are case sensitive.
1931
2617
  # @return [String]
1932
2618
  #
1933
2619
  # @!attribute [rw] value
1934
- # The value of the tag.
2620
+ # The string value attached to the tag. The value can be an empty
2621
+ # string. Key values are case sensitive.
1935
2622
  # @return [String]
1936
2623
  #
1937
2624
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/Tag AWS API Documentation
@@ -1943,7 +2630,8 @@ module Aws::RAM
1943
2630
  include Aws::Structure
1944
2631
  end
1945
2632
 
1946
- # Used to filter information based on tags.
2633
+ # A tag key and optional list of possible values that you can use to
2634
+ # filter results for tagged resources.
1947
2635
  #
1948
2636
  # @note When making an API call, you may pass TagFilter
1949
2637
  # data as a hash:
@@ -1954,11 +2642,14 @@ module Aws::RAM
1954
2642
  # }
1955
2643
  #
1956
2644
  # @!attribute [rw] tag_key
1957
- # The tag key.
2645
+ # The tag key. This must have a valid string value and can't be
2646
+ # empty.
1958
2647
  # @return [String]
1959
2648
  #
1960
2649
  # @!attribute [rw] tag_values
1961
- # The tag values.
2650
+ # A list of zero or more tag values. If no values are provided, then
2651
+ # the filter matches any tag with the specified key, regardless of its
2652
+ # value.
1962
2653
  # @return [Array<String>]
1963
2654
  #
1964
2655
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/TagFilter AWS API Documentation
@@ -1970,7 +2661,7 @@ module Aws::RAM
1970
2661
  include Aws::Structure
1971
2662
  end
1972
2663
 
1973
- # The requested tags exceed the limit for your account.
2664
+ # This request would exceed the limit for tags for your account.
1974
2665
  #
1975
2666
  # @!attribute [rw] message
1976
2667
  # @return [String]
@@ -1983,7 +2674,7 @@ module Aws::RAM
1983
2674
  include Aws::Structure
1984
2675
  end
1985
2676
 
1986
- # The specified tag is a reserved word and cannot be used.
2677
+ # The specified tag key is a reserved word and can't be used.
1987
2678
  #
1988
2679
  # @!attribute [rw] message
1989
2680
  # @return [String]
@@ -2010,11 +2701,18 @@ module Aws::RAM
2010
2701
  # }
2011
2702
  #
2012
2703
  # @!attribute [rw] resource_share_arn
2013
- # The Amazon Resource Name (ARN) of the resource share.
2704
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2705
+ # that you want to add tags to.
2706
+ #
2707
+ #
2708
+ #
2709
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
2014
2710
  # @return [String]
2015
2711
  #
2016
2712
  # @!attribute [rw] tags
2017
- # One or more tags.
2713
+ # A list of one or more tag key and value pairs. The tag key must be
2714
+ # present and not be an empty string. The tag value must be present
2715
+ # but can be an empty string.
2018
2716
  # @return [Array<Types::Tag>]
2019
2717
  #
2020
2718
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/TagResourceRequest AWS API Documentation
@@ -2030,6 +2728,20 @@ module Aws::RAM
2030
2728
  #
2031
2729
  class TagResourceResponse < Aws::EmptyStructure; end
2032
2730
 
2731
+ # You exceeded the rate at which you are allowed to perform this
2732
+ # operation. Please try again later.
2733
+ #
2734
+ # @!attribute [rw] message
2735
+ # @return [String]
2736
+ #
2737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ThrottlingException AWS API Documentation
2738
+ #
2739
+ class ThrottlingException < Struct.new(
2740
+ :message)
2741
+ SENSITIVE = []
2742
+ include Aws::Structure
2743
+ end
2744
+
2033
2745
  # A specified resource was not found.
2034
2746
  #
2035
2747
  # @!attribute [rw] message
@@ -2052,11 +2764,17 @@ module Aws::RAM
2052
2764
  # }
2053
2765
  #
2054
2766
  # @!attribute [rw] resource_share_arn
2055
- # The Amazon Resource Name (ARN) of the resource share.
2767
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2768
+ # that you want to remove tags from. The tags are removed from the
2769
+ # resource share, not the resources in the resource share.
2770
+ #
2771
+ #
2772
+ #
2773
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
2056
2774
  # @return [String]
2057
2775
  #
2058
2776
  # @!attribute [rw] tag_keys
2059
- # The tag keys of the tags to remove.
2777
+ # Specifies a list of one or more tag keys that you want to remove.
2060
2778
  # @return [Array<String>]
2061
2779
  #
2062
2780
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UntagResourceRequest AWS API Documentation
@@ -2083,21 +2801,38 @@ module Aws::RAM
2083
2801
  # }
2084
2802
  #
2085
2803
  # @!attribute [rw] resource_share_arn
2086
- # The Amazon Resource Name (ARN) of the resource share.
2804
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2805
+ # that you want to modify.
2806
+ #
2807
+ #
2808
+ #
2809
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
2087
2810
  # @return [String]
2088
2811
  #
2089
2812
  # @!attribute [rw] name
2090
- # The name of the resource share.
2813
+ # If specified, the new name that you want to attach to the resource
2814
+ # share.
2091
2815
  # @return [String]
2092
2816
  #
2093
2817
  # @!attribute [rw] allow_external_principals
2094
- # Indicates whether principals outside your organization in
2818
+ # Specifies whether principals outside your organization in
2095
2819
  # Organizations can be associated with a resource share.
2096
2820
  # @return [Boolean]
2097
2821
  #
2098
2822
  # @!attribute [rw] client_token
2099
- # A unique, case-sensitive identifier that you provide to ensure the
2100
- # idempotency of the request.
2823
+ # Specifies a unique, case-sensitive identifier that you provide to
2824
+ # ensure the idempotency of the request. This lets you safely retry
2825
+ # the request without accidentally performing the same operation a
2826
+ # second time. Passing the same value to a later call to an operation
2827
+ # requires that you also pass the same value for all other parameters.
2828
+ # We recommend that you use a [UUID type of value.][1].
2829
+ #
2830
+ # If you don't provide this value, then Amazon Web Services generates
2831
+ # a random one for you.
2832
+ #
2833
+ #
2834
+ #
2835
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
2101
2836
  # @return [String]
2102
2837
  #
2103
2838
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UpdateResourceShareRequest AWS API Documentation
@@ -2116,8 +2851,11 @@ module Aws::RAM
2116
2851
  # @return [Types::ResourceShare]
2117
2852
  #
2118
2853
  # @!attribute [rw] client_token
2119
- # A unique, case-sensitive identifier that you provide to ensure the
2120
- # idempotency of the request.
2854
+ # The idempotency identifier associated with this request. If you want
2855
+ # to repeat the same operation in an idempotent manner then you must
2856
+ # include this value in the `clientToken` request parameter of that
2857
+ # later call. All other parameters must also have the same values that
2858
+ # you used in the first call.
2121
2859
  # @return [String]
2122
2860
  #
2123
2861
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UpdateResourceShareResponse AWS API Documentation