aws-sdk-ram 1.33.0 → 1.37.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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,64 @@ 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. You can use the
144
+ # ListPermissionVersions operation to discover the available versions
145
+ # of a permission.
92
146
  # @return [Integer]
93
147
  #
94
148
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceSharePermissionRequest AWS API Documentation
@@ -104,12 +158,16 @@ module Aws::RAM
104
158
  end
105
159
 
106
160
  # @!attribute [rw] return_value
107
- # Indicates whether the request succeeded.
161
+ # A return value of `true` indicates that the request succeeded. A
162
+ # value of `false` indicates that the request failed.
108
163
  # @return [Boolean]
109
164
  #
110
165
  # @!attribute [rw] client_token
111
- # A unique, case-sensitive identifier that you provide to ensure the
112
- # idempotency of the request.
166
+ # The idempotency identifier associated with this request. If you want
167
+ # to repeat the same operation in an idempotent manner then you must
168
+ # include this value in the `clientToken` request parameter of that
169
+ # later call. All other parameters must also have the same values that
170
+ # you used in the first call.
113
171
  # @return [String]
114
172
  #
115
173
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceSharePermissionResponse AWS API Documentation
@@ -132,41 +190,76 @@ module Aws::RAM
132
190
  # }
133
191
  #
134
192
  # @!attribute [rw] resource_share_arn
135
- # The Amazon Resource Name (ARN) of the resource share.
193
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
194
+ # that you want to add principals or resources to.
195
+ #
196
+ #
197
+ #
198
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
136
199
  # @return [String]
137
200
  #
138
201
  # @!attribute [rw] resource_arns
139
- # The Amazon Resource Names (ARNs) of the resources.
202
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] of the
203
+ # resources that you want to share. This can be `null` if you want to
204
+ # add only principals.
205
+ #
206
+ #
207
+ #
208
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
140
209
  # @return [Array<String>]
141
210
  #
142
211
  # @!attribute [rw] principals
143
- # The principals to associate with the resource share. The possible
144
- # values are:
212
+ # Specifies a list of principals to whom you want to the resource
213
+ # share. This can be `null` if you want to add only resources.
214
+ #
215
+ # What the principals can do with the resources in the share is
216
+ # determined by the RAM permissions that you associate with the
217
+ # resource share. See AssociateResourceSharePermission.
218
+ #
219
+ # You can include the following values:
145
220
  #
146
- # * An Amazon Web Services account ID
221
+ # * An Amazon Web Services account ID, for example: `123456789012`
147
222
  #
148
- # * An Amazon Resource Name (ARN) of an organization in Organizations
223
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
224
+ # Organizations, for example:
225
+ # `organizations::123456789012:organization/o-exampleorgid`
149
226
  #
150
- # * An ARN of an organizational unit (OU) in Organizations
227
+ # * An ARN of an organizational unit (OU) in Organizations, for
228
+ # example:
229
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
151
230
  #
152
- # * An ARN of an IAM role
231
+ # * An ARN of an IAM role, for example:
232
+ # `iam::123456789012:role/rolename`
153
233
  #
154
- # * An ARN of an IAM user
234
+ # * An ARN of an IAM user, for example:
235
+ # `iam::123456789012user/username`
155
236
  #
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*.
237
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
238
+ # more information, see [Sharing with IAM roles and users][2] in the
239
+ # *Resource Access Manager User Guide*.
159
240
  #
160
241
  # </note>
161
242
  #
162
243
  #
163
244
  #
164
- # [1]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
245
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
246
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
165
247
  # @return [Array<String>]
166
248
  #
167
249
  # @!attribute [rw] client_token
168
- # A unique, case-sensitive identifier that you provide to ensure the
169
- # idempotency of the request.
250
+ # Specifies a unique, case-sensitive identifier that you provide to
251
+ # ensure the idempotency of the request. This lets you safely retry
252
+ # the request without accidentally performing the same operation a
253
+ # second time. Passing the same value to a later call to an operation
254
+ # requires that you also pass the same value for all other parameters.
255
+ # We recommend that you use a [UUID type of value.][1].
256
+ #
257
+ # If you don't provide this value, then Amazon Web Services generates
258
+ # a random one for you.
259
+ #
260
+ #
261
+ #
262
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
170
263
  # @return [String]
171
264
  #
172
265
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceShareRequest AWS API Documentation
@@ -181,12 +274,15 @@ module Aws::RAM
181
274
  end
182
275
 
183
276
  # @!attribute [rw] resource_share_associations
184
- # Information about the associations.
277
+ # An array of objects that contain information about the associations.
185
278
  # @return [Array<Types::ResourceShareAssociation>]
186
279
  #
187
280
  # @!attribute [rw] client_token
188
- # A unique, case-sensitive identifier that you provide to ensure the
189
- # idempotency of the request.
281
+ # The idempotency identifier associated with this request. If you want
282
+ # to repeat the same operation in an idempotent manner then you must
283
+ # include this value in the `clientToken` request parameter of that
284
+ # later call. All other parameters must also have the same values that
285
+ # you used in the first call.
190
286
  # @return [String]
191
287
  #
192
288
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceShareResponse AWS API Documentation
@@ -217,58 +313,90 @@ module Aws::RAM
217
313
  # }
218
314
  #
219
315
  # @!attribute [rw] name
220
- # The name of the resource share.
316
+ # Specifies the name of the resource share.
221
317
  # @return [String]
222
318
  #
223
319
  # @!attribute [rw] resource_arns
224
- # The ARNs of the resources to associate with the resource share.
320
+ # Specifies a list of one or more ARNs of the resources to associate
321
+ # with the resource share.
225
322
  # @return [Array<String>]
226
323
  #
227
324
  # @!attribute [rw] principals
228
- # The principals to associate with the resource share. The possible
229
- # values are:
325
+ # Specifies a list of one or more principals to associate with the
326
+ # resource share.
327
+ #
328
+ # You can include the following values:
230
329
  #
231
- # * An Amazon Web Services account ID
330
+ # * An Amazon Web Services account ID, for example: `123456789012`
232
331
  #
233
- # * An Amazon Resource Name (ARN) of an organization in Organizations
332
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
333
+ # Organizations, for example:
334
+ # `organizations::123456789012:organization/o-exampleorgid`
234
335
  #
235
- # * An ARN of an organizational unit (OU) in Organizations
336
+ # * An ARN of an organizational unit (OU) in Organizations, for
337
+ # example:
338
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
236
339
  #
237
- # * An ARN of an IAM role
340
+ # * An ARN of an IAM role, for example:
341
+ # `iam::123456789012:role/rolename`
238
342
  #
239
- # * An ARN of an IAM user
343
+ # * An ARN of an IAM user, for example:
344
+ # `iam::123456789012user/username`
240
345
  #
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*.
346
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
347
+ # more information, see [Sharing with IAM roles and users][2] in the
348
+ # *Resource Access Manager User Guide*.
244
349
  #
245
350
  # </note>
246
351
  #
247
352
  #
248
353
  #
249
- # [1]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
354
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
355
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
250
356
  # @return [Array<String>]
251
357
  #
252
358
  # @!attribute [rw] tags
253
- # One or more tags.
359
+ # Specifies one or more tags to attach to the resource share itself.
360
+ # It doesn't attach the tags to the resources associated with the
361
+ # resource share.
254
362
  # @return [Array<Types::Tag>]
255
363
  #
256
364
  # @!attribute [rw] allow_external_principals
257
- # Indicates whether principals outside your organization in
258
- # Organizations can be associated with a resource share.
365
+ # Specifies whether principals outside your organization in
366
+ # Organizations can be associated with a resource share. A value of
367
+ # `true` lets you share with individual Amazon Web Services accounts
368
+ # that are *not* in your organization. A value of `false` only has
369
+ # meaning if your account is a member of an Amazon Web Services
370
+ # Organization. The default value is `true`.
259
371
  # @return [Boolean]
260
372
  #
261
373
  # @!attribute [rw] client_token
262
- # A unique, case-sensitive identifier that you provide to ensure the
263
- # idempotency of the request.
374
+ # Specifies a unique, case-sensitive identifier that you provide to
375
+ # ensure the idempotency of the request. This lets you safely retry
376
+ # the request without accidentally performing the same operation a
377
+ # second time. Passing the same value to a later call to an operation
378
+ # requires that you also pass the same value for all other parameters.
379
+ # We recommend that you use a [UUID type of value.][1].
380
+ #
381
+ # If you don't provide this value, then Amazon Web Services generates
382
+ # a random one for you.
383
+ #
384
+ #
385
+ #
386
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
264
387
  # @return [String]
265
388
  #
266
389
  # @!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.
390
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the RAM
391
+ # permission to associate with the resource share. If you do not
392
+ # specify an ARN for the permission, RAM automatically attaches the
393
+ # default version of the permission for each resource type. You can
394
+ # associate only one permission with each resource type included in
395
+ # the resource share.
396
+ #
397
+ #
398
+ #
399
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
272
400
  # @return [Array<String>]
273
401
  #
274
402
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShareRequest AWS API Documentation
@@ -286,12 +414,15 @@ module Aws::RAM
286
414
  end
287
415
 
288
416
  # @!attribute [rw] resource_share
289
- # Information about the resource share.
417
+ # An object with information about the new resource share.
290
418
  # @return [Types::ResourceShare]
291
419
  #
292
420
  # @!attribute [rw] client_token
293
- # A unique, case-sensitive identifier that you provide to ensure the
294
- # idempotency of the request.
421
+ # The idempotency identifier associated with this request. If you want
422
+ # to repeat the same operation in an idempotent manner then you must
423
+ # include this value in the `clientToken` request parameter of that
424
+ # later call. All other parameters must also have the same values that
425
+ # you used in the first call.
295
426
  # @return [String]
296
427
  #
297
428
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShareResponse AWS API Documentation
@@ -312,12 +443,28 @@ module Aws::RAM
312
443
  # }
313
444
  #
314
445
  # @!attribute [rw] resource_share_arn
315
- # The Amazon Resource Name (ARN) of the resource share.
446
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
447
+ # to delete.
448
+ #
449
+ #
450
+ #
451
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
316
452
  # @return [String]
317
453
  #
318
454
  # @!attribute [rw] client_token
319
- # A unique, case-sensitive identifier that you provide to ensure the
320
- # idempotency of the request.
455
+ # Specifies a unique, case-sensitive identifier that you provide to
456
+ # ensure the idempotency of the request. This lets you safely retry
457
+ # the request without accidentally performing the same operation a
458
+ # second time. Passing the same value to a later call to an operation
459
+ # requires that you also pass the same value for all other parameters.
460
+ # We recommend that you use a [UUID type of value.][1].
461
+ #
462
+ # If you don't provide this value, then Amazon Web Services generates
463
+ # a random one for you.
464
+ #
465
+ #
466
+ #
467
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
321
468
  # @return [String]
322
469
  #
323
470
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DeleteResourceShareRequest AWS API Documentation
@@ -330,12 +477,16 @@ module Aws::RAM
330
477
  end
331
478
 
332
479
  # @!attribute [rw] return_value
333
- # Indicates whether the request succeeded.
480
+ # A return value of `true` indicates that the request succeeded. A
481
+ # value of `false` indicates that the request failed.
334
482
  # @return [Boolean]
335
483
  #
336
484
  # @!attribute [rw] client_token
337
- # A unique, case-sensitive identifier that you provide to ensure the
338
- # idempotency of the request.
485
+ # The idempotency identifier associated with this request. If you want
486
+ # to repeat the same operation in an idempotent manner then you must
487
+ # include this value in the `clientToken` request parameter of that
488
+ # later call. All other parameters must also have the same values that
489
+ # you used in the first call.
339
490
  # @return [String]
340
491
  #
341
492
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DeleteResourceShareResponse AWS API Documentation
@@ -357,17 +508,38 @@ module Aws::RAM
357
508
  # }
358
509
  #
359
510
  # @!attribute [rw] resource_share_arn
360
- # The Amazon Resource Name (ARN) of the resource share.
511
+ # The [Amazon Resoure Name (ARN)][1] of the resource share from which
512
+ # you want to disassociate a permission.
513
+ #
514
+ #
515
+ #
516
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
361
517
  # @return [String]
362
518
  #
363
519
  # @!attribute [rw] permission_arn
364
- # The Amazon Resource Name (ARN) of the permission to disassociate
365
- # from the resource share.
520
+ # The [Amazon Resoure Name (ARN)][1] of the permission to disassociate
521
+ # from the resource share. Changes to permissions take effect
522
+ # immediately.
523
+ #
524
+ #
525
+ #
526
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
366
527
  # @return [String]
367
528
  #
368
529
  # @!attribute [rw] client_token
369
- # A unique, case-sensitive identifier that you provide to ensure the
370
- # idempotency of the request.
530
+ # Specifies a unique, case-sensitive identifier that you provide to
531
+ # ensure the idempotency of the request. This lets you safely retry
532
+ # the request without accidentally performing the same operation a
533
+ # second time. Passing the same value to a later call to an operation
534
+ # requires that you also pass the same value for all other parameters.
535
+ # We recommend that you use a [UUID type of value.][1].
536
+ #
537
+ # If you don't provide this value, then Amazon Web Services generates
538
+ # a random one for you.
539
+ #
540
+ #
541
+ #
542
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
371
543
  # @return [String]
372
544
  #
373
545
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceSharePermissionRequest AWS API Documentation
@@ -381,12 +553,16 @@ module Aws::RAM
381
553
  end
382
554
 
383
555
  # @!attribute [rw] return_value
384
- # Indicates whether the request succeeded.
556
+ # A return value of `true` indicates that the request succeeded. A
557
+ # value of `false` indicates that the request failed.
385
558
  # @return [Boolean]
386
559
  #
387
560
  # @!attribute [rw] client_token
388
- # A unique, case-sensitive identifier that you provide to ensure the
389
- # idempotency of the request.
561
+ # The idempotency identifier associated with this request. If you want
562
+ # to repeat the same operation in an idempotent manner then you must
563
+ # include this value in the `clientToken` request parameter of that
564
+ # later call. All other parameters must also have the same values that
565
+ # you used in the first call.
390
566
  # @return [String]
391
567
  #
392
568
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceSharePermissionResponse AWS API Documentation
@@ -409,20 +585,74 @@ module Aws::RAM
409
585
  # }
410
586
  #
411
587
  # @!attribute [rw] resource_share_arn
412
- # The Amazon Resource Name (ARN) of the resource share.
588
+ # Specifies [Amazon Resoure Name (ARN)][1] of the resource share that
589
+ # you want to remove resources from.
590
+ #
591
+ #
592
+ #
593
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
413
594
  # @return [String]
414
595
  #
415
596
  # @!attribute [rw] resource_arns
416
- # The Amazon Resource Names (ARNs) of the resources.
597
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] for one or
598
+ # more resources that you want to remove from the resource share.
599
+ # After the operation runs, these resources are no longer shared with
600
+ # principals outside of the Amazon Web Services account that created
601
+ # the resources.
602
+ #
603
+ #
604
+ #
605
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
417
606
  # @return [Array<String>]
418
607
  #
419
608
  # @!attribute [rw] principals
420
- # The principals.
609
+ # Specifies a list of one or more principals that no longer are to
610
+ # have access to the resources in this resource share.
611
+ #
612
+ # You can include the following values:
613
+ #
614
+ # * An Amazon Web Services account ID, for example: `123456789012`
615
+ #
616
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
617
+ # Organizations, for example:
618
+ # `organizations::123456789012:organization/o-exampleorgid`
619
+ #
620
+ # * An ARN of an organizational unit (OU) in Organizations, for
621
+ # example:
622
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
623
+ #
624
+ # * An ARN of an IAM role, for example:
625
+ # `iam::123456789012:role/rolename`
626
+ #
627
+ # * An ARN of an IAM user, for example:
628
+ # `iam::123456789012user/username`
629
+ #
630
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
631
+ # more information, see [Sharing with IAM roles and users][2] in the
632
+ # *Resource Access Manager User Guide*.
633
+ #
634
+ # </note>
635
+ #
636
+ #
637
+ #
638
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
639
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
421
640
  # @return [Array<String>]
422
641
  #
423
642
  # @!attribute [rw] client_token
424
- # A unique, case-sensitive identifier that you provide to ensure the
425
- # idempotency of the request.
643
+ # Specifies a unique, case-sensitive identifier that you provide to
644
+ # ensure the idempotency of the request. This lets you safely retry
645
+ # the request without accidentally performing the same operation a
646
+ # second time. Passing the same value to a later call to an operation
647
+ # requires that you also pass the same value for all other parameters.
648
+ # We recommend that you use a [UUID type of value.][1].
649
+ #
650
+ # If you don't provide this value, then Amazon Web Services generates
651
+ # a random one for you.
652
+ #
653
+ #
654
+ #
655
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
426
656
  # @return [String]
427
657
  #
428
658
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceShareRequest AWS API Documentation
@@ -437,12 +667,16 @@ module Aws::RAM
437
667
  end
438
668
 
439
669
  # @!attribute [rw] resource_share_associations
440
- # Information about the associations.
670
+ # An array of objects that contain information about the updated
671
+ # associations for this resource share.
441
672
  # @return [Array<Types::ResourceShareAssociation>]
442
673
  #
443
674
  # @!attribute [rw] client_token
444
- # A unique, case-sensitive identifier that you provide to ensure the
445
- # idempotency of the request.
675
+ # The idempotency identifier associated with this request. If you want
676
+ # to repeat the same operation in an idempotent manner then you must
677
+ # include this value in the `clientToken` request parameter of that
678
+ # later call. All other parameters must also have the same values that
679
+ # you used in the first call.
446
680
  # @return [String]
447
681
  #
448
682
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceShareResponse AWS API Documentation
@@ -461,7 +695,8 @@ module Aws::RAM
461
695
  class EnableSharingWithAwsOrganizationRequest < Aws::EmptyStructure; end
462
696
 
463
697
  # @!attribute [rw] return_value
464
- # Indicates whether the request succeeded.
698
+ # A return value of `true` indicates that the request succeeded. A
699
+ # value of `false` indicates that the request failed.
465
700
  # @return [Boolean]
466
701
  #
467
702
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/EnableSharingWithAwsOrganizationResponse AWS API Documentation
@@ -481,11 +716,22 @@ module Aws::RAM
481
716
  # }
482
717
  #
483
718
  # @!attribute [rw] permission_arn
484
- # The Amazon Resource Name (ARN) of the permission.
719
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the permission whose
720
+ # contents you want to retrieve. To find the ARN for a permission, use
721
+ # either the ListPermissions operation or go to the [Permissions
722
+ # library][2] page in the RAM console and then choose the name of the
723
+ # permission. The ARN is displayed on the detail page.
724
+ #
725
+ #
726
+ #
727
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
728
+ # [2]: https://console.aws.amazon.com/ram/home#Permissions:
485
729
  # @return [String]
486
730
  #
487
731
  # @!attribute [rw] permission_version
488
- # The identifier for the version of the permission.
732
+ # Specifies identifier for the version of the RAM permission to
733
+ # retrieve. If you don't specify this parameter, the operation
734
+ # retrieves the default version.
489
735
  # @return [Integer]
490
736
  #
491
737
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetPermissionRequest AWS API Documentation
@@ -498,7 +744,7 @@ module Aws::RAM
498
744
  end
499
745
 
500
746
  # @!attribute [rw] permission
501
- # Information about the permission.
747
+ # An object that contains information about the permission.
502
748
  # @return [Types::ResourceSharePermissionDetail]
503
749
  #
504
750
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetPermissionResponse AWS API Documentation
@@ -520,21 +766,37 @@ module Aws::RAM
520
766
  # }
521
767
  #
522
768
  # @!attribute [rw] resource_arns
523
- # The Amazon Resource Names (ARNs) of the resources.
769
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the resources
770
+ # whose policies you want to retrieve.
771
+ #
772
+ #
773
+ #
774
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
524
775
  # @return [Array<String>]
525
776
  #
526
777
  # @!attribute [rw] principal
527
- # The principal.
778
+ # Specifies the principal.
528
779
  # @return [String]
529
780
  #
530
781
  # @!attribute [rw] next_token
531
- # The token for the next page of results.
782
+ # Specifies that you want to receive the next page of results. Valid
783
+ # only if you received a `NextToken` response in the previous request.
784
+ # If you did, it indicates that more output is available. Set this
785
+ # parameter to the value provided by the previous call's `NextToken`
786
+ # response to request the next page of results.
532
787
  # @return [String]
533
788
  #
534
789
  # @!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.
790
+ # Specifies the total number of results that you want included on each
791
+ # page of the response. If you do not include this parameter, it
792
+ # defaults to a value that is specific to the operation. If additional
793
+ # items exist beyond the number you specify, the `NextToken` response
794
+ # element is returned with a value (not null). Include the specified
795
+ # value as the `NextToken` request parameter in the next call to the
796
+ # operation to get the next part of the results. Note that the service
797
+ # might return fewer results than the maximum even when there are more
798
+ # results available. You should check `NextToken` after every
799
+ # operation to ensure that you receive all of the results.
538
800
  # @return [Integer]
539
801
  #
540
802
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourcePoliciesRequest AWS API Documentation
@@ -549,12 +811,16 @@ module Aws::RAM
549
811
  end
550
812
 
551
813
  # @!attribute [rw] policies
552
- # A key policy document, in JSON format.
814
+ # An array of resource policy documents in JSON format.
553
815
  # @return [Array<String>]
554
816
  #
555
817
  # @!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.
818
+ # If present, this value indicates that more output is available than
819
+ # is included in the current response. Use this value in the
820
+ # `NextToken` request parameter in a subsequent call to the operation
821
+ # to get the next part of the output. You should repeat this until the
822
+ # `NextToken` response element comes back as `null`. This indicates
823
+ # that this is the last page of results.
558
824
  # @return [String]
559
825
  #
560
826
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourcePoliciesResponse AWS API Documentation
@@ -580,38 +846,75 @@ module Aws::RAM
580
846
  # }
581
847
  #
582
848
  # @!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.
849
+ # Specifies whether you want to retrieve the associations that involve
850
+ # a specified resource or principal.
851
+ #
852
+ # * `PRINCIPAL` – list the principals that are associated with the
853
+ # specified resource share.
854
+ #
855
+ # * `RESOURCE` – list the resources that are associated with the
856
+ # specified resource share.
587
857
  # @return [String]
588
858
  #
589
859
  # @!attribute [rw] resource_share_arns
590
- # The Amazon Resource Names (ARN) of the resource shares.
860
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] of the
861
+ # resource share whose associations you want to retrieve.
862
+ #
863
+ #
864
+ #
865
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
591
866
  # @return [Array<String>]
592
867
  #
593
868
  # @!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`.
869
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource whose
870
+ # resource shares you want to retrieve.
871
+ #
872
+ # You cannot specify this parameter if the association type is
873
+ # `PRINCIPAL`.
874
+ #
875
+ #
876
+ #
877
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
596
878
  # @return [String]
597
879
  #
598
880
  # @!attribute [rw] principal
599
- # The principal. You cannot specify this parameter if the association
600
- # type is `RESOURCE`.
881
+ # Specifies the ID of the principal whose resource shares you want to
882
+ # retrieve. This can be an Amazon Web Services account ID, an
883
+ # organization ID, an organizational unit ID, or the [Amazon Resoure
884
+ # Name (ARN)][1] of an individual IAM user or role.
885
+ #
886
+ # You cannot specify this parameter if the association type is
887
+ # `RESOURCE`.
888
+ #
889
+ #
890
+ #
891
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
601
892
  # @return [String]
602
893
  #
603
894
  # @!attribute [rw] association_status
604
- # The association status.
895
+ # Specifies that you want to retrieve only associations with this
896
+ # status.
605
897
  # @return [String]
606
898
  #
607
899
  # @!attribute [rw] next_token
608
- # The token for the next page of results.
900
+ # Specifies that you want to receive the next page of results. Valid
901
+ # only if you received a `NextToken` response in the previous request.
902
+ # If you did, it indicates that more output is available. Set this
903
+ # parameter to the value provided by the previous call's `NextToken`
904
+ # response to request the next page of results.
609
905
  # @return [String]
610
906
  #
611
907
  # @!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.
908
+ # Specifies the total number of results that you want included on each
909
+ # page of the response. If you do not include this parameter, it
910
+ # defaults to a value that is specific to the operation. If additional
911
+ # items exist beyond the number you specify, the `NextToken` response
912
+ # element is returned with a value (not null). Include the specified
913
+ # value as the `NextToken` request parameter in the next call to the
914
+ # operation to get the next part of the results. Note that the service
915
+ # might return fewer results than the maximum even when there are more
916
+ # results available. You should check `NextToken` after every
917
+ # operation to ensure that you receive all of the results.
615
918
  # @return [Integer]
616
919
  #
617
920
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareAssociationsRequest AWS API Documentation
@@ -629,12 +932,16 @@ module Aws::RAM
629
932
  end
630
933
 
631
934
  # @!attribute [rw] resource_share_associations
632
- # Information about the associations.
935
+ # An array of objects that contain the details about the associations.
633
936
  # @return [Array<Types::ResourceShareAssociation>]
634
937
  #
635
938
  # @!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.
939
+ # If present, this value indicates that more output is available than
940
+ # is included in the current response. Use this value in the
941
+ # `NextToken` request parameter in a subsequent call to the operation
942
+ # to get the next part of the output. You should repeat this until the
943
+ # `NextToken` response element comes back as `null`. This indicates
944
+ # that this is the last page of results.
638
945
  # @return [String]
639
946
  #
640
947
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareAssociationsResponse AWS API Documentation
@@ -657,21 +964,43 @@ module Aws::RAM
657
964
  # }
658
965
  #
659
966
  # @!attribute [rw] resource_share_invitation_arns
660
- # The Amazon Resource Names (ARN) of the invitations.
967
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the resource
968
+ # share invitations you want information about.
969
+ #
970
+ #
971
+ #
972
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
661
973
  # @return [Array<String>]
662
974
  #
663
975
  # @!attribute [rw] resource_share_arns
664
- # The Amazon Resource Names (ARN) of the resource shares.
976
+ # Specifies that you want details about invitations only for the
977
+ # resource shares described by this list of [Amazon Resource Names
978
+ # (ARNs)][1]
979
+ #
980
+ #
981
+ #
982
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
665
983
  # @return [Array<String>]
666
984
  #
667
985
  # @!attribute [rw] next_token
668
- # The token for the next page of results.
986
+ # Specifies that you want to receive the next page of results. Valid
987
+ # only if you received a `NextToken` response in the previous request.
988
+ # If you did, it indicates that more output is available. Set this
989
+ # parameter to the value provided by the previous call's `NextToken`
990
+ # response to request the next page of results.
669
991
  # @return [String]
670
992
  #
671
993
  # @!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.
994
+ # Specifies the total number of results that you want included on each
995
+ # page of the response. If you do not include this parameter, it
996
+ # defaults to a value that is specific to the operation. If additional
997
+ # items exist beyond the number you specify, the `NextToken` response
998
+ # element is returned with a value (not null). Include the specified
999
+ # value as the `NextToken` request parameter in the next call to the
1000
+ # operation to get the next part of the results. Note that the service
1001
+ # might return fewer results than the maximum even when there are more
1002
+ # results available. You should check `NextToken` after every
1003
+ # operation to ensure that you receive all of the results.
675
1004
  # @return [Integer]
676
1005
  #
677
1006
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareInvitationsRequest AWS API Documentation
@@ -686,12 +1015,16 @@ module Aws::RAM
686
1015
  end
687
1016
 
688
1017
  # @!attribute [rw] resource_share_invitations
689
- # Information about the invitations.
1018
+ # An array of objects that contain the details about the invitations.
690
1019
  # @return [Array<Types::ResourceShareInvitation>]
691
1020
  #
692
1021
  # @!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.
1022
+ # If present, this value indicates that more output is available than
1023
+ # is included in the current response. Use this value in the
1024
+ # `NextToken` request parameter in a subsequent call to the operation
1025
+ # to get the next part of the output. You should repeat this until the
1026
+ # `NextToken` response element comes back as `null`. This indicates
1027
+ # that this is the last page of results.
695
1028
  # @return [String]
696
1029
  #
697
1030
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareInvitationsResponse AWS API Documentation
@@ -723,38 +1056,68 @@ module Aws::RAM
723
1056
  # }
724
1057
  #
725
1058
  # @!attribute [rw] resource_share_arns
726
- # The Amazon Resource Names (ARNs) of the resource shares.
1059
+ # Specifies the [Amazon Resource Names (ARNs)][1] of individual
1060
+ # resource shares that you want information about.
1061
+ #
1062
+ #
1063
+ #
1064
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
727
1065
  # @return [Array<String>]
728
1066
  #
729
1067
  # @!attribute [rw] resource_share_status
730
- # The status of the resource share.
1068
+ # Specifies that you want to retrieve details of only those resource
1069
+ # shares that have this status.
731
1070
  # @return [String]
732
1071
  #
733
1072
  # @!attribute [rw] resource_owner
734
- # The type of owner.
1073
+ # Specifies that you want to retrieve details of only those resource
1074
+ # shares that match the following:
1075
+ #
1076
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1077
+ #
1078
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other
1079
+ # accounts share with you
735
1080
  # @return [String]
736
1081
  #
737
1082
  # @!attribute [rw] name
738
- # The name of the resource share.
1083
+ # Specifies the name of an individual resource share that you want to
1084
+ # retrieve details about.
739
1085
  # @return [String]
740
1086
  #
741
1087
  # @!attribute [rw] tag_filters
742
- # One or more tag filters.
1088
+ # Specifies that you want to retrieve details of only those resource
1089
+ # shares that match the specified tag keys and values.
743
1090
  # @return [Array<Types::TagFilter>]
744
1091
  #
745
1092
  # @!attribute [rw] next_token
746
- # The token for the next page of results.
1093
+ # Specifies that you want to receive the next page of results. Valid
1094
+ # only if you received a `NextToken` response in the previous request.
1095
+ # If you did, it indicates that more output is available. Set this
1096
+ # parameter to the value provided by the previous call's `NextToken`
1097
+ # response to request the next page of results.
747
1098
  # @return [String]
748
1099
  #
749
1100
  # @!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.
1101
+ # Specifies the total number of results that you want included on each
1102
+ # page of the response. If you do not include this parameter, it
1103
+ # defaults to a value that is specific to the operation. If additional
1104
+ # items exist beyond the number you specify, the `NextToken` response
1105
+ # element is returned with a value (not null). Include the specified
1106
+ # value as the `NextToken` request parameter in the next call to the
1107
+ # operation to get the next part of the results. Note that the service
1108
+ # might return fewer results than the maximum even when there are more
1109
+ # results available. You should check `NextToken` after every
1110
+ # operation to ensure that you receive all of the results.
753
1111
  # @return [Integer]
754
1112
  #
755
1113
  # @!attribute [rw] permission_arn
756
- # The Amazon Resource Name (ARN) of the RAM permission that is
757
- # associated with the resource share.
1114
+ # Specifies that you want to retrieve details of only those resource
1115
+ # shares that use the RAM permission with this [Amazon Resoure Name
1116
+ # (ARN)][1].
1117
+ #
1118
+ #
1119
+ #
1120
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
758
1121
  # @return [String]
759
1122
  #
760
1123
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceSharesRequest AWS API Documentation
@@ -773,12 +1136,17 @@ module Aws::RAM
773
1136
  end
774
1137
 
775
1138
  # @!attribute [rw] resource_shares
776
- # Information about the resource shares.
1139
+ # An array of objects that contain the information about the resource
1140
+ # shares.
777
1141
  # @return [Array<Types::ResourceShare>]
778
1142
  #
779
1143
  # @!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.
1144
+ # If present, this value indicates that more output is available than
1145
+ # is included in the current response. Use this value in the
1146
+ # `NextToken` request parameter in a subsequent call to the operation
1147
+ # to get the next part of the output. You should repeat this until the
1148
+ # `NextToken` response element comes back as `null`. This indicates
1149
+ # that this is the last page of results.
782
1150
  # @return [String]
783
1151
  #
784
1152
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceSharesResponse AWS API Documentation
@@ -790,9 +1158,9 @@ module Aws::RAM
790
1158
  include Aws::Structure
791
1159
  end
792
1160
 
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.
1161
+ # The client token input parameter was matched one used with a previous
1162
+ # call to the operation, but at least one of the other input parameters
1163
+ # is different from the previous call.
796
1164
  #
797
1165
  # @!attribute [rw] message
798
1166
  # @return [String]
@@ -805,7 +1173,7 @@ module Aws::RAM
805
1173
  include Aws::Structure
806
1174
  end
807
1175
 
808
- # A client token is not valid.
1176
+ # The client token is not valid.
809
1177
  #
810
1178
  # @!attribute [rw] message
811
1179
  # @return [String]
@@ -818,7 +1186,7 @@ module Aws::RAM
818
1186
  include Aws::Structure
819
1187
  end
820
1188
 
821
- # The specified value for MaxResults is not valid.
1189
+ # The specified value for `MaxResults` is not valid.
822
1190
  #
823
1191
  # @!attribute [rw] message
824
1192
  # @return [String]
@@ -831,7 +1199,7 @@ module Aws::RAM
831
1199
  include Aws::Structure
832
1200
  end
833
1201
 
834
- # The specified value for NextToken is not valid.
1202
+ # The specified value for `NextToken` is not valid.
835
1203
  #
836
1204
  # @!attribute [rw] message
837
1205
  # @return [String]
@@ -890,39 +1258,79 @@ module Aws::RAM
890
1258
  # resource_share_invitation_arn: "String", # required
891
1259
  # next_token: "String",
892
1260
  # max_results: 1,
1261
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
893
1262
  # }
894
1263
  #
895
1264
  # @!attribute [rw] resource_share_invitation_arn
896
- # The Amazon Resource Name (ARN) of the invitation.
1265
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the invitation. You
1266
+ # can use GetResourceShareInvitations to find the ARN of the
1267
+ # invitation.
1268
+ #
1269
+ #
1270
+ #
1271
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
897
1272
  # @return [String]
898
1273
  #
899
1274
  # @!attribute [rw] next_token
900
- # The token for the next page of results.
1275
+ # Specifies that you want to receive the next page of results. Valid
1276
+ # only if you received a `NextToken` response in the previous request.
1277
+ # If you did, it indicates that more output is available. Set this
1278
+ # parameter to the value provided by the previous call's `NextToken`
1279
+ # response to request the next page of results.
901
1280
  # @return [String]
902
1281
  #
903
1282
  # @!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.
1283
+ # Specifies the total number of results that you want included on each
1284
+ # page of the response. If you do not include this parameter, it
1285
+ # defaults to a value that is specific to the operation. If additional
1286
+ # items exist beyond the number you specify, the `NextToken` response
1287
+ # element is returned with a value (not null). Include the specified
1288
+ # value as the `NextToken` request parameter in the next call to the
1289
+ # operation to get the next part of the results. Note that the service
1290
+ # might return fewer results than the maximum even when there are more
1291
+ # results available. You should check `NextToken` after every
1292
+ # operation to ensure that you receive all of the results.
907
1293
  # @return [Integer]
908
1294
  #
1295
+ # @!attribute [rw] resource_region_scope
1296
+ # Specifies that you want the results to include only resources that
1297
+ # have the specified scope.
1298
+ #
1299
+ # * `ALL` – the results include both global and regional resources or
1300
+ # resource types.
1301
+ #
1302
+ # * `GLOBAL` – the results include only global resources or resource
1303
+ # types.
1304
+ #
1305
+ # * `REGIONAL` – the results include only regional resources or
1306
+ # resource types.
1307
+ #
1308
+ # The default value is `ALL`.
1309
+ # @return [String]
1310
+ #
909
1311
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPendingInvitationResourcesRequest AWS API Documentation
910
1312
  #
911
1313
  class ListPendingInvitationResourcesRequest < Struct.new(
912
1314
  :resource_share_invitation_arn,
913
1315
  :next_token,
914
- :max_results)
1316
+ :max_results,
1317
+ :resource_region_scope)
915
1318
  SENSITIVE = []
916
1319
  include Aws::Structure
917
1320
  end
918
1321
 
919
1322
  # @!attribute [rw] resources
920
- # Information about the resources included the resource share.
1323
+ # An array of objects that contain the information about the resources
1324
+ # included the specified resource share.
921
1325
  # @return [Array<Types::Resource>]
922
1326
  #
923
1327
  # @!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.
1328
+ # If present, this value indicates that more output is available than
1329
+ # is included in the current response. Use this value in the
1330
+ # `NextToken` request parameter in a subsequent call to the operation
1331
+ # to get the next part of the output. You should repeat this until the
1332
+ # `NextToken` response element comes back as `null`. This indicates
1333
+ # that this is the last page of results.
926
1334
  # @return [String]
927
1335
  #
928
1336
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPendingInvitationResourcesResponse AWS API Documentation
@@ -934,6 +1342,80 @@ module Aws::RAM
934
1342
  include Aws::Structure
935
1343
  end
936
1344
 
1345
+ # @note When making an API call, you may pass ListPermissionVersionsRequest
1346
+ # data as a hash:
1347
+ #
1348
+ # {
1349
+ # permission_arn: "String", # required
1350
+ # next_token: "String",
1351
+ # max_results: 1,
1352
+ # }
1353
+ #
1354
+ # @!attribute [rw] permission_arn
1355
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the RAM permission
1356
+ # whose versions you want to list. You can use the `permissionVersion`
1357
+ # parameter on the AssociateResourceSharePermission operation to
1358
+ # specify a non-default version to attach.
1359
+ #
1360
+ #
1361
+ #
1362
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1363
+ # @return [String]
1364
+ #
1365
+ # @!attribute [rw] next_token
1366
+ # Specifies that you want to receive the next page of results. Valid
1367
+ # only if you received a `NextToken` response in the previous request.
1368
+ # If you did, it indicates that more output is available. Set this
1369
+ # parameter to the value provided by the previous call's `NextToken`
1370
+ # response to request the next page of results.
1371
+ # @return [String]
1372
+ #
1373
+ # @!attribute [rw] max_results
1374
+ # Specifies the total number of results that you want included on each
1375
+ # page of the response. If you do not include this parameter, it
1376
+ # defaults to a value that is specific to the operation. If additional
1377
+ # items exist beyond the number you specify, the `NextToken` response
1378
+ # element is returned with a value (not null). Include the specified
1379
+ # value as the `NextToken` request parameter in the next call to the
1380
+ # operation to get the next part of the results. Note that the service
1381
+ # might return fewer results than the maximum even when there are more
1382
+ # results available. You should check `NextToken` after every
1383
+ # operation to ensure that you receive all of the results.
1384
+ # @return [Integer]
1385
+ #
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionVersionsRequest AWS API Documentation
1387
+ #
1388
+ class ListPermissionVersionsRequest < Struct.new(
1389
+ :permission_arn,
1390
+ :next_token,
1391
+ :max_results)
1392
+ SENSITIVE = []
1393
+ include Aws::Structure
1394
+ end
1395
+
1396
+ # @!attribute [rw] permissions
1397
+ # An array of objects that contain details for each of the available
1398
+ # versions.
1399
+ # @return [Array<Types::ResourceSharePermissionSummary>]
1400
+ #
1401
+ # @!attribute [rw] next_token
1402
+ # If present, this value indicates that more output is available than
1403
+ # is included in the current response. Use this value in the
1404
+ # `NextToken` request parameter in a subsequent call to the operation
1405
+ # to get the next part of the output. You should repeat this until the
1406
+ # `NextToken` response element comes back as `null`. This indicates
1407
+ # that this is the last page of results.
1408
+ # @return [String]
1409
+ #
1410
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionVersionsResponse AWS API Documentation
1411
+ #
1412
+ class ListPermissionVersionsResponse < Struct.new(
1413
+ :permissions,
1414
+ :next_token)
1415
+ SENSITIVE = []
1416
+ include Aws::Structure
1417
+ end
1418
+
937
1419
  # @note When making an API call, you may pass ListPermissionsRequest
938
1420
  # data as a hash:
939
1421
  #
@@ -944,19 +1426,31 @@ module Aws::RAM
944
1426
  # }
945
1427
  #
946
1428
  # @!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`.
1429
+ # Specifies that you want to list permissions for only the specified
1430
+ # resource type. For example, to list only permissions that apply to
1431
+ # EC2 subnets, specify `ec2:Subnet`. You can use the ListResourceTypes
1432
+ # operation to get the specific string required.
950
1433
  # @return [String]
951
1434
  #
952
1435
  # @!attribute [rw] next_token
953
- # The token for the next page of results.
1436
+ # Specifies that you want to receive the next page of results. Valid
1437
+ # only if you received a `NextToken` response in the previous request.
1438
+ # If you did, it indicates that more output is available. Set this
1439
+ # parameter to the value provided by the previous call's `NextToken`
1440
+ # response to request the next page of results.
954
1441
  # @return [String]
955
1442
  #
956
1443
  # @!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.
1444
+ # Specifies the total number of results that you want included on each
1445
+ # page of the response. If you do not include this parameter, it
1446
+ # defaults to a value that is specific to the operation. If additional
1447
+ # items exist beyond the number you specify, the `NextToken` response
1448
+ # element is returned with a value (not null). Include the specified
1449
+ # value as the `NextToken` request parameter in the next call to the
1450
+ # operation to get the next part of the results. Note that the service
1451
+ # might return fewer results than the maximum even when there are more
1452
+ # results available. You should check `NextToken` after every
1453
+ # operation to ensure that you receive all of the results.
960
1454
  # @return [Integer]
961
1455
  #
962
1456
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionsRequest AWS API Documentation
@@ -970,12 +1464,16 @@ module Aws::RAM
970
1464
  end
971
1465
 
972
1466
  # @!attribute [rw] permissions
973
- # Information about the permissions.
1467
+ # An array of objects with information about the permissions.
974
1468
  # @return [Array<Types::ResourceSharePermissionSummary>]
975
1469
  #
976
1470
  # @!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.
1471
+ # If present, this value indicates that more output is available than
1472
+ # is included in the current response. Use this value in the
1473
+ # `NextToken` request parameter in a subsequent call to the operation
1474
+ # to get the next part of the output. You should repeat this until the
1475
+ # `NextToken` response element comes back as `null`. This indicates
1476
+ # that this is the last page of results.
979
1477
  # @return [String]
980
1478
  #
981
1479
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionsResponse AWS API Documentation
@@ -1001,51 +1499,95 @@ module Aws::RAM
1001
1499
  # }
1002
1500
  #
1003
1501
  # @!attribute [rw] resource_owner
1004
- # The type of owner.
1502
+ # Specifies that you want to list information for only resource shares
1503
+ # that match the following:
1504
+ #
1505
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1506
+ #
1507
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other
1508
+ # accounts share with you
1005
1509
  # @return [String]
1006
1510
  #
1007
1511
  # @!attribute [rw] resource_arn
1008
- # The Amazon Resource Name (ARN) of the resource.
1512
+ # Specifies that you want to list principal information for the
1513
+ # resource share with the specified [Amazon Resoure Name (ARN)][1].
1514
+ #
1515
+ #
1516
+ #
1517
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1009
1518
  # @return [String]
1010
1519
  #
1011
1520
  # @!attribute [rw] principals
1012
- # The principals.
1521
+ # Specifies that you want to list information for only the listed
1522
+ # principals.
1523
+ #
1524
+ # You can include the following values:
1525
+ #
1526
+ # * An Amazon Web Services account ID, for example: `123456789012`
1527
+ #
1528
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
1529
+ # Organizations, for example:
1530
+ # `organizations::123456789012:organization/o-exampleorgid`
1531
+ #
1532
+ # * An ARN of an organizational unit (OU) in Organizations, for
1533
+ # example:
1534
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
1535
+ #
1536
+ # * An ARN of an IAM role, for example:
1537
+ # `iam::123456789012:role/rolename`
1538
+ #
1539
+ # * An ARN of an IAM user, for example:
1540
+ # `iam::123456789012user/username`
1541
+ #
1542
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
1543
+ # more information, see [Sharing with IAM roles and users][2] in the
1544
+ # *Resource Access Manager User Guide*.
1545
+ #
1546
+ # </note>
1547
+ #
1548
+ #
1549
+ #
1550
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1551
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
1013
1552
  # @return [Array<String>]
1014
1553
  #
1015
1554
  # @!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`
1555
+ # Specifies that you want to list information for only principals
1556
+ # associated with resource shares that include the specified resource
1557
+ # type.
1558
+ #
1559
+ # For a list of valid values, query the ListResourceTypes operation.
1035
1560
  # @return [String]
1036
1561
  #
1037
1562
  # @!attribute [rw] resource_share_arns
1038
- # The Amazon Resource Names (ARN) of the resource shares.
1563
+ # Specifies that you want to list information for only principals
1564
+ # associated with the resource shares specified by a list the [Amazon
1565
+ # Resource Names (ARNs)][1].
1566
+ #
1567
+ #
1568
+ #
1569
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1039
1570
  # @return [Array<String>]
1040
1571
  #
1041
1572
  # @!attribute [rw] next_token
1042
- # The token for the next page of results.
1573
+ # Specifies that you want to receive the next page of results. Valid
1574
+ # only if you received a `NextToken` response in the previous request.
1575
+ # If you did, it indicates that more output is available. Set this
1576
+ # parameter to the value provided by the previous call's `NextToken`
1577
+ # response to request the next page of results.
1043
1578
  # @return [String]
1044
1579
  #
1045
1580
  # @!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.
1581
+ # Specifies the total number of results that you want included on each
1582
+ # page of the response. If you do not include this parameter, it
1583
+ # defaults to a value that is specific to the operation. If additional
1584
+ # items exist beyond the number you specify, the `NextToken` response
1585
+ # element is returned with a value (not null). Include the specified
1586
+ # value as the `NextToken` request parameter in the next call to the
1587
+ # operation to get the next part of the results. Note that the service
1588
+ # might return fewer results than the maximum even when there are more
1589
+ # results available. You should check `NextToken` after every
1590
+ # operation to ensure that you receive all of the results.
1049
1591
  # @return [Integer]
1050
1592
  #
1051
1593
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPrincipalsRequest AWS API Documentation
@@ -1063,12 +1605,16 @@ module Aws::RAM
1063
1605
  end
1064
1606
 
1065
1607
  # @!attribute [rw] principals
1066
- # The principals.
1608
+ # An array of objects that contain the details about the principals.
1067
1609
  # @return [Array<Types::Principal>]
1068
1610
  #
1069
1611
  # @!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.
1612
+ # If present, this value indicates that more output is available than
1613
+ # is included in the current response. Use this value in the
1614
+ # `NextToken` request parameter in a subsequent call to the operation
1615
+ # to get the next part of the output. You should repeat this until the
1616
+ # `NextToken` response element comes back as `null`. This indicates
1617
+ # that this is the last page of results.
1072
1618
  # @return [String]
1073
1619
  #
1074
1620
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPrincipalsResponse AWS API Documentation
@@ -1090,17 +1636,33 @@ module Aws::RAM
1090
1636
  # }
1091
1637
  #
1092
1638
  # @!attribute [rw] resource_share_arn
1093
- # The Amazon Resource Name (ARN) of the resource share.
1639
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
1640
+ # for which you want to retrieve the associated permissions.
1641
+ #
1642
+ #
1643
+ #
1644
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1094
1645
  # @return [String]
1095
1646
  #
1096
1647
  # @!attribute [rw] next_token
1097
- # The token for the next page of results.
1648
+ # Specifies that you want to receive the next page of results. Valid
1649
+ # only if you received a `NextToken` response in the previous request.
1650
+ # If you did, it indicates that more output is available. Set this
1651
+ # parameter to the value provided by the previous call's `NextToken`
1652
+ # response to request the next page of results.
1098
1653
  # @return [String]
1099
1654
  #
1100
1655
  # @!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.
1656
+ # Specifies the total number of results that you want included on each
1657
+ # page of the response. If you do not include this parameter, it
1658
+ # defaults to a value that is specific to the operation. If additional
1659
+ # items exist beyond the number you specify, the `NextToken` response
1660
+ # element is returned with a value (not null). Include the specified
1661
+ # value as the `NextToken` request parameter in the next call to the
1662
+ # operation to get the next part of the results. Note that the service
1663
+ # might return fewer results than the maximum even when there are more
1664
+ # results available. You should check `NextToken` after every
1665
+ # operation to ensure that you receive all of the results.
1104
1666
  # @return [Integer]
1105
1667
  #
1106
1668
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceSharePermissionsRequest AWS API Documentation
@@ -1114,12 +1676,17 @@ module Aws::RAM
1114
1676
  end
1115
1677
 
1116
1678
  # @!attribute [rw] permissions
1117
- # The permissions associated with the resource share.
1679
+ # An array of objects that describe the permissions associated with
1680
+ # the resource share.
1118
1681
  # @return [Array<Types::ResourceSharePermissionSummary>]
1119
1682
  #
1120
1683
  # @!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.
1684
+ # If present, this value indicates that more output is available than
1685
+ # is included in the current response. Use this value in the
1686
+ # `NextToken` request parameter in a subsequent call to the operation
1687
+ # to get the next part of the output. You should repeat this until the
1688
+ # `NextToken` response element comes back as `null`. This indicates
1689
+ # that this is the last page of results.
1123
1690
  # @return [String]
1124
1691
  #
1125
1692
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceSharePermissionsResponse AWS API Documentation
@@ -1137,34 +1704,68 @@ module Aws::RAM
1137
1704
  # {
1138
1705
  # next_token: "String",
1139
1706
  # max_results: 1,
1707
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
1140
1708
  # }
1141
1709
  #
1142
1710
  # @!attribute [rw] next_token
1143
- # The token for the next page of results.
1711
+ # Specifies that you want to receive the next page of results. Valid
1712
+ # only if you received a `NextToken` response in the previous request.
1713
+ # If you did, it indicates that more output is available. Set this
1714
+ # parameter to the value provided by the previous call's `NextToken`
1715
+ # response to request the next page of results.
1144
1716
  # @return [String]
1145
1717
  #
1146
1718
  # @!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.
1719
+ # Specifies the total number of results that you want included on each
1720
+ # page of the response. If you do not include this parameter, it
1721
+ # defaults to a value that is specific to the operation. If additional
1722
+ # items exist beyond the number you specify, the `NextToken` response
1723
+ # element is returned with a value (not null). Include the specified
1724
+ # value as the `NextToken` request parameter in the next call to the
1725
+ # operation to get the next part of the results. Note that the service
1726
+ # might return fewer results than the maximum even when there are more
1727
+ # results available. You should check `NextToken` after every
1728
+ # operation to ensure that you receive all of the results.
1150
1729
  # @return [Integer]
1151
1730
  #
1731
+ # @!attribute [rw] resource_region_scope
1732
+ # Specifies that you want the results to include only resources that
1733
+ # have the specified scope.
1734
+ #
1735
+ # * `ALL` – the results include both global and regional resources or
1736
+ # resource types.
1737
+ #
1738
+ # * `GLOBAL` – the results include only global resources or resource
1739
+ # types.
1740
+ #
1741
+ # * `REGIONAL` – the results include only regional resources or
1742
+ # resource types.
1743
+ #
1744
+ # The default value is `ALL`.
1745
+ # @return [String]
1746
+ #
1152
1747
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypesRequest AWS API Documentation
1153
1748
  #
1154
1749
  class ListResourceTypesRequest < Struct.new(
1155
1750
  :next_token,
1156
- :max_results)
1751
+ :max_results,
1752
+ :resource_region_scope)
1157
1753
  SENSITIVE = []
1158
1754
  include Aws::Structure
1159
1755
  end
1160
1756
 
1161
1757
  # @!attribute [rw] resource_types
1162
- # The shareable resource types supported by RAM.
1758
+ # An array of objects that contain information about the resource
1759
+ # types that can be shared using RAM.
1163
1760
  # @return [Array<Types::ServiceNameAndResourceType>]
1164
1761
  #
1165
1762
  # @!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.
1763
+ # If present, this value indicates that more output is available than
1764
+ # is included in the current response. Use this value in the
1765
+ # `NextToken` request parameter in a subsequent call to the operation
1766
+ # to get the next part of the output. You should repeat this until the
1767
+ # `NextToken` response element comes back as `null`. This indicates
1768
+ # that this is the last page of results.
1168
1769
  # @return [String]
1169
1770
  #
1170
1771
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypesResponse AWS API Documentation
@@ -1187,56 +1788,88 @@ module Aws::RAM
1187
1788
  # resource_share_arns: ["String"],
1188
1789
  # next_token: "String",
1189
1790
  # max_results: 1,
1791
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
1190
1792
  # }
1191
1793
  #
1192
1794
  # @!attribute [rw] resource_owner
1193
- # The type of owner.
1795
+ # Specifies that you want to list only the resource shares that match
1796
+ # the following:
1797
+ #
1798
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1799
+ #
1800
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other
1801
+ # accounts share with you
1194
1802
  # @return [String]
1195
1803
  #
1196
1804
  # @!attribute [rw] principal
1197
- # The principal.
1805
+ # Specifies that you want to list only the resource shares that are
1806
+ # associated with the specified principal.
1198
1807
  # @return [String]
1199
1808
  #
1200
1809
  # @!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`
1810
+ # Specifies that you want to list only the resource shares that
1811
+ # include resources of the specified resource type.
1812
+ #
1813
+ # For valid values, query the ListResourceTypes operation.
1220
1814
  # @return [String]
1221
1815
  #
1222
1816
  # @!attribute [rw] resource_arns
1223
- # The Amazon Resource Names (ARNs) of the resources.
1817
+ # Specifies that you want to list only the resource shares that
1818
+ # include resources with the specified [Amazon Resource Names
1819
+ # (ARNs)][1].
1820
+ #
1821
+ #
1822
+ #
1823
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1224
1824
  # @return [Array<String>]
1225
1825
  #
1226
1826
  # @!attribute [rw] resource_share_arns
1227
- # The Amazon Resource Names (ARN) of the resource shares.
1827
+ # Specifies that you want to list only resources in the resource
1828
+ # shares identified by the specified [Amazon Resource Names
1829
+ # (ARNs)][1].
1830
+ #
1831
+ #
1832
+ #
1833
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1228
1834
  # @return [Array<String>]
1229
1835
  #
1230
1836
  # @!attribute [rw] next_token
1231
- # The token for the next page of results.
1837
+ # Specifies that you want to receive the next page of results. Valid
1838
+ # only if you received a `NextToken` response in the previous request.
1839
+ # If you did, it indicates that more output is available. Set this
1840
+ # parameter to the value provided by the previous call's `NextToken`
1841
+ # response to request the next page of results.
1232
1842
  # @return [String]
1233
1843
  #
1234
1844
  # @!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.
1845
+ # Specifies the total number of results that you want included on each
1846
+ # page of the response. If you do not include this parameter, it
1847
+ # defaults to a value that is specific to the operation. If additional
1848
+ # items exist beyond the number you specify, the `NextToken` response
1849
+ # element is returned with a value (not null). Include the specified
1850
+ # value as the `NextToken` request parameter in the next call to the
1851
+ # operation to get the next part of the results. Note that the service
1852
+ # might return fewer results than the maximum even when there are more
1853
+ # results available. You should check `NextToken` after every
1854
+ # operation to ensure that you receive all of the results.
1238
1855
  # @return [Integer]
1239
1856
  #
1857
+ # @!attribute [rw] resource_region_scope
1858
+ # Specifies that you want the results to include only resources that
1859
+ # have the specified scope.
1860
+ #
1861
+ # * `ALL` – the results include both global and regional resources or
1862
+ # resource types.
1863
+ #
1864
+ # * `GLOBAL` – the results include only global resources or resource
1865
+ # types.
1866
+ #
1867
+ # * `REGIONAL` – the results include only regional resources or
1868
+ # resource types.
1869
+ #
1870
+ # The default value is `ALL`.
1871
+ # @return [String]
1872
+ #
1240
1873
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourcesRequest AWS API Documentation
1241
1874
  #
1242
1875
  class ListResourcesRequest < Struct.new(
@@ -1246,18 +1879,23 @@ module Aws::RAM
1246
1879
  :resource_arns,
1247
1880
  :resource_share_arns,
1248
1881
  :next_token,
1249
- :max_results)
1882
+ :max_results,
1883
+ :resource_region_scope)
1250
1884
  SENSITIVE = []
1251
1885
  include Aws::Structure
1252
1886
  end
1253
1887
 
1254
1888
  # @!attribute [rw] resources
1255
- # Information about the resources.
1889
+ # An array of objects that contain information about the resources.
1256
1890
  # @return [Array<Types::Resource>]
1257
1891
  #
1258
1892
  # @!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.
1893
+ # If present, this value indicates that more output is available than
1894
+ # is included in the current response. Use this value in the
1895
+ # `NextToken` request parameter in a subsequent call to the operation
1896
+ # to get the next part of the output. You should repeat this until the
1897
+ # `NextToken` response element comes back as `null`. This indicates
1898
+ # that this is the last page of results.
1261
1899
  # @return [String]
1262
1900
  #
1263
1901
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourcesResponse AWS API Documentation
@@ -1315,15 +1953,21 @@ module Aws::RAM
1315
1953
  # @return [String]
1316
1954
  #
1317
1955
  # @!attribute [rw] resource_share_arn
1318
- # The Amazon Resource Name (ARN) of the resource share.
1956
+ # The [Amazon Resoure Name (ARN)][1] of a resource share the principal
1957
+ # is associated with.
1958
+ #
1959
+ #
1960
+ #
1961
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1319
1962
  # @return [String]
1320
1963
  #
1321
1964
  # @!attribute [rw] creation_time
1322
- # The time when the principal was associated with the resource share.
1965
+ # The date and time when the principal was associated with the
1966
+ # resource share.
1323
1967
  # @return [Time]
1324
1968
  #
1325
1969
  # @!attribute [rw] last_updated_time
1326
- # The time when the association was last updated.
1970
+ # The date and time when the association was last updated.
1327
1971
  # @return [Time]
1328
1972
  #
1329
1973
  # @!attribute [rw] external
@@ -1352,7 +1996,12 @@ module Aws::RAM
1352
1996
  # }
1353
1997
  #
1354
1998
  # @!attribute [rw] resource_share_arn
1355
- # The Amazon Resource Name (ARN) of the resource share to promote.
1999
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2000
+ # to promote.
2001
+ #
2002
+ #
2003
+ #
2004
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1356
2005
  # @return [String]
1357
2006
  #
1358
2007
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/PromoteResourceShareCreatedFromPolicyRequest AWS API Documentation
@@ -1364,7 +2013,8 @@ module Aws::RAM
1364
2013
  end
1365
2014
 
1366
2015
  # @!attribute [rw] return_value
1367
- # Indicates whether the request succeeded.
2016
+ # A return value of `true` indicates that the request succeeded. A
2017
+ # value of `false` indicates that the request failed.
1368
2018
  # @return [Boolean]
1369
2019
  #
1370
2020
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/PromoteResourceShareCreatedFromPolicyResponse AWS API Documentation
@@ -1384,12 +2034,28 @@ module Aws::RAM
1384
2034
  # }
1385
2035
  #
1386
2036
  # @!attribute [rw] resource_share_invitation_arn
1387
- # The Amazon Resource Name (ARN) of the invitation.
2037
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the invitation that
2038
+ # you want to reject.
2039
+ #
2040
+ #
2041
+ #
2042
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1388
2043
  # @return [String]
1389
2044
  #
1390
2045
  # @!attribute [rw] client_token
1391
- # A unique, case-sensitive identifier that you provide to ensure the
1392
- # idempotency of the request.
2046
+ # Specifies a unique, case-sensitive identifier that you provide to
2047
+ # ensure the idempotency of the request. This lets you safely retry
2048
+ # the request without accidentally performing the same operation a
2049
+ # second time. Passing the same value to a later call to an operation
2050
+ # requires that you also pass the same value for all other parameters.
2051
+ # We recommend that you use a [UUID type of value.][1].
2052
+ #
2053
+ # If you don't provide this value, then Amazon Web Services generates
2054
+ # a random one for you.
2055
+ #
2056
+ #
2057
+ #
2058
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
1393
2059
  # @return [String]
1394
2060
  #
1395
2061
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/RejectResourceShareInvitationRequest AWS API Documentation
@@ -1402,12 +2068,15 @@ module Aws::RAM
1402
2068
  end
1403
2069
 
1404
2070
  # @!attribute [rw] resource_share_invitation
1405
- # Information about the invitation.
2071
+ # An object that contains the details about the rejected invitation.
1406
2072
  # @return [Types::ResourceShareInvitation]
1407
2073
  #
1408
2074
  # @!attribute [rw] client_token
1409
- # A unique, case-sensitive identifier that you provide to ensure the
1410
- # idempotency of the request.
2075
+ # The idempotency identifier associated with this request. If you want
2076
+ # to repeat the same operation in an idempotent manner then you must
2077
+ # include this value in the `clientToken` request parameter of that
2078
+ # later call. All other parameters must also have the same values that
2079
+ # you used in the first call.
1411
2080
  # @return [String]
1412
2081
  #
1413
2082
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/RejectResourceShareInvitationResponse AWS API Documentation
@@ -1419,27 +2088,41 @@ module Aws::RAM
1419
2088
  include Aws::Structure
1420
2089
  end
1421
2090
 
1422
- # Describes a resource associated with a resource share.
2091
+ # Describes a resource associated with a resource share in RAM.
1423
2092
  #
1424
2093
  # @!attribute [rw] arn
1425
- # The Amazon Resource Name (ARN) of the resource.
2094
+ # The [Amazon Resoure Name (ARN)][1] of the resource.
2095
+ #
2096
+ #
2097
+ #
2098
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1426
2099
  # @return [String]
1427
2100
  #
1428
2101
  # @!attribute [rw] type
1429
- # The resource type.
2102
+ # The resource type. This takes the form of:
2103
+ # `service-code`\:`resource-code`
1430
2104
  # @return [String]
1431
2105
  #
1432
2106
  # @!attribute [rw] resource_share_arn
1433
- # The Amazon Resource Name (ARN) of the resource share.
2107
+ # The [Amazon Resoure Name (ARN)][1] of the resource share this
2108
+ # resource is associated with.
2109
+ #
2110
+ #
2111
+ #
2112
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1434
2113
  # @return [String]
1435
2114
  #
1436
2115
  # @!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.
2116
+ # The [Amazon Resoure Name (ARN)][1] of the resource group. This value
2117
+ # is available only if the resource is part of a resource group.
2118
+ #
2119
+ #
2120
+ #
2121
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1439
2122
  # @return [String]
1440
2123
  #
1441
2124
  # @!attribute [rw] status
1442
- # The status of the resource.
2125
+ # The current status of the resource.
1443
2126
  # @return [String]
1444
2127
  #
1445
2128
  # @!attribute [rw] status_message
@@ -1447,13 +2130,25 @@ module Aws::RAM
1447
2130
  # @return [String]
1448
2131
  #
1449
2132
  # @!attribute [rw] creation_time
1450
- # The time when the resource was associated with the resource share.
2133
+ # The date and time when the resource was associated with the resource
2134
+ # share.
1451
2135
  # @return [Time]
1452
2136
  #
1453
2137
  # @!attribute [rw] last_updated_time
1454
- # The time when the association was last updated.
2138
+ # The date an time when the association was last updated.
1455
2139
  # @return [Time]
1456
2140
  #
2141
+ # @!attribute [rw] resource_region_scope
2142
+ # Specifies the scope of visibility of this resource:
2143
+ #
2144
+ # * **REGIONAL** – The resource can be accessed only by using requests
2145
+ # that target the Amazon Web Services Region in which the resource
2146
+ # exists.
2147
+ #
2148
+ # * **GLOBAL** – The resource can be accessed from any Amazon Web
2149
+ # Services Region.
2150
+ # @return [String]
2151
+ #
1457
2152
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/Resource AWS API Documentation
1458
2153
  #
1459
2154
  class Resource < Struct.new(
@@ -1464,12 +2159,13 @@ module Aws::RAM
1464
2159
  :status,
1465
2160
  :status_message,
1466
2161
  :creation_time,
1467
- :last_updated_time)
2162
+ :last_updated_time,
2163
+ :resource_region_scope)
1468
2164
  SENSITIVE = []
1469
2165
  include Aws::Structure
1470
2166
  end
1471
2167
 
1472
- # An Amazon Resource Name (ARN) was not found.
2168
+ # The specified Amazon Resource Name (ARN) was not found.
1473
2169
  #
1474
2170
  # @!attribute [rw] message
1475
2171
  # @return [String]
@@ -1482,10 +2178,14 @@ module Aws::RAM
1482
2178
  include Aws::Structure
1483
2179
  end
1484
2180
 
1485
- # Describes a resource share.
2181
+ # Describes a resource share in RAM.
1486
2182
  #
1487
2183
  # @!attribute [rw] resource_share_arn
1488
- # The Amazon Resource Name (ARN) of the resource share.
2184
+ # The [Amazon Resoure Name (ARN)][1] of the resource share
2185
+ #
2186
+ #
2187
+ #
2188
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1489
2189
  # @return [String]
1490
2190
  #
1491
2191
  # @!attribute [rw] name
@@ -1503,7 +2203,7 @@ module Aws::RAM
1503
2203
  # @return [Boolean]
1504
2204
  #
1505
2205
  # @!attribute [rw] status
1506
- # The status of the resource share.
2206
+ # The current status of the resource share.
1507
2207
  # @return [String]
1508
2208
  #
1509
2209
  # @!attribute [rw] status_message
@@ -1511,15 +2211,15 @@ module Aws::RAM
1511
2211
  # @return [String]
1512
2212
  #
1513
2213
  # @!attribute [rw] tags
1514
- # The tags for the resource share.
2214
+ # The tag key and value pairs attached to the resource share.
1515
2215
  # @return [Array<Types::Tag>]
1516
2216
  #
1517
2217
  # @!attribute [rw] creation_time
1518
- # The time when the resource share was created.
2218
+ # The date and time when the resource share was created.
1519
2219
  # @return [Time]
1520
2220
  #
1521
2221
  # @!attribute [rw] last_updated_time
1522
- # The time when the resource share was last updated.
2222
+ # The date and time when the resource share was last updated.
1523
2223
  # @return [Time]
1524
2224
  #
1525
2225
  # @!attribute [rw] feature_set
@@ -1527,10 +2227,12 @@ module Aws::RAM
1527
2227
  # include:
1528
2228
  #
1529
2229
  # * `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.
2230
+ # created from an Identity and Access Management (IAM)
2231
+ # resource-based permission policy attached to the resource. This
2232
+ # type of resource share is visible only to the Amazon Web Services
2233
+ # account that created it. You can't modify it in RAM unless you
2234
+ # promote it. For more information, see
2235
+ # PromoteResourceShareCreatedFromPolicy.
1534
2236
  #
1535
2237
  # * `PROMOTING_TO_STANDARD` - The resource share is in the process of
1536
2238
  # being promoted. For more information, see
@@ -1538,7 +2240,8 @@ module Aws::RAM
1538
2240
  #
1539
2241
  # * `STANDARD` - Indicates that the resource share was created in RAM
1540
2242
  # using the console or APIs. These resource shares are visible to
1541
- # all principals. They can be modified in RAM.
2243
+ # all principals you share the resource share with. You can modify
2244
+ # these resource shares in RAM using the console or APIs.
1542
2245
  # @return [String]
1543
2246
  #
1544
2247
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceShare AWS API Documentation
@@ -1558,10 +2261,15 @@ module Aws::RAM
1558
2261
  include Aws::Structure
1559
2262
  end
1560
2263
 
1561
- # Describes an association with a resource share.
2264
+ # Describes an association with a resource share and either a principal
2265
+ # or a resource.
1562
2266
  #
1563
2267
  # @!attribute [rw] resource_share_arn
1564
- # The Amazon Resource Name (ARN) of the resource share.
2268
+ # The [Amazon Resoure Name (ARN)][1] of the resource share.
2269
+ #
2270
+ #
2271
+ #
2272
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1565
2273
  # @return [String]
1566
2274
  #
1567
2275
  # @!attribute [rw] resource_share_name
@@ -1569,27 +2277,35 @@ module Aws::RAM
1569
2277
  # @return [String]
1570
2278
  #
1571
2279
  # @!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:
2280
+ # The associated entity. This can be either of the following:
2281
+ #
2282
+ # * For a resource association, this is the [Amazon Resoure Name
2283
+ # (ARN)][1] of the resource.
2284
+ #
2285
+ # * For principal associations, this is one of the following:
2286
+ #
2287
+ # * The ID of an Amazon Web Services account
1575
2288
  #
1576
- # * An Amazon Web Services account ID
2289
+ # * The [Amazon Resoure Name (ARN)][1] of an organization in
2290
+ # Organizations
1577
2291
  #
1578
- # * An ARN of an organization in Organizations
2292
+ # * The ARN of an organizational unit (OU) in Organizations
1579
2293
  #
1580
- # * An ARN of an organizational unit (OU) in Organizations
2294
+ # * The ARN of an IAM role
1581
2295
  #
1582
- # * An ARN of an IAM role
2296
+ # * The ARN of an IAM user
1583
2297
  #
1584
- # * An ARN of an IAM user
2298
+ #
2299
+ #
2300
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1585
2301
  # @return [String]
1586
2302
  #
1587
2303
  # @!attribute [rw] association_type
1588
- # The association type.
2304
+ # The type of entity included in this association.
1589
2305
  # @return [String]
1590
2306
  #
1591
2307
  # @!attribute [rw] status
1592
- # The status of the association.
2308
+ # The current status of the association.
1593
2309
  # @return [String]
1594
2310
  #
1595
2311
  # @!attribute [rw] status_message
@@ -1597,11 +2313,11 @@ module Aws::RAM
1597
2313
  # @return [String]
1598
2314
  #
1599
2315
  # @!attribute [rw] creation_time
1600
- # The time when the association was created.
2316
+ # The date and time when the association was created.
1601
2317
  # @return [Time]
1602
2318
  #
1603
2319
  # @!attribute [rw] last_updated_time
1604
- # The time when the association was last updated.
2320
+ # The date and time when the association was last updated.
1605
2321
  # @return [Time]
1606
2322
  #
1607
2323
  # @!attribute [rw] external
@@ -1626,10 +2342,15 @@ module Aws::RAM
1626
2342
  include Aws::Structure
1627
2343
  end
1628
2344
 
1629
- # Describes an invitation to join a resource share.
2345
+ # Describes an invitation for an Amazon Web Services account to join a
2346
+ # resource share.
1630
2347
  #
1631
2348
  # @!attribute [rw] resource_share_invitation_arn
1632
- # The Amazon Resource Name (ARN) of the invitation.
2349
+ # The [Amazon Resoure Name (ARN)][1] of the invitation.
2350
+ #
2351
+ #
2352
+ #
2353
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1633
2354
  # @return [String]
1634
2355
  #
1635
2356
  # @!attribute [rw] resource_share_name
@@ -1637,7 +2358,11 @@ module Aws::RAM
1637
2358
  # @return [String]
1638
2359
  #
1639
2360
  # @!attribute [rw] resource_share_arn
1640
- # The Amazon Resource Name (ARN) of the resource share.
2361
+ # The [Amazon Resoure Name (ARN)][1] of the resource share
2362
+ #
2363
+ #
2364
+ #
2365
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1641
2366
  # @return [String]
1642
2367
  #
1643
2368
  # @!attribute [rw] sender_account_id
@@ -1654,21 +2379,21 @@ module Aws::RAM
1654
2379
  # @return [Time]
1655
2380
  #
1656
2381
  # @!attribute [rw] status
1657
- # The status of the invitation.
2382
+ # The current status of the invitation.
1658
2383
  # @return [String]
1659
2384
  #
1660
2385
  # @!attribute [rw] resource_share_associations
1661
2386
  # 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
2387
+ # invitation, use ListPendingInvitationResources.
1667
2388
  # @return [Array<Types::ResourceShareAssociation>]
1668
2389
  #
1669
2390
  # @!attribute [rw] receiver_arn
1670
- # The Amazon Resource Name (ARN) of the IAM user or IAM role that
2391
+ # The [Amazon Resoure Name (ARN)][1] of the IAM user or role that
1671
2392
  # received the invitation.
2393
+ #
2394
+ #
2395
+ #
2396
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1672
2397
  # @return [String]
1673
2398
  #
1674
2399
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceShareInvitation AWS API Documentation
@@ -1687,7 +2412,7 @@ module Aws::RAM
1687
2412
  include Aws::Structure
1688
2413
  end
1689
2414
 
1690
- # The invitation was already accepted.
2415
+ # The specified invitation was already accepted.
1691
2416
  #
1692
2417
  # @!attribute [rw] message
1693
2418
  # @return [String]
@@ -1700,7 +2425,7 @@ module Aws::RAM
1700
2425
  include Aws::Structure
1701
2426
  end
1702
2427
 
1703
- # The invitation was already rejected.
2428
+ # The specified invitation was already rejected.
1704
2429
  #
1705
2430
  # @!attribute [rw] message
1706
2431
  # @return [String]
@@ -1713,7 +2438,8 @@ module Aws::RAM
1713
2438
  include Aws::Structure
1714
2439
  end
1715
2440
 
1716
- # The Amazon Resource Name (ARN) for an invitation was not found.
2441
+ # The specified Amazon Resource Name (ARN) for an invitation was not
2442
+ # found.
1717
2443
  #
1718
2444
  # @!attribute [rw] message
1719
2445
  # @return [String]
@@ -1726,7 +2452,7 @@ module Aws::RAM
1726
2452
  include Aws::Structure
1727
2453
  end
1728
2454
 
1729
- # The invitation is expired.
2455
+ # The specified invitation is expired.
1730
2456
  #
1731
2457
  # @!attribute [rw] message
1732
2458
  # @return [String]
@@ -1739,7 +2465,8 @@ module Aws::RAM
1739
2465
  include Aws::Structure
1740
2466
  end
1741
2467
 
1742
- # The requested resource share exceeds the limit for your account.
2468
+ # This request would exceed the limit for resource shares for your
2469
+ # account.
1743
2470
  #
1744
2471
  # @!attribute [rw] message
1745
2472
  # @return [String]
@@ -1755,31 +2482,35 @@ module Aws::RAM
1755
2482
  # Information about an RAM permission.
1756
2483
  #
1757
2484
  # @!attribute [rw] arn
1758
- # The Amazon Resource Name (ARN) of the permission.
2485
+ # The [Amazon Resoure Name (ARN)][1] of this RAM permission.
2486
+ #
2487
+ #
2488
+ #
2489
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1759
2490
  # @return [String]
1760
2491
  #
1761
2492
  # @!attribute [rw] version
1762
- # The identifier for the version of the permission.
2493
+ # The version of the permission represented in this structure.
1763
2494
  # @return [String]
1764
2495
  #
1765
2496
  # @!attribute [rw] default_version
1766
- # Specifies whether the version of the permission is set to the
1767
- # default version for this permission.
2497
+ # Specifies whether the version of the permission represented in this
2498
+ # structure is the default version for this permission.
1768
2499
  # @return [Boolean]
1769
2500
  #
1770
2501
  # @!attribute [rw] name
1771
- # The name of the permission.
2502
+ # The name of this permission.
1772
2503
  # @return [String]
1773
2504
  #
1774
2505
  # @!attribute [rw] resource_type
1775
- # The resource type to which the permission applies.
2506
+ # The resource type to which this permission applies.
1776
2507
  # @return [String]
1777
2508
  #
1778
2509
  # @!attribute [rw] permission
1779
2510
  # 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.
2511
+ # indicates whether the specified actions are allowed or denied. The
2512
+ # `actions` list the operations to which the principal is granted or
2513
+ # denied access.
1783
2514
  # @return [String]
1784
2515
  #
1785
2516
  # @!attribute [rw] creation_time
@@ -1791,8 +2522,9 @@ module Aws::RAM
1791
2522
  # @return [Time]
1792
2523
  #
1793
2524
  # @!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.
2525
+ # Specifies whether the version of the permission represented in this
2526
+ # structure is the default version for all resources of this resource
2527
+ # type.
1796
2528
  # @return [Boolean]
1797
2529
  #
1798
2530
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceSharePermissionDetail AWS API Documentation
@@ -1811,28 +2543,33 @@ module Aws::RAM
1811
2543
  include Aws::Structure
1812
2544
  end
1813
2545
 
1814
- # Information about a permission that is associated with a resource
1815
- # share.
2546
+ # Information about an RAM permission that is associated with a resource
2547
+ # share and any of its resources of a specified type.
1816
2548
  #
1817
2549
  # @!attribute [rw] arn
1818
- # The Amazon Resource Name (ARN) of the permission.
2550
+ # The [Amazon Resoure Name (ARN)][1] of the permission you want
2551
+ # information about.
2552
+ #
2553
+ #
2554
+ #
2555
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1819
2556
  # @return [String]
1820
2557
  #
1821
2558
  # @!attribute [rw] version
1822
- # The identifier for the version of the permission.
2559
+ # The version of the permission represented in this structure.
1823
2560
  # @return [String]
1824
2561
  #
1825
2562
  # @!attribute [rw] default_version
1826
- # Specifies whether the version of the permission is set to the
1827
- # default version for this permission.
2563
+ # Specifies whether the version of the permission represented in this
2564
+ # structure is the default version for this permission.
1828
2565
  # @return [Boolean]
1829
2566
  #
1830
2567
  # @!attribute [rw] name
1831
- # The name of the permission.
2568
+ # The name of this permission.
1832
2569
  # @return [String]
1833
2570
  #
1834
2571
  # @!attribute [rw] resource_type
1835
- # The type of resource to which the permission applies.
2572
+ # The type of resource to which this permission applies.
1836
2573
  # @return [String]
1837
2574
  #
1838
2575
  # @!attribute [rw] status
@@ -1848,8 +2585,9 @@ module Aws::RAM
1848
2585
  # @return [Time]
1849
2586
  #
1850
2587
  # @!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.
2588
+ # Specifies whether the version of the permission represented in this
2589
+ # structure is the default version for all resources of this resource
2590
+ # type.
1853
2591
  # @return [Boolean]
1854
2592
  #
1855
2593
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ResourceSharePermissionSummary AWS API Documentation
@@ -1882,23 +2620,35 @@ module Aws::RAM
1882
2620
  include Aws::Structure
1883
2621
  end
1884
2622
 
1885
- # Information about the shareable resource types and the Amazon Web
1886
- # Services services to which they belong.
2623
+ # Information about a shareable resource type and the Amazon Web
2624
+ # Services service to which resources of that type belong.
1887
2625
  #
1888
2626
  # @!attribute [rw] resource_type
1889
- # The shareable resource types.
2627
+ # The type of the resource.
1890
2628
  # @return [String]
1891
2629
  #
1892
2630
  # @!attribute [rw] service_name
1893
- # The name of the Amazon Web Services services to which the resources
1894
- # belong.
2631
+ # The name of the Amazon Web Services service to which resources of
2632
+ # this type belong.
2633
+ # @return [String]
2634
+ #
2635
+ # @!attribute [rw] resource_region_scope
2636
+ # Specifies the scope of visibility of resources of this type:
2637
+ #
2638
+ # * **REGIONAL** – The resource can be accessed only by using requests
2639
+ # that target the Amazon Web Services Region in which the resource
2640
+ # exists.
2641
+ #
2642
+ # * **GLOBAL** – The resource can be accessed from any Amazon Web
2643
+ # Services Region.
1895
2644
  # @return [String]
1896
2645
  #
1897
2646
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ServiceNameAndResourceType AWS API Documentation
1898
2647
  #
1899
2648
  class ServiceNameAndResourceType < Struct.new(
1900
2649
  :resource_type,
1901
- :service_name)
2650
+ :service_name,
2651
+ :resource_region_scope)
1902
2652
  SENSITIVE = []
1903
2653
  include Aws::Structure
1904
2654
  end
@@ -1916,7 +2666,18 @@ module Aws::RAM
1916
2666
  include Aws::Structure
1917
2667
  end
1918
2668
 
1919
- # Information about a tag.
2669
+ # A structure containing a tag. A tag is metadata that you can attach to
2670
+ # your resources to help organize and categorize them. You can also use
2671
+ # them to help you secure your resources. For more information, see
2672
+ # [Controlling access to Amazon Web Services resources using tags][1].
2673
+ #
2674
+ # For more information about tags, see [Tagging Amazon Web Services
2675
+ # resources][2] in the *Amazon Web Services General Reference Guide*.
2676
+ #
2677
+ #
2678
+ #
2679
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html
2680
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
1920
2681
  #
1921
2682
  # @note When making an API call, you may pass Tag
1922
2683
  # data as a hash:
@@ -1927,11 +2688,13 @@ module Aws::RAM
1927
2688
  # }
1928
2689
  #
1929
2690
  # @!attribute [rw] key
1930
- # The key of the tag.
2691
+ # The key, or name, attached to the tag. Every tag must have a key.
2692
+ # Key names are case sensitive.
1931
2693
  # @return [String]
1932
2694
  #
1933
2695
  # @!attribute [rw] value
1934
- # The value of the tag.
2696
+ # The string value attached to the tag. The value can be an empty
2697
+ # string. Key values are case sensitive.
1935
2698
  # @return [String]
1936
2699
  #
1937
2700
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/Tag AWS API Documentation
@@ -1943,7 +2706,8 @@ module Aws::RAM
1943
2706
  include Aws::Structure
1944
2707
  end
1945
2708
 
1946
- # Used to filter information based on tags.
2709
+ # A tag key and optional list of possible values that you can use to
2710
+ # filter results for tagged resources.
1947
2711
  #
1948
2712
  # @note When making an API call, you may pass TagFilter
1949
2713
  # data as a hash:
@@ -1954,11 +2718,14 @@ module Aws::RAM
1954
2718
  # }
1955
2719
  #
1956
2720
  # @!attribute [rw] tag_key
1957
- # The tag key.
2721
+ # The tag key. This must have a valid string value and can't be
2722
+ # empty.
1958
2723
  # @return [String]
1959
2724
  #
1960
2725
  # @!attribute [rw] tag_values
1961
- # The tag values.
2726
+ # A list of zero or more tag values. If no values are provided, then
2727
+ # the filter matches any tag with the specified key, regardless of its
2728
+ # value.
1962
2729
  # @return [Array<String>]
1963
2730
  #
1964
2731
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/TagFilter AWS API Documentation
@@ -1970,7 +2737,7 @@ module Aws::RAM
1970
2737
  include Aws::Structure
1971
2738
  end
1972
2739
 
1973
- # The requested tags exceed the limit for your account.
2740
+ # This request would exceed the limit for tags for your account.
1974
2741
  #
1975
2742
  # @!attribute [rw] message
1976
2743
  # @return [String]
@@ -1983,7 +2750,7 @@ module Aws::RAM
1983
2750
  include Aws::Structure
1984
2751
  end
1985
2752
 
1986
- # The specified tag is a reserved word and cannot be used.
2753
+ # The specified tag key is a reserved word and can't be used.
1987
2754
  #
1988
2755
  # @!attribute [rw] message
1989
2756
  # @return [String]
@@ -2010,11 +2777,18 @@ module Aws::RAM
2010
2777
  # }
2011
2778
  #
2012
2779
  # @!attribute [rw] resource_share_arn
2013
- # The Amazon Resource Name (ARN) of the resource share.
2780
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2781
+ # that you want to add tags to.
2782
+ #
2783
+ #
2784
+ #
2785
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
2014
2786
  # @return [String]
2015
2787
  #
2016
2788
  # @!attribute [rw] tags
2017
- # One or more tags.
2789
+ # A list of one or more tag key and value pairs. The tag key must be
2790
+ # present and not be an empty string. The tag value must be present
2791
+ # but can be an empty string.
2018
2792
  # @return [Array<Types::Tag>]
2019
2793
  #
2020
2794
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/TagResourceRequest AWS API Documentation
@@ -2030,6 +2804,20 @@ module Aws::RAM
2030
2804
  #
2031
2805
  class TagResourceResponse < Aws::EmptyStructure; end
2032
2806
 
2807
+ # You exceeded the rate at which you are allowed to perform this
2808
+ # operation. Please try again later.
2809
+ #
2810
+ # @!attribute [rw] message
2811
+ # @return [String]
2812
+ #
2813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ThrottlingException AWS API Documentation
2814
+ #
2815
+ class ThrottlingException < Struct.new(
2816
+ :message)
2817
+ SENSITIVE = []
2818
+ include Aws::Structure
2819
+ end
2820
+
2033
2821
  # A specified resource was not found.
2034
2822
  #
2035
2823
  # @!attribute [rw] message
@@ -2052,11 +2840,17 @@ module Aws::RAM
2052
2840
  # }
2053
2841
  #
2054
2842
  # @!attribute [rw] resource_share_arn
2055
- # The Amazon Resource Name (ARN) of the resource share.
2843
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2844
+ # that you want to remove tags from. The tags are removed from the
2845
+ # resource share, not the resources in the resource share.
2846
+ #
2847
+ #
2848
+ #
2849
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
2056
2850
  # @return [String]
2057
2851
  #
2058
2852
  # @!attribute [rw] tag_keys
2059
- # The tag keys of the tags to remove.
2853
+ # Specifies a list of one or more tag keys that you want to remove.
2060
2854
  # @return [Array<String>]
2061
2855
  #
2062
2856
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UntagResourceRequest AWS API Documentation
@@ -2083,21 +2877,38 @@ module Aws::RAM
2083
2877
  # }
2084
2878
  #
2085
2879
  # @!attribute [rw] resource_share_arn
2086
- # The Amazon Resource Name (ARN) of the resource share.
2880
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2881
+ # that you want to modify.
2882
+ #
2883
+ #
2884
+ #
2885
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
2087
2886
  # @return [String]
2088
2887
  #
2089
2888
  # @!attribute [rw] name
2090
- # The name of the resource share.
2889
+ # If specified, the new name that you want to attach to the resource
2890
+ # share.
2091
2891
  # @return [String]
2092
2892
  #
2093
2893
  # @!attribute [rw] allow_external_principals
2094
- # Indicates whether principals outside your organization in
2894
+ # Specifies whether principals outside your organization in
2095
2895
  # Organizations can be associated with a resource share.
2096
2896
  # @return [Boolean]
2097
2897
  #
2098
2898
  # @!attribute [rw] client_token
2099
- # A unique, case-sensitive identifier that you provide to ensure the
2100
- # idempotency of the request.
2899
+ # Specifies a unique, case-sensitive identifier that you provide to
2900
+ # ensure the idempotency of the request. This lets you safely retry
2901
+ # the request without accidentally performing the same operation a
2902
+ # second time. Passing the same value to a later call to an operation
2903
+ # requires that you also pass the same value for all other parameters.
2904
+ # We recommend that you use a [UUID type of value.][1].
2905
+ #
2906
+ # If you don't provide this value, then Amazon Web Services generates
2907
+ # a random one for you.
2908
+ #
2909
+ #
2910
+ #
2911
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
2101
2912
  # @return [String]
2102
2913
  #
2103
2914
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UpdateResourceShareRequest AWS API Documentation
@@ -2116,8 +2927,11 @@ module Aws::RAM
2116
2927
  # @return [Types::ResourceShare]
2117
2928
  #
2118
2929
  # @!attribute [rw] client_token
2119
- # A unique, case-sensitive identifier that you provide to ensure the
2120
- # idempotency of the request.
2930
+ # The idempotency identifier associated with this request. If you want
2931
+ # to repeat the same operation in an idempotent manner then you must
2932
+ # include this value in the `clientToken` request parameter of that
2933
+ # later call. All other parameters must also have the same values that
2934
+ # you used in the first call.
2121
2935
  # @return [String]
2122
2936
  #
2123
2937
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UpdateResourceShareResponse AWS API Documentation