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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ram/client.rb +866 -225
- data/lib/aws-sdk-ram/client_api.rb +44 -0
- data/lib/aws-sdk-ram/errors.rb +16 -0
- data/lib/aws-sdk-ram/types.rb +1163 -349
- data/lib/aws-sdk-ram.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-ram/client.rb
CHANGED
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::RAM
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
82
|
|
@@ -175,6 +179,10 @@ module Aws::RAM
|
|
175
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
178
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
187
|
# Set to true to disable SDK automatically adding host prefix
|
180
188
|
# to default service endpoint when available.
|
@@ -297,7 +305,7 @@ module Aws::RAM
|
|
297
305
|
# seconds to wait when opening a HTTP session before raising a
|
298
306
|
# `Timeout::Error`.
|
299
307
|
#
|
300
|
-
# @option options [
|
308
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
309
|
# number of seconds to wait for response data. This value can
|
302
310
|
# safely be set per-request on the session.
|
303
311
|
#
|
@@ -313,6 +321,9 @@ module Aws::RAM
|
|
313
321
|
# disables this behaviour. This value can safely be set per
|
314
322
|
# request on the session.
|
315
323
|
#
|
324
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
325
|
+
# in seconds.
|
326
|
+
#
|
316
327
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
328
|
# HTTP debug output will be sent to the `:logger`.
|
318
329
|
#
|
@@ -339,14 +350,32 @@ module Aws::RAM
|
|
339
350
|
# @!group API Operations
|
340
351
|
|
341
352
|
# Accepts an invitation to a resource share from another Amazon Web
|
342
|
-
# Services account.
|
353
|
+
# Services account. After you accept the invitation, the resources
|
354
|
+
# included in the resource share are available to interact with in the
|
355
|
+
# relevant Amazon Web Services Management Consoles and tools.
|
343
356
|
#
|
344
357
|
# @option params [required, String] :resource_share_invitation_arn
|
345
|
-
# The Amazon
|
358
|
+
# The [Amazon Resoure Name (ARN)][1] of the invitation that you want to
|
359
|
+
# accept.
|
360
|
+
#
|
361
|
+
#
|
362
|
+
#
|
363
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
346
364
|
#
|
347
365
|
# @option params [String] :client_token
|
348
|
-
#
|
349
|
-
# idempotency of the request.
|
366
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
367
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
368
|
+
# request without accidentally performing the same operation a second
|
369
|
+
# time. Passing the same value to a later call to an operation requires
|
370
|
+
# that you also pass the same value for all other parameters. We
|
371
|
+
# recommend that you use a [UUID type of value.][1].
|
372
|
+
#
|
373
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
374
|
+
# random one for you.
|
375
|
+
#
|
376
|
+
#
|
377
|
+
#
|
378
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
350
379
|
#
|
351
380
|
# @return [Types::AcceptResourceShareInvitationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
352
381
|
#
|
@@ -391,42 +420,78 @@ module Aws::RAM
|
|
391
420
|
req.send_request(options)
|
392
421
|
end
|
393
422
|
|
394
|
-
#
|
395
|
-
#
|
423
|
+
# Adds the specified list of principals and list of resources to a
|
424
|
+
# resource share. Principals that already have access to this resource
|
425
|
+
# share immediately receive access to the added resources. Newly added
|
426
|
+
# principals immediately receive access to the resources shared in this
|
427
|
+
# resource share.
|
396
428
|
#
|
397
429
|
# @option params [required, String] :resource_share_arn
|
398
|
-
#
|
430
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
|
431
|
+
# that you want to add principals or resources to.
|
432
|
+
#
|
433
|
+
#
|
434
|
+
#
|
435
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
399
436
|
#
|
400
437
|
# @option params [Array<String>] :resource_arns
|
401
|
-
#
|
438
|
+
# Specifies a list of [Amazon Resource Names (ARNs)][1] of the resources
|
439
|
+
# that you want to share. This can be `null` if you want to add only
|
440
|
+
# principals.
|
441
|
+
#
|
442
|
+
#
|
443
|
+
#
|
444
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
402
445
|
#
|
403
446
|
# @option params [Array<String>] :principals
|
404
|
-
#
|
405
|
-
#
|
447
|
+
# Specifies a list of principals to whom you want to the resource share.
|
448
|
+
# This can be `null` if you want to add only resources.
|
449
|
+
#
|
450
|
+
# What the principals can do with the resources in the share is
|
451
|
+
# determined by the RAM permissions that you associate with the resource
|
452
|
+
# share. See AssociateResourceSharePermission.
|
453
|
+
#
|
454
|
+
# You can include the following values:
|
406
455
|
#
|
407
|
-
# * An Amazon Web Services account ID
|
456
|
+
# * An Amazon Web Services account ID, for example: `123456789012`
|
408
457
|
#
|
409
|
-
# * An Amazon
|
458
|
+
# * An [Amazon Resoure Name (ARN)][1] of an organization in
|
459
|
+
# Organizations, for example:
|
460
|
+
# `organizations::123456789012:organization/o-exampleorgid`
|
410
461
|
#
|
411
|
-
# * An ARN of an organizational unit (OU) in Organizations
|
462
|
+
# * An ARN of an organizational unit (OU) in Organizations, for example:
|
463
|
+
# `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
|
412
464
|
#
|
413
|
-
# * An ARN of an IAM role
|
465
|
+
# * An ARN of an IAM role, for example:
|
466
|
+
# `iam::123456789012:role/rolename`
|
414
467
|
#
|
415
|
-
# * An ARN of an IAM user
|
468
|
+
# * An ARN of an IAM user, for example: `iam::123456789012user/username`
|
416
469
|
#
|
417
|
-
# <note markdown="1"> Not all resource types can be shared with IAM roles and
|
418
|
-
# more information, see [Sharing with IAM roles and
|
470
|
+
# <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
|
471
|
+
# more information, see [Sharing with IAM roles and users][2] in the
|
419
472
|
# *Resource Access Manager User Guide*.
|
420
473
|
#
|
421
474
|
# </note>
|
422
475
|
#
|
423
476
|
#
|
424
477
|
#
|
425
|
-
# [1]: https://docs.aws.amazon.com/
|
478
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
479
|
+
# [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
|
426
480
|
#
|
427
481
|
# @option params [String] :client_token
|
428
|
-
#
|
429
|
-
# idempotency of the request.
|
482
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
483
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
484
|
+
# request without accidentally performing the same operation a second
|
485
|
+
# time. Passing the same value to a later call to an operation requires
|
486
|
+
# that you also pass the same value for all other parameters. We
|
487
|
+
# recommend that you use a [UUID type of value.][1].
|
488
|
+
#
|
489
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
490
|
+
# random one for you.
|
491
|
+
#
|
492
|
+
#
|
493
|
+
#
|
494
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
430
495
|
#
|
431
496
|
# @return [Types::AssociateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
432
497
|
#
|
@@ -465,28 +530,66 @@ module Aws::RAM
|
|
465
530
|
req.send_request(options)
|
466
531
|
end
|
467
532
|
|
468
|
-
#
|
533
|
+
# Adds or replaces the RAM permission for a resource type included in a
|
534
|
+
# resource share. You can have exactly one permission associated with
|
535
|
+
# each resource type in the resource share. You can add a new RAM
|
536
|
+
# permission only if there are currently no resources of that resource
|
537
|
+
# type currently in the resource share.
|
469
538
|
#
|
470
539
|
# @option params [required, String] :resource_share_arn
|
471
|
-
#
|
540
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource share to
|
541
|
+
# which you want to add or replace permissions.
|
542
|
+
#
|
543
|
+
#
|
544
|
+
#
|
545
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
472
546
|
#
|
473
547
|
# @option params [required, String] :permission_arn
|
474
|
-
#
|
475
|
-
# the resource share.
|
548
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the RAM permission to
|
549
|
+
# associate with the resource share. To find the ARN for a permission,
|
550
|
+
# use either the ListPermissions operation or go to the [Permissions
|
551
|
+
# library][2] page in the RAM console and then choose the name of the
|
552
|
+
# permission. The ARN is displayed on the detail page.
|
553
|
+
#
|
554
|
+
#
|
555
|
+
#
|
556
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
557
|
+
# [2]: https://console.aws.amazon.com/ram/home#Permissions:
|
476
558
|
#
|
477
559
|
# @option params [Boolean] :replace
|
478
|
-
#
|
479
|
-
#
|
480
|
-
# replace the current permissions. Use `false` to add the permission
|
481
|
-
# the current permission.
|
560
|
+
# Specifies whether the specified permission should replace or add to
|
561
|
+
# the existing permission associated with the resource share. Use `true`
|
562
|
+
# to replace the current permissions. Use `false` to add the permission
|
563
|
+
# to the current permission. The default value is `false`.
|
564
|
+
#
|
565
|
+
# <note markdown="1"> A resource share can have only one permission per resource type. If a
|
566
|
+
# resource share already has a permission for the specified resource
|
567
|
+
# type and you don't set `replace` to `true` then the operation returns
|
568
|
+
# an error. This helps prevent accidental overwriting of a permission.
|
569
|
+
#
|
570
|
+
# </note>
|
482
571
|
#
|
483
572
|
# @option params [String] :client_token
|
484
|
-
#
|
485
|
-
# idempotency of the request.
|
573
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
574
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
575
|
+
# request without accidentally performing the same operation a second
|
576
|
+
# time. Passing the same value to a later call to an operation requires
|
577
|
+
# that you also pass the same value for all other parameters. We
|
578
|
+
# recommend that you use a [UUID type of value.][1].
|
579
|
+
#
|
580
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
581
|
+
# random one for you.
|
582
|
+
#
|
583
|
+
#
|
584
|
+
#
|
585
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
486
586
|
#
|
487
587
|
# @option params [Integer] :permission_version
|
488
|
-
#
|
489
|
-
# share.
|
588
|
+
# Specifies the version of the RAM permission to associate with the
|
589
|
+
# resource share. If you don't specify this parameter, the operation
|
590
|
+
# uses the version designated as the default. You can use the
|
591
|
+
# ListPermissionVersions operation to discover the available versions of
|
592
|
+
# a permission.
|
490
593
|
#
|
491
594
|
# @return [Types::AssociateResourceSharePermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
492
595
|
#
|
@@ -517,10 +620,10 @@ module Aws::RAM
|
|
517
620
|
req.send_request(options)
|
518
621
|
end
|
519
622
|
|
520
|
-
# Creates a resource share. You
|
521
|
-
# Resource Names (ARNs) for the resources you want to share
|
522
|
-
#
|
523
|
-
# permissions
|
623
|
+
# Creates a resource share. You can provide a list of the [Amazon
|
624
|
+
# Resource Names (ARNs)][1] for the resources that you want to share, a
|
625
|
+
# list of principals you want to share the resources with, and the
|
626
|
+
# permissions to grant those principals.
|
524
627
|
#
|
525
628
|
# <note markdown="1"> Sharing a resource makes it available for use by principals outside of
|
526
629
|
# the Amazon Web Services account that created the resource. Sharing
|
@@ -529,53 +632,86 @@ module Aws::RAM
|
|
529
632
|
#
|
530
633
|
# </note>
|
531
634
|
#
|
635
|
+
#
|
636
|
+
#
|
637
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
638
|
+
#
|
532
639
|
# @option params [required, String] :name
|
533
|
-
#
|
640
|
+
# Specifies the name of the resource share.
|
534
641
|
#
|
535
642
|
# @option params [Array<String>] :resource_arns
|
536
|
-
#
|
643
|
+
# Specifies a list of one or more ARNs of the resources to associate
|
644
|
+
# with the resource share.
|
537
645
|
#
|
538
646
|
# @option params [Array<String>] :principals
|
539
|
-
#
|
540
|
-
#
|
647
|
+
# Specifies a list of one or more principals to associate with the
|
648
|
+
# resource share.
|
541
649
|
#
|
542
|
-
#
|
650
|
+
# You can include the following values:
|
543
651
|
#
|
544
|
-
# * An Amazon
|
652
|
+
# * An Amazon Web Services account ID, for example: `123456789012`
|
545
653
|
#
|
546
|
-
# * An ARN of an
|
654
|
+
# * An [Amazon Resoure Name (ARN)][1] of an organization in
|
655
|
+
# Organizations, for example:
|
656
|
+
# `organizations::123456789012:organization/o-exampleorgid`
|
547
657
|
#
|
548
|
-
# * An ARN of an
|
658
|
+
# * An ARN of an organizational unit (OU) in Organizations, for example:
|
659
|
+
# `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
|
549
660
|
#
|
550
|
-
# * An ARN of an IAM
|
661
|
+
# * An ARN of an IAM role, for example:
|
662
|
+
# `iam::123456789012:role/rolename`
|
551
663
|
#
|
552
|
-
#
|
553
|
-
#
|
664
|
+
# * An ARN of an IAM user, for example: `iam::123456789012user/username`
|
665
|
+
#
|
666
|
+
# <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
|
667
|
+
# more information, see [Sharing with IAM roles and users][2] in the
|
554
668
|
# *Resource Access Manager User Guide*.
|
555
669
|
#
|
556
670
|
# </note>
|
557
671
|
#
|
558
672
|
#
|
559
673
|
#
|
560
|
-
# [1]: https://docs.aws.amazon.com/
|
674
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
675
|
+
# [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
|
561
676
|
#
|
562
677
|
# @option params [Array<Types::Tag>] :tags
|
563
|
-
#
|
678
|
+
# Specifies one or more tags to attach to the resource share itself. It
|
679
|
+
# doesn't attach the tags to the resources associated with the resource
|
680
|
+
# share.
|
564
681
|
#
|
565
682
|
# @option params [Boolean] :allow_external_principals
|
566
|
-
#
|
567
|
-
# Organizations can be associated with a resource share.
|
683
|
+
# Specifies whether principals outside your organization in
|
684
|
+
# Organizations can be associated with a resource share. A value of
|
685
|
+
# `true` lets you share with individual Amazon Web Services accounts
|
686
|
+
# that are *not* in your organization. A value of `false` only has
|
687
|
+
# meaning if your account is a member of an Amazon Web Services
|
688
|
+
# Organization. The default value is `true`.
|
568
689
|
#
|
569
690
|
# @option params [String] :client_token
|
570
|
-
#
|
571
|
-
# idempotency of the request.
|
691
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
692
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
693
|
+
# request without accidentally performing the same operation a second
|
694
|
+
# time. Passing the same value to a later call to an operation requires
|
695
|
+
# that you also pass the same value for all other parameters. We
|
696
|
+
# recommend that you use a [UUID type of value.][1].
|
697
|
+
#
|
698
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
699
|
+
# random one for you.
|
700
|
+
#
|
701
|
+
#
|
702
|
+
#
|
703
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
572
704
|
#
|
573
705
|
# @option params [Array<String>] :permission_arns
|
574
|
-
#
|
575
|
-
# the resource share. If you do not specify an ARN for
|
576
|
-
# RAM automatically attaches the default version of the
|
577
|
-
# each resource type.
|
578
|
-
# resource type in
|
706
|
+
# Specifies the [Amazon Resource Names (ARNs)][1] of the RAM permission
|
707
|
+
# to associate with the resource share. If you do not specify an ARN for
|
708
|
+
# the permission, RAM automatically attaches the default version of the
|
709
|
+
# permission for each resource type. You can associate only one
|
710
|
+
# permission with each resource type included in the resource share.
|
711
|
+
#
|
712
|
+
#
|
713
|
+
#
|
714
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
579
715
|
#
|
580
716
|
# @return [Types::CreateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
581
717
|
#
|
@@ -624,14 +760,33 @@ module Aws::RAM
|
|
624
760
|
req.send_request(options)
|
625
761
|
end
|
626
762
|
|
627
|
-
# Deletes the specified resource share.
|
763
|
+
# Deletes the specified resource share. This doesn't delete any of the
|
764
|
+
# resources that were associated with the resource share; it only stops
|
765
|
+
# the sharing of those resources outside of the Amazon Web Services
|
766
|
+
# account that created them.
|
628
767
|
#
|
629
768
|
# @option params [required, String] :resource_share_arn
|
630
|
-
#
|
769
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource share to
|
770
|
+
# delete.
|
771
|
+
#
|
772
|
+
#
|
773
|
+
#
|
774
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
631
775
|
#
|
632
776
|
# @option params [String] :client_token
|
633
|
-
#
|
634
|
-
# idempotency of the request.
|
777
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
778
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
779
|
+
# request without accidentally performing the same operation a second
|
780
|
+
# time. Passing the same value to a later call to an operation requires
|
781
|
+
# that you also pass the same value for all other parameters. We
|
782
|
+
# recommend that you use a [UUID type of value.][1].
|
783
|
+
#
|
784
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
785
|
+
# random one for you.
|
786
|
+
#
|
787
|
+
#
|
788
|
+
#
|
789
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
635
790
|
#
|
636
791
|
# @return [Types::DeleteResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
637
792
|
#
|
@@ -663,17 +818,68 @@ module Aws::RAM
|
|
663
818
|
# resource share.
|
664
819
|
#
|
665
820
|
# @option params [required, String] :resource_share_arn
|
666
|
-
#
|
821
|
+
# Specifies [Amazon Resoure Name (ARN)][1] of the resource share that
|
822
|
+
# you want to remove resources from.
|
823
|
+
#
|
824
|
+
#
|
825
|
+
#
|
826
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
667
827
|
#
|
668
828
|
# @option params [Array<String>] :resource_arns
|
669
|
-
#
|
829
|
+
# Specifies a list of [Amazon Resource Names (ARNs)][1] for one or more
|
830
|
+
# resources that you want to remove from the resource share. After the
|
831
|
+
# operation runs, these resources are no longer shared with principals
|
832
|
+
# outside of the Amazon Web Services account that created the resources.
|
833
|
+
#
|
834
|
+
#
|
835
|
+
#
|
836
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
670
837
|
#
|
671
838
|
# @option params [Array<String>] :principals
|
672
|
-
#
|
839
|
+
# Specifies a list of one or more principals that no longer are to have
|
840
|
+
# access to the resources in this resource share.
|
841
|
+
#
|
842
|
+
# You can include the following values:
|
843
|
+
#
|
844
|
+
# * An Amazon Web Services account ID, for example: `123456789012`
|
845
|
+
#
|
846
|
+
# * An [Amazon Resoure Name (ARN)][1] of an organization in
|
847
|
+
# Organizations, for example:
|
848
|
+
# `organizations::123456789012:organization/o-exampleorgid`
|
849
|
+
#
|
850
|
+
# * An ARN of an organizational unit (OU) in Organizations, for example:
|
851
|
+
# `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
|
852
|
+
#
|
853
|
+
# * An ARN of an IAM role, for example:
|
854
|
+
# `iam::123456789012:role/rolename`
|
855
|
+
#
|
856
|
+
# * An ARN of an IAM user, for example: `iam::123456789012user/username`
|
857
|
+
#
|
858
|
+
# <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
|
859
|
+
# more information, see [Sharing with IAM roles and users][2] in the
|
860
|
+
# *Resource Access Manager User Guide*.
|
861
|
+
#
|
862
|
+
# </note>
|
863
|
+
#
|
864
|
+
#
|
865
|
+
#
|
866
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
867
|
+
# [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
|
673
868
|
#
|
674
869
|
# @option params [String] :client_token
|
675
|
-
#
|
676
|
-
# idempotency of the request.
|
870
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
871
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
872
|
+
# request without accidentally performing the same operation a second
|
873
|
+
# time. Passing the same value to a later call to an operation requires
|
874
|
+
# that you also pass the same value for all other parameters. We
|
875
|
+
# recommend that you use a [UUID type of value.][1].
|
876
|
+
#
|
877
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
878
|
+
# random one for you.
|
879
|
+
#
|
880
|
+
#
|
881
|
+
#
|
882
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
677
883
|
#
|
678
884
|
# @return [Types::DisassociateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
679
885
|
#
|
@@ -712,18 +918,42 @@ module Aws::RAM
|
|
712
918
|
req.send_request(options)
|
713
919
|
end
|
714
920
|
|
715
|
-
# Disassociates an RAM permission from a resource share.
|
921
|
+
# Disassociates an RAM permission from a resource share. Permission
|
922
|
+
# changes take effect immediately. You can remove a RAM permission from
|
923
|
+
# a resource share only if there are currently no resources of the
|
924
|
+
# relevant resource type currently attached to the resource share.
|
716
925
|
#
|
717
926
|
# @option params [required, String] :resource_share_arn
|
718
|
-
# The Amazon
|
927
|
+
# The [Amazon Resoure Name (ARN)][1] of the resource share from which
|
928
|
+
# you want to disassociate a permission.
|
929
|
+
#
|
930
|
+
#
|
931
|
+
#
|
932
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
719
933
|
#
|
720
934
|
# @option params [required, String] :permission_arn
|
721
|
-
# The Amazon
|
722
|
-
# the resource share.
|
935
|
+
# The [Amazon Resoure Name (ARN)][1] of the permission to disassociate
|
936
|
+
# from the resource share. Changes to permissions take effect
|
937
|
+
# immediately.
|
938
|
+
#
|
939
|
+
#
|
940
|
+
#
|
941
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
723
942
|
#
|
724
943
|
# @option params [String] :client_token
|
725
|
-
#
|
726
|
-
# idempotency of the request.
|
944
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
945
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
946
|
+
# request without accidentally performing the same operation a second
|
947
|
+
# time. Passing the same value to a later call to an operation requires
|
948
|
+
# that you also pass the same value for all other parameters. We
|
949
|
+
# recommend that you use a [UUID type of value.][1].
|
950
|
+
#
|
951
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
952
|
+
# random one for you.
|
953
|
+
#
|
954
|
+
#
|
955
|
+
#
|
956
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
727
957
|
#
|
728
958
|
# @return [Types::DisassociateResourceSharePermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
729
959
|
#
|
@@ -753,8 +983,16 @@ module Aws::RAM
|
|
753
983
|
end
|
754
984
|
|
755
985
|
# Enables resource sharing within your organization in Organizations.
|
986
|
+
# Calling this operation enables RAM to retrieve information about the
|
987
|
+
# organization and its structure. This lets you share resources with all
|
988
|
+
# of the accounts in an organization by specifying the organization's
|
989
|
+
# ID, or all of the accounts in an organizational unit (OU) by
|
990
|
+
# specifying the OU's ID. Until you enable sharing within the
|
991
|
+
# organization, you can specify only individual Amazon Web Services
|
992
|
+
# accounts, or for supported resource types, IAM users and roles.
|
756
993
|
#
|
757
|
-
#
|
994
|
+
# You must call this operation from an IAM user or role in the
|
995
|
+
# organization's management account.
|
758
996
|
#
|
759
997
|
# @return [Types::EnableSharingWithAwsOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
760
998
|
#
|
@@ -776,10 +1014,21 @@ module Aws::RAM
|
|
776
1014
|
# Gets the contents of an RAM permission in JSON format.
|
777
1015
|
#
|
778
1016
|
# @option params [required, String] :permission_arn
|
779
|
-
#
|
1017
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the permission whose
|
1018
|
+
# contents you want to retrieve. To find the ARN for a permission, use
|
1019
|
+
# either the ListPermissions operation or go to the [Permissions
|
1020
|
+
# library][2] page in the RAM console and then choose the name of the
|
1021
|
+
# permission. The ARN is displayed on the detail page.
|
1022
|
+
#
|
1023
|
+
#
|
1024
|
+
#
|
1025
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1026
|
+
# [2]: https://console.aws.amazon.com/ram/home#Permissions:
|
780
1027
|
#
|
781
1028
|
# @option params [Integer] :permission_version
|
782
|
-
#
|
1029
|
+
# Specifies identifier for the version of the RAM permission to
|
1030
|
+
# retrieve. If you don't specify this parameter, the operation
|
1031
|
+
# retrieves the default version.
|
783
1032
|
#
|
784
1033
|
# @return [Types::GetPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
785
1034
|
#
|
@@ -813,22 +1062,38 @@ module Aws::RAM
|
|
813
1062
|
req.send_request(options)
|
814
1063
|
end
|
815
1064
|
|
816
|
-
#
|
817
|
-
# shared.
|
1065
|
+
# Retrieves the resource policies for the specified resources that you
|
1066
|
+
# own and have shared.
|
818
1067
|
#
|
819
1068
|
# @option params [required, Array<String>] :resource_arns
|
820
|
-
#
|
1069
|
+
# Specifies the [Amazon Resource Names (ARNs)][1] of the resources whose
|
1070
|
+
# policies you want to retrieve.
|
1071
|
+
#
|
1072
|
+
#
|
1073
|
+
#
|
1074
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
821
1075
|
#
|
822
1076
|
# @option params [String] :principal
|
823
|
-
#
|
1077
|
+
# Specifies the principal.
|
824
1078
|
#
|
825
1079
|
# @option params [String] :next_token
|
826
|
-
#
|
1080
|
+
# Specifies that you want to receive the next page of results. Valid
|
1081
|
+
# only if you received a `NextToken` response in the previous request.
|
1082
|
+
# If you did, it indicates that more output is available. Set this
|
1083
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1084
|
+
# response to request the next page of results.
|
827
1085
|
#
|
828
1086
|
# @option params [Integer] :max_results
|
829
|
-
#
|
830
|
-
#
|
831
|
-
#
|
1087
|
+
# Specifies the total number of results that you want included on each
|
1088
|
+
# page of the response. If you do not include this parameter, it
|
1089
|
+
# defaults to a value that is specific to the operation. If additional
|
1090
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1091
|
+
# element is returned with a value (not null). Include the specified
|
1092
|
+
# value as the `NextToken` request parameter in the next call to the
|
1093
|
+
# operation to get the next part of the results. Note that the service
|
1094
|
+
# might return fewer results than the maximum even when there are more
|
1095
|
+
# results available. You should check `NextToken` after every operation
|
1096
|
+
# to ensure that you receive all of the results.
|
832
1097
|
#
|
833
1098
|
# @return [Types::GetResourcePoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
834
1099
|
#
|
@@ -861,35 +1126,73 @@ module Aws::RAM
|
|
861
1126
|
req.send_request(options)
|
862
1127
|
end
|
863
1128
|
|
864
|
-
#
|
1129
|
+
# Retrieves the resource and principal associations for resource shares
|
1130
|
+
# that you own.
|
865
1131
|
#
|
866
1132
|
# @option params [required, String] :association_type
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
#
|
1133
|
+
# Specifies whether you want to retrieve the associations that involve a
|
1134
|
+
# specified resource or principal.
|
1135
|
+
#
|
1136
|
+
# * `PRINCIPAL` – list the principals that are associated with the
|
1137
|
+
# specified resource share.
|
1138
|
+
#
|
1139
|
+
# * `RESOURCE` – list the resources that are associated with the
|
1140
|
+
# specified resource share.
|
871
1141
|
#
|
872
1142
|
# @option params [Array<String>] :resource_share_arns
|
873
|
-
#
|
1143
|
+
# Specifies a list of [Amazon Resource Names (ARNs)][1] of the resource
|
1144
|
+
# share whose associations you want to retrieve.
|
1145
|
+
#
|
1146
|
+
#
|
1147
|
+
#
|
1148
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
874
1149
|
#
|
875
1150
|
# @option params [String] :resource_arn
|
876
|
-
#
|
877
|
-
#
|
1151
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource whose
|
1152
|
+
# resource shares you want to retrieve.
|
1153
|
+
#
|
1154
|
+
# You cannot specify this parameter if the association type is
|
1155
|
+
# `PRINCIPAL`.
|
1156
|
+
#
|
1157
|
+
#
|
1158
|
+
#
|
1159
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
878
1160
|
#
|
879
1161
|
# @option params [String] :principal
|
880
|
-
#
|
881
|
-
#
|
1162
|
+
# Specifies the ID of the principal whose resource shares you want to
|
1163
|
+
# retrieve. This can be an Amazon Web Services account ID, an
|
1164
|
+
# organization ID, an organizational unit ID, or the [Amazon Resoure
|
1165
|
+
# Name (ARN)][1] of an individual IAM user or role.
|
1166
|
+
#
|
1167
|
+
# You cannot specify this parameter if the association type is
|
1168
|
+
# `RESOURCE`.
|
1169
|
+
#
|
1170
|
+
#
|
1171
|
+
#
|
1172
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
882
1173
|
#
|
883
1174
|
# @option params [String] :association_status
|
884
|
-
#
|
1175
|
+
# Specifies that you want to retrieve only associations with this
|
1176
|
+
# status.
|
885
1177
|
#
|
886
1178
|
# @option params [String] :next_token
|
887
|
-
#
|
1179
|
+
# Specifies that you want to receive the next page of results. Valid
|
1180
|
+
# only if you received a `NextToken` response in the previous request.
|
1181
|
+
# If you did, it indicates that more output is available. Set this
|
1182
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1183
|
+
# response to request the next page of results.
|
888
1184
|
#
|
889
1185
|
# @option params [Integer] :max_results
|
890
|
-
#
|
891
|
-
#
|
892
|
-
#
|
1186
|
+
# Specifies the total number of results that you want included on each
|
1187
|
+
# page of the response. If you do not include this parameter, it
|
1188
|
+
# defaults to a value that is specific to the operation. If additional
|
1189
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1190
|
+
# element is returned with a value (not null). Include the specified
|
1191
|
+
# value as the `NextToken` request parameter in the next call to the
|
1192
|
+
# operation to get the next part of the results. Note that the service
|
1193
|
+
# might return fewer results than the maximum even when there are more
|
1194
|
+
# results available. You should check `NextToken` after every operation
|
1195
|
+
# to ensure that you receive all of the results.
|
893
1196
|
#
|
894
1197
|
# @return [Types::GetResourceShareAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
895
1198
|
#
|
@@ -933,21 +1236,44 @@ module Aws::RAM
|
|
933
1236
|
req.send_request(options)
|
934
1237
|
end
|
935
1238
|
|
936
|
-
#
|
1239
|
+
# Retrieves details about invitations that you have received for
|
1240
|
+
# resource shares.
|
937
1241
|
#
|
938
1242
|
# @option params [Array<String>] :resource_share_invitation_arns
|
939
|
-
#
|
1243
|
+
# Specifies the [Amazon Resource Names (ARNs)][1] of the resource share
|
1244
|
+
# invitations you want information about.
|
1245
|
+
#
|
1246
|
+
#
|
1247
|
+
#
|
1248
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
940
1249
|
#
|
941
1250
|
# @option params [Array<String>] :resource_share_arns
|
942
|
-
#
|
1251
|
+
# Specifies that you want details about invitations only for the
|
1252
|
+
# resource shares described by this list of [Amazon Resource Names
|
1253
|
+
# (ARNs)][1]
|
1254
|
+
#
|
1255
|
+
#
|
1256
|
+
#
|
1257
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
943
1258
|
#
|
944
1259
|
# @option params [String] :next_token
|
945
|
-
#
|
1260
|
+
# Specifies that you want to receive the next page of results. Valid
|
1261
|
+
# only if you received a `NextToken` response in the previous request.
|
1262
|
+
# If you did, it indicates that more output is available. Set this
|
1263
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1264
|
+
# response to request the next page of results.
|
946
1265
|
#
|
947
1266
|
# @option params [Integer] :max_results
|
948
|
-
#
|
949
|
-
#
|
950
|
-
#
|
1267
|
+
# Specifies the total number of results that you want included on each
|
1268
|
+
# page of the response. If you do not include this parameter, it
|
1269
|
+
# defaults to a value that is specific to the operation. If additional
|
1270
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1271
|
+
# element is returned with a value (not null). Include the specified
|
1272
|
+
# value as the `NextToken` request parameter in the next call to the
|
1273
|
+
# operation to get the next part of the results. Note that the service
|
1274
|
+
# might return fewer results than the maximum even when there are more
|
1275
|
+
# results available. You should check `NextToken` after every operation
|
1276
|
+
# to ensure that you receive all of the results.
|
951
1277
|
#
|
952
1278
|
# @return [Types::GetResourceShareInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
953
1279
|
#
|
@@ -997,35 +1323,65 @@ module Aws::RAM
|
|
997
1323
|
req.send_request(options)
|
998
1324
|
end
|
999
1325
|
|
1000
|
-
#
|
1326
|
+
# Retrieves details about the resource shares that you own or that are
|
1001
1327
|
# shared with you.
|
1002
1328
|
#
|
1003
1329
|
# @option params [Array<String>] :resource_share_arns
|
1004
|
-
#
|
1330
|
+
# Specifies the [Amazon Resource Names (ARNs)][1] of individual resource
|
1331
|
+
# shares that you want information about.
|
1332
|
+
#
|
1333
|
+
#
|
1334
|
+
#
|
1335
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1005
1336
|
#
|
1006
1337
|
# @option params [String] :resource_share_status
|
1007
|
-
#
|
1338
|
+
# Specifies that you want to retrieve details of only those resource
|
1339
|
+
# shares that have this status.
|
1008
1340
|
#
|
1009
1341
|
# @option params [required, String] :resource_owner
|
1010
|
-
#
|
1342
|
+
# Specifies that you want to retrieve details of only those resource
|
1343
|
+
# shares that match the following:
|
1344
|
+
#
|
1345
|
+
# * <b> <code>SELF</code> </b> – resources that you are sharing
|
1346
|
+
#
|
1347
|
+
# * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts
|
1348
|
+
# share with you
|
1011
1349
|
#
|
1012
1350
|
# @option params [String] :name
|
1013
|
-
#
|
1351
|
+
# Specifies the name of an individual resource share that you want to
|
1352
|
+
# retrieve details about.
|
1014
1353
|
#
|
1015
1354
|
# @option params [Array<Types::TagFilter>] :tag_filters
|
1016
|
-
#
|
1355
|
+
# Specifies that you want to retrieve details of only those resource
|
1356
|
+
# shares that match the specified tag keys and values.
|
1017
1357
|
#
|
1018
1358
|
# @option params [String] :next_token
|
1019
|
-
#
|
1359
|
+
# Specifies that you want to receive the next page of results. Valid
|
1360
|
+
# only if you received a `NextToken` response in the previous request.
|
1361
|
+
# If you did, it indicates that more output is available. Set this
|
1362
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1363
|
+
# response to request the next page of results.
|
1020
1364
|
#
|
1021
1365
|
# @option params [Integer] :max_results
|
1022
|
-
#
|
1023
|
-
#
|
1024
|
-
#
|
1366
|
+
# Specifies the total number of results that you want included on each
|
1367
|
+
# page of the response. If you do not include this parameter, it
|
1368
|
+
# defaults to a value that is specific to the operation. If additional
|
1369
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1370
|
+
# element is returned with a value (not null). Include the specified
|
1371
|
+
# value as the `NextToken` request parameter in the next call to the
|
1372
|
+
# operation to get the next part of the results. Note that the service
|
1373
|
+
# might return fewer results than the maximum even when there are more
|
1374
|
+
# results available. You should check `NextToken` after every operation
|
1375
|
+
# to ensure that you receive all of the results.
|
1025
1376
|
#
|
1026
1377
|
# @option params [String] :permission_arn
|
1027
|
-
#
|
1028
|
-
#
|
1378
|
+
# Specifies that you want to retrieve details of only those resource
|
1379
|
+
# shares that use the RAM permission with this [Amazon Resoure Name
|
1380
|
+
# (ARN)][1].
|
1381
|
+
#
|
1382
|
+
#
|
1383
|
+
#
|
1384
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1029
1385
|
#
|
1030
1386
|
# @return [Types::GetResourceSharesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1031
1387
|
#
|
@@ -1079,18 +1435,51 @@ module Aws::RAM
|
|
1079
1435
|
end
|
1080
1436
|
|
1081
1437
|
# Lists the resources in a resource share that is shared with you but
|
1082
|
-
#
|
1438
|
+
# for which the invitation is still `PENDING`. That means that you
|
1439
|
+
# haven't accepted or rejected the invitation and the invitation
|
1440
|
+
# hasn't expired.
|
1083
1441
|
#
|
1084
1442
|
# @option params [required, String] :resource_share_invitation_arn
|
1085
|
-
#
|
1443
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the invitation. You
|
1444
|
+
# can use GetResourceShareInvitations to find the ARN of the invitation.
|
1445
|
+
#
|
1446
|
+
#
|
1447
|
+
#
|
1448
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1086
1449
|
#
|
1087
1450
|
# @option params [String] :next_token
|
1088
|
-
#
|
1451
|
+
# Specifies that you want to receive the next page of results. Valid
|
1452
|
+
# only if you received a `NextToken` response in the previous request.
|
1453
|
+
# If you did, it indicates that more output is available. Set this
|
1454
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1455
|
+
# response to request the next page of results.
|
1089
1456
|
#
|
1090
1457
|
# @option params [Integer] :max_results
|
1091
|
-
#
|
1092
|
-
#
|
1093
|
-
#
|
1458
|
+
# Specifies the total number of results that you want included on each
|
1459
|
+
# page of the response. If you do not include this parameter, it
|
1460
|
+
# defaults to a value that is specific to the operation. If additional
|
1461
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1462
|
+
# element is returned with a value (not null). Include the specified
|
1463
|
+
# value as the `NextToken` request parameter in the next call to the
|
1464
|
+
# operation to get the next part of the results. Note that the service
|
1465
|
+
# might return fewer results than the maximum even when there are more
|
1466
|
+
# results available. You should check `NextToken` after every operation
|
1467
|
+
# to ensure that you receive all of the results.
|
1468
|
+
#
|
1469
|
+
# @option params [String] :resource_region_scope
|
1470
|
+
# Specifies that you want the results to include only resources that
|
1471
|
+
# have the specified scope.
|
1472
|
+
#
|
1473
|
+
# * `ALL` – the results include both global and regional resources or
|
1474
|
+
# resource types.
|
1475
|
+
#
|
1476
|
+
# * `GLOBAL` – the results include only global resources or resource
|
1477
|
+
# types.
|
1478
|
+
#
|
1479
|
+
# * `REGIONAL` – the results include only regional resources or resource
|
1480
|
+
# types.
|
1481
|
+
#
|
1482
|
+
# The default value is `ALL`.
|
1094
1483
|
#
|
1095
1484
|
# @return [Types::ListPendingInvitationResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1096
1485
|
#
|
@@ -1105,6 +1494,7 @@ module Aws::RAM
|
|
1105
1494
|
# resource_share_invitation_arn: "String", # required
|
1106
1495
|
# next_token: "String",
|
1107
1496
|
# max_results: 1,
|
1497
|
+
# resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
|
1108
1498
|
# })
|
1109
1499
|
#
|
1110
1500
|
# @example Response structure
|
@@ -1118,6 +1508,7 @@ module Aws::RAM
|
|
1118
1508
|
# resp.resources[0].status_message #=> String
|
1119
1509
|
# resp.resources[0].creation_time #=> Time
|
1120
1510
|
# resp.resources[0].last_updated_time #=> Time
|
1511
|
+
# resp.resources[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
|
1121
1512
|
# resp.next_token #=> String
|
1122
1513
|
#
|
1123
1514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPendingInvitationResources AWS API Documentation
|
@@ -1129,20 +1520,102 @@ module Aws::RAM
|
|
1129
1520
|
req.send_request(options)
|
1130
1521
|
end
|
1131
1522
|
|
1132
|
-
# Lists the RAM
|
1523
|
+
# Lists the available versions of the specified RAM permission.
|
1524
|
+
#
|
1525
|
+
# @option params [required, String] :permission_arn
|
1526
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the RAM permission
|
1527
|
+
# whose versions you want to list. You can use the `permissionVersion`
|
1528
|
+
# parameter on the AssociateResourceSharePermission operation to specify
|
1529
|
+
# a non-default version to attach.
|
1530
|
+
#
|
1531
|
+
#
|
1532
|
+
#
|
1533
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1534
|
+
#
|
1535
|
+
# @option params [String] :next_token
|
1536
|
+
# Specifies that you want to receive the next page of results. Valid
|
1537
|
+
# only if you received a `NextToken` response in the previous request.
|
1538
|
+
# If you did, it indicates that more output is available. Set this
|
1539
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1540
|
+
# response to request the next page of results.
|
1541
|
+
#
|
1542
|
+
# @option params [Integer] :max_results
|
1543
|
+
# Specifies the total number of results that you want included on each
|
1544
|
+
# page of the response. If you do not include this parameter, it
|
1545
|
+
# defaults to a value that is specific to the operation. If additional
|
1546
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1547
|
+
# element is returned with a value (not null). Include the specified
|
1548
|
+
# value as the `NextToken` request parameter in the next call to the
|
1549
|
+
# operation to get the next part of the results. Note that the service
|
1550
|
+
# might return fewer results than the maximum even when there are more
|
1551
|
+
# results available. You should check `NextToken` after every operation
|
1552
|
+
# to ensure that you receive all of the results.
|
1553
|
+
#
|
1554
|
+
# @return [Types::ListPermissionVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1555
|
+
#
|
1556
|
+
# * {Types::ListPermissionVersionsResponse#permissions #permissions} => Array<Types::ResourceSharePermissionSummary>
|
1557
|
+
# * {Types::ListPermissionVersionsResponse#next_token #next_token} => String
|
1558
|
+
#
|
1559
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1560
|
+
#
|
1561
|
+
# @example Request syntax with placeholder values
|
1562
|
+
#
|
1563
|
+
# resp = client.list_permission_versions({
|
1564
|
+
# permission_arn: "String", # required
|
1565
|
+
# next_token: "String",
|
1566
|
+
# max_results: 1,
|
1567
|
+
# })
|
1568
|
+
#
|
1569
|
+
# @example Response structure
|
1570
|
+
#
|
1571
|
+
# resp.permissions #=> Array
|
1572
|
+
# resp.permissions[0].arn #=> String
|
1573
|
+
# resp.permissions[0].version #=> String
|
1574
|
+
# resp.permissions[0].default_version #=> Boolean
|
1575
|
+
# resp.permissions[0].name #=> String
|
1576
|
+
# resp.permissions[0].resource_type #=> String
|
1577
|
+
# resp.permissions[0].status #=> String
|
1578
|
+
# resp.permissions[0].creation_time #=> Time
|
1579
|
+
# resp.permissions[0].last_updated_time #=> Time
|
1580
|
+
# resp.permissions[0].is_resource_type_default #=> Boolean
|
1581
|
+
# resp.next_token #=> String
|
1582
|
+
#
|
1583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissionVersions AWS API Documentation
|
1584
|
+
#
|
1585
|
+
# @overload list_permission_versions(params = {})
|
1586
|
+
# @param [Hash] params ({})
|
1587
|
+
def list_permission_versions(params = {}, options = {})
|
1588
|
+
req = build_request(:list_permission_versions, params)
|
1589
|
+
req.send_request(options)
|
1590
|
+
end
|
1591
|
+
|
1592
|
+
# Retrieves a list of available RAM permissions that you can use for the
|
1593
|
+
# supported resource types.
|
1133
1594
|
#
|
1134
1595
|
# @option params [String] :resource_type
|
1135
|
-
# Specifies
|
1136
|
-
# example, to list only permissions that apply to EC2
|
1137
|
-
# `ec2:Subnet`.
|
1596
|
+
# Specifies that you want to list permissions for only the specified
|
1597
|
+
# resource type. For example, to list only permissions that apply to EC2
|
1598
|
+
# subnets, specify `ec2:Subnet`. You can use the ListResourceTypes
|
1599
|
+
# operation to get the specific string required.
|
1138
1600
|
#
|
1139
1601
|
# @option params [String] :next_token
|
1140
|
-
#
|
1602
|
+
# Specifies that you want to receive the next page of results. Valid
|
1603
|
+
# only if you received a `NextToken` response in the previous request.
|
1604
|
+
# If you did, it indicates that more output is available. Set this
|
1605
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1606
|
+
# response to request the next page of results.
|
1141
1607
|
#
|
1142
1608
|
# @option params [Integer] :max_results
|
1143
|
-
#
|
1144
|
-
#
|
1145
|
-
#
|
1609
|
+
# Specifies the total number of results that you want included on each
|
1610
|
+
# page of the response. If you do not include this parameter, it
|
1611
|
+
# defaults to a value that is specific to the operation. If additional
|
1612
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1613
|
+
# element is returned with a value (not null). Include the specified
|
1614
|
+
# value as the `NextToken` request parameter in the next call to the
|
1615
|
+
# operation to get the next part of the results. Note that the service
|
1616
|
+
# might return fewer results than the maximum even when there are more
|
1617
|
+
# results available. You should check `NextToken` after every operation
|
1618
|
+
# to ensure that you receive all of the results.
|
1146
1619
|
#
|
1147
1620
|
# @return [Types::ListPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1148
1621
|
#
|
@@ -1182,49 +1655,91 @@ module Aws::RAM
|
|
1182
1655
|
req.send_request(options)
|
1183
1656
|
end
|
1184
1657
|
|
1185
|
-
# Lists the principals that you
|
1186
|
-
#
|
1658
|
+
# Lists the principals that you are sharing resources with or that are
|
1659
|
+
# sharing resources with you.
|
1187
1660
|
#
|
1188
1661
|
# @option params [required, String] :resource_owner
|
1189
|
-
#
|
1662
|
+
# Specifies that you want to list information for only resource shares
|
1663
|
+
# that match the following:
|
1664
|
+
#
|
1665
|
+
# * <b> <code>SELF</code> </b> – resources that you are sharing
|
1666
|
+
#
|
1667
|
+
# * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts
|
1668
|
+
# share with you
|
1190
1669
|
#
|
1191
1670
|
# @option params [String] :resource_arn
|
1192
|
-
#
|
1671
|
+
# Specifies that you want to list principal information for the resource
|
1672
|
+
# share with the specified [Amazon Resoure Name (ARN)][1].
|
1673
|
+
#
|
1674
|
+
#
|
1675
|
+
#
|
1676
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1193
1677
|
#
|
1194
1678
|
# @option params [Array<String>] :principals
|
1195
|
-
#
|
1679
|
+
# Specifies that you want to list information for only the listed
|
1680
|
+
# principals.
|
1681
|
+
#
|
1682
|
+
# You can include the following values:
|
1683
|
+
#
|
1684
|
+
# * An Amazon Web Services account ID, for example: `123456789012`
|
1685
|
+
#
|
1686
|
+
# * An [Amazon Resoure Name (ARN)][1] of an organization in
|
1687
|
+
# Organizations, for example:
|
1688
|
+
# `organizations::123456789012:organization/o-exampleorgid`
|
1689
|
+
#
|
1690
|
+
# * An ARN of an organizational unit (OU) in Organizations, for example:
|
1691
|
+
# `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
|
1692
|
+
#
|
1693
|
+
# * An ARN of an IAM role, for example:
|
1694
|
+
# `iam::123456789012:role/rolename`
|
1695
|
+
#
|
1696
|
+
# * An ARN of an IAM user, for example: `iam::123456789012user/username`
|
1697
|
+
#
|
1698
|
+
# <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
|
1699
|
+
# more information, see [Sharing with IAM roles and users][2] in the
|
1700
|
+
# *Resource Access Manager User Guide*.
|
1701
|
+
#
|
1702
|
+
# </note>
|
1703
|
+
#
|
1704
|
+
#
|
1705
|
+
#
|
1706
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1707
|
+
# [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
|
1196
1708
|
#
|
1197
1709
|
# @option params [String] :resource_type
|
1198
|
-
#
|
1199
|
-
#
|
1200
|
-
#
|
1201
|
-
#
|
1202
|
-
#
|
1203
|
-
# `ec2:LocalGatewayRouteTable` \| `ec2:PrefixList` \| `ec2:Subnet` \|
|
1204
|
-
# `ec2:TrafficMirrorTarget` \| `ec2:TransitGateway` \|
|
1205
|
-
# `imagebuilder:Component` \| `imagebuilder:Image` \|
|
1206
|
-
# `imagebuilder:ImageRecipe` \| `imagebuilder:ContainerRecipe` \|
|
1207
|
-
# `glue:Catalog` \| `glue:Database` \| `glue:Table` \|
|
1208
|
-
# `license-manager:LicenseConfiguration` I
|
1209
|
-
# `network-firewall:FirewallPolicy` \|
|
1210
|
-
# `network-firewall:StatefulRuleGroup` \|
|
1211
|
-
# `network-firewall:StatelessRuleGroup` \| `outposts:Outpost` \|
|
1212
|
-
# `resource-groups:Group` \| `rds:Cluster` \|
|
1213
|
-
# `route53resolver:FirewallRuleGroup`
|
1214
|
-
# \|`route53resolver:ResolverQueryLogConfig` \|
|
1215
|
-
# `route53resolver:ResolverRule` \| `s3-outposts:Outpost` \|
|
1216
|
-
# `ssm-contacts:Contact` \| `ssm-incidents:ResponsePlan`
|
1710
|
+
# Specifies that you want to list information for only principals
|
1711
|
+
# associated with resource shares that include the specified resource
|
1712
|
+
# type.
|
1713
|
+
#
|
1714
|
+
# For a list of valid values, query the ListResourceTypes operation.
|
1217
1715
|
#
|
1218
1716
|
# @option params [Array<String>] :resource_share_arns
|
1219
|
-
#
|
1717
|
+
# Specifies that you want to list information for only principals
|
1718
|
+
# associated with the resource shares specified by a list the [Amazon
|
1719
|
+
# Resource Names (ARNs)][1].
|
1720
|
+
#
|
1721
|
+
#
|
1722
|
+
#
|
1723
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1220
1724
|
#
|
1221
1725
|
# @option params [String] :next_token
|
1222
|
-
#
|
1726
|
+
# Specifies that you want to receive the next page of results. Valid
|
1727
|
+
# only if you received a `NextToken` response in the previous request.
|
1728
|
+
# If you did, it indicates that more output is available. Set this
|
1729
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1730
|
+
# response to request the next page of results.
|
1223
1731
|
#
|
1224
1732
|
# @option params [Integer] :max_results
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1733
|
+
# Specifies the total number of results that you want included on each
|
1734
|
+
# page of the response. If you do not include this parameter, it
|
1735
|
+
# defaults to a value that is specific to the operation. If additional
|
1736
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1737
|
+
# element is returned with a value (not null). Include the specified
|
1738
|
+
# value as the `NextToken` request parameter in the next call to the
|
1739
|
+
# operation to get the next part of the results. Note that the service
|
1740
|
+
# might return fewer results than the maximum even when there are more
|
1741
|
+
# results available. You should check `NextToken` after every operation
|
1742
|
+
# to ensure that you receive all of the results.
|
1228
1743
|
#
|
1229
1744
|
# @return [Types::ListPrincipalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1230
1745
|
#
|
@@ -1267,15 +1782,31 @@ module Aws::RAM
|
|
1267
1782
|
# Lists the RAM permissions that are associated with a resource share.
|
1268
1783
|
#
|
1269
1784
|
# @option params [required, String] :resource_share_arn
|
1270
|
-
#
|
1785
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource share for
|
1786
|
+
# which you want to retrieve the associated permissions.
|
1787
|
+
#
|
1788
|
+
#
|
1789
|
+
#
|
1790
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1271
1791
|
#
|
1272
1792
|
# @option params [String] :next_token
|
1273
|
-
#
|
1793
|
+
# Specifies that you want to receive the next page of results. Valid
|
1794
|
+
# only if you received a `NextToken` response in the previous request.
|
1795
|
+
# If you did, it indicates that more output is available. Set this
|
1796
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1797
|
+
# response to request the next page of results.
|
1274
1798
|
#
|
1275
1799
|
# @option params [Integer] :max_results
|
1276
|
-
#
|
1277
|
-
#
|
1278
|
-
#
|
1800
|
+
# Specifies the total number of results that you want included on each
|
1801
|
+
# page of the response. If you do not include this parameter, it
|
1802
|
+
# defaults to a value that is specific to the operation. If additional
|
1803
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1804
|
+
# element is returned with a value (not null). Include the specified
|
1805
|
+
# value as the `NextToken` request parameter in the next call to the
|
1806
|
+
# operation to get the next part of the results. Note that the service
|
1807
|
+
# might return fewer results than the maximum even when there are more
|
1808
|
+
# results available. You should check `NextToken` after every operation
|
1809
|
+
# to ensure that you receive all of the results.
|
1279
1810
|
#
|
1280
1811
|
# @return [Types::ListResourceSharePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1281
1812
|
#
|
@@ -1315,15 +1846,41 @@ module Aws::RAM
|
|
1315
1846
|
req.send_request(options)
|
1316
1847
|
end
|
1317
1848
|
|
1318
|
-
# Lists the
|
1849
|
+
# Lists the resource types that can be shared by RAM.
|
1319
1850
|
#
|
1320
1851
|
# @option params [String] :next_token
|
1321
|
-
#
|
1852
|
+
# Specifies that you want to receive the next page of results. Valid
|
1853
|
+
# only if you received a `NextToken` response in the previous request.
|
1854
|
+
# If you did, it indicates that more output is available. Set this
|
1855
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1856
|
+
# response to request the next page of results.
|
1322
1857
|
#
|
1323
1858
|
# @option params [Integer] :max_results
|
1324
|
-
#
|
1325
|
-
#
|
1326
|
-
#
|
1859
|
+
# Specifies the total number of results that you want included on each
|
1860
|
+
# page of the response. If you do not include this parameter, it
|
1861
|
+
# defaults to a value that is specific to the operation. If additional
|
1862
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1863
|
+
# element is returned with a value (not null). Include the specified
|
1864
|
+
# value as the `NextToken` request parameter in the next call to the
|
1865
|
+
# operation to get the next part of the results. Note that the service
|
1866
|
+
# might return fewer results than the maximum even when there are more
|
1867
|
+
# results available. You should check `NextToken` after every operation
|
1868
|
+
# to ensure that you receive all of the results.
|
1869
|
+
#
|
1870
|
+
# @option params [String] :resource_region_scope
|
1871
|
+
# Specifies that you want the results to include only resources that
|
1872
|
+
# have the specified scope.
|
1873
|
+
#
|
1874
|
+
# * `ALL` – the results include both global and regional resources or
|
1875
|
+
# resource types.
|
1876
|
+
#
|
1877
|
+
# * `GLOBAL` – the results include only global resources or resource
|
1878
|
+
# types.
|
1879
|
+
#
|
1880
|
+
# * `REGIONAL` – the results include only regional resources or resource
|
1881
|
+
# types.
|
1882
|
+
#
|
1883
|
+
# The default value is `ALL`.
|
1327
1884
|
#
|
1328
1885
|
# @return [Types::ListResourceTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1329
1886
|
#
|
@@ -1337,6 +1894,7 @@ module Aws::RAM
|
|
1337
1894
|
# resp = client.list_resource_types({
|
1338
1895
|
# next_token: "String",
|
1339
1896
|
# max_results: 1,
|
1897
|
+
# resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
|
1340
1898
|
# })
|
1341
1899
|
#
|
1342
1900
|
# @example Response structure
|
@@ -1344,6 +1902,7 @@ module Aws::RAM
|
|
1344
1902
|
# resp.resource_types #=> Array
|
1345
1903
|
# resp.resource_types[0].resource_type #=> String
|
1346
1904
|
# resp.resource_types[0].service_name #=> String
|
1905
|
+
# resp.resource_types[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
|
1347
1906
|
# resp.next_token #=> String
|
1348
1907
|
#
|
1349
1908
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypes AWS API Documentation
|
@@ -1359,45 +1918,73 @@ module Aws::RAM
|
|
1359
1918
|
# resources that are shared with you.
|
1360
1919
|
#
|
1361
1920
|
# @option params [required, String] :resource_owner
|
1362
|
-
#
|
1921
|
+
# Specifies that you want to list only the resource shares that match
|
1922
|
+
# the following:
|
1923
|
+
#
|
1924
|
+
# * <b> <code>SELF</code> </b> – resources that you are sharing
|
1925
|
+
#
|
1926
|
+
# * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts
|
1927
|
+
# share with you
|
1363
1928
|
#
|
1364
1929
|
# @option params [String] :principal
|
1365
|
-
#
|
1930
|
+
# Specifies that you want to list only the resource shares that are
|
1931
|
+
# associated with the specified principal.
|
1366
1932
|
#
|
1367
1933
|
# @option params [String] :resource_type
|
1368
|
-
#
|
1369
|
-
#
|
1370
|
-
#
|
1371
|
-
#
|
1372
|
-
# `ec2:CapacityReservation` \| `ec2:DedicatedHost` \|
|
1373
|
-
# `ec2:LocalGatewayRouteTable` \| `ec2:PrefixList` \| `ec2:Subnet` \|
|
1374
|
-
# `ec2:TrafficMirrorTarget` \| `ec2:TransitGateway` \|
|
1375
|
-
# `imagebuilder:Component` \| `imagebuilder:Image` \|
|
1376
|
-
# `imagebuilder:ImageRecipe` \| `imagebuilder:ContainerRecipe` \|
|
1377
|
-
# `glue:Catalog` \| `glue:Database` \| `glue:Table` \|
|
1378
|
-
# `license-manager:LicenseConfiguration` I
|
1379
|
-
# `network-firewall:FirewallPolicy` \|
|
1380
|
-
# `network-firewall:StatefulRuleGroup` \|
|
1381
|
-
# `network-firewall:StatelessRuleGroup` \| `outposts:Outpost` \|
|
1382
|
-
# `resource-groups:Group` \| `rds:Cluster` \|
|
1383
|
-
# `route53resolver:FirewallRuleGroup`
|
1384
|
-
# \|`route53resolver:ResolverQueryLogConfig` \|
|
1385
|
-
# `route53resolver:ResolverRule` \| `s3-outposts:Outpost` \|
|
1386
|
-
# `ssm-contacts:Contact` \| `ssm-incidents:ResponsePlan`
|
1934
|
+
# Specifies that you want to list only the resource shares that include
|
1935
|
+
# resources of the specified resource type.
|
1936
|
+
#
|
1937
|
+
# For valid values, query the ListResourceTypes operation.
|
1387
1938
|
#
|
1388
1939
|
# @option params [Array<String>] :resource_arns
|
1389
|
-
#
|
1940
|
+
# Specifies that you want to list only the resource shares that include
|
1941
|
+
# resources with the specified [Amazon Resource Names (ARNs)][1].
|
1942
|
+
#
|
1943
|
+
#
|
1944
|
+
#
|
1945
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1390
1946
|
#
|
1391
1947
|
# @option params [Array<String>] :resource_share_arns
|
1392
|
-
#
|
1948
|
+
# Specifies that you want to list only resources in the resource shares
|
1949
|
+
# identified by the specified [Amazon Resource Names (ARNs)][1].
|
1950
|
+
#
|
1951
|
+
#
|
1952
|
+
#
|
1953
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1393
1954
|
#
|
1394
1955
|
# @option params [String] :next_token
|
1395
|
-
#
|
1956
|
+
# Specifies that you want to receive the next page of results. Valid
|
1957
|
+
# only if you received a `NextToken` response in the previous request.
|
1958
|
+
# If you did, it indicates that more output is available. Set this
|
1959
|
+
# parameter to the value provided by the previous call's `NextToken`
|
1960
|
+
# response to request the next page of results.
|
1396
1961
|
#
|
1397
1962
|
# @option params [Integer] :max_results
|
1398
|
-
#
|
1399
|
-
#
|
1400
|
-
#
|
1963
|
+
# Specifies the total number of results that you want included on each
|
1964
|
+
# page of the response. If you do not include this parameter, it
|
1965
|
+
# defaults to a value that is specific to the operation. If additional
|
1966
|
+
# items exist beyond the number you specify, the `NextToken` response
|
1967
|
+
# element is returned with a value (not null). Include the specified
|
1968
|
+
# value as the `NextToken` request parameter in the next call to the
|
1969
|
+
# operation to get the next part of the results. Note that the service
|
1970
|
+
# might return fewer results than the maximum even when there are more
|
1971
|
+
# results available. You should check `NextToken` after every operation
|
1972
|
+
# to ensure that you receive all of the results.
|
1973
|
+
#
|
1974
|
+
# @option params [String] :resource_region_scope
|
1975
|
+
# Specifies that you want the results to include only resources that
|
1976
|
+
# have the specified scope.
|
1977
|
+
#
|
1978
|
+
# * `ALL` – the results include both global and regional resources or
|
1979
|
+
# resource types.
|
1980
|
+
#
|
1981
|
+
# * `GLOBAL` – the results include only global resources or resource
|
1982
|
+
# types.
|
1983
|
+
#
|
1984
|
+
# * `REGIONAL` – the results include only regional resources or resource
|
1985
|
+
# types.
|
1986
|
+
#
|
1987
|
+
# The default value is `ALL`.
|
1401
1988
|
#
|
1402
1989
|
# @return [Types::ListResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1403
1990
|
#
|
@@ -1416,6 +2003,7 @@ module Aws::RAM
|
|
1416
2003
|
# resource_share_arns: ["String"],
|
1417
2004
|
# next_token: "String",
|
1418
2005
|
# max_results: 1,
|
2006
|
+
# resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
|
1419
2007
|
# })
|
1420
2008
|
#
|
1421
2009
|
# @example Response structure
|
@@ -1429,6 +2017,7 @@ module Aws::RAM
|
|
1429
2017
|
# resp.resources[0].status_message #=> String
|
1430
2018
|
# resp.resources[0].creation_time #=> Time
|
1431
2019
|
# resp.resources[0].last_updated_time #=> Time
|
2020
|
+
# resp.resources[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
|
1432
2021
|
# resp.next_token #=> String
|
1433
2022
|
#
|
1434
2023
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResources AWS API Documentation
|
@@ -1440,19 +2029,23 @@ module Aws::RAM
|
|
1440
2029
|
req.send_request(options)
|
1441
2030
|
end
|
1442
2031
|
|
1443
|
-
#
|
1444
|
-
#
|
1445
|
-
#
|
2032
|
+
# When you attach a resource-based permission policy to a resource, it
|
2033
|
+
# automatically creates a resource share. However, resource shares
|
2034
|
+
# created this way are visible only to the resource share owner, and the
|
2035
|
+
# resource share can't be modified in RAM.
|
1446
2036
|
#
|
1447
|
-
#
|
1448
|
-
#
|
2037
|
+
# You can use this operation to promote the resource share to a full RAM
|
2038
|
+
# resource share. When you promote a resource share, you can then manage
|
2039
|
+
# the resource share in RAM and it becomes visible to all of the
|
2040
|
+
# principals you shared it with.
|
1449
2041
|
#
|
1450
|
-
#
|
2042
|
+
# @option params [required, String] :resource_share_arn
|
2043
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource share to
|
2044
|
+
# promote.
|
1451
2045
|
#
|
1452
|
-
# * Modifiable in RAM.
|
1453
2046
|
#
|
1454
|
-
#
|
1455
|
-
#
|
2047
|
+
#
|
2048
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1456
2049
|
#
|
1457
2050
|
# @return [Types::PromoteResourceShareCreatedFromPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1458
2051
|
#
|
@@ -1481,11 +2074,27 @@ module Aws::RAM
|
|
1481
2074
|
# Services account.
|
1482
2075
|
#
|
1483
2076
|
# @option params [required, String] :resource_share_invitation_arn
|
1484
|
-
#
|
2077
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the invitation that
|
2078
|
+
# you want to reject.
|
2079
|
+
#
|
2080
|
+
#
|
2081
|
+
#
|
2082
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1485
2083
|
#
|
1486
2084
|
# @option params [String] :client_token
|
1487
|
-
#
|
1488
|
-
# idempotency of the request.
|
2085
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
2086
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
2087
|
+
# request without accidentally performing the same operation a second
|
2088
|
+
# time. Passing the same value to a later call to an operation requires
|
2089
|
+
# that you also pass the same value for all other parameters. We
|
2090
|
+
# recommend that you use a [UUID type of value.][1].
|
2091
|
+
#
|
2092
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
2093
|
+
# random one for you.
|
2094
|
+
#
|
2095
|
+
#
|
2096
|
+
#
|
2097
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
1489
2098
|
#
|
1490
2099
|
# @return [Types::RejectResourceShareInvitationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1491
2100
|
#
|
@@ -1530,13 +2139,22 @@ module Aws::RAM
|
|
1530
2139
|
req.send_request(options)
|
1531
2140
|
end
|
1532
2141
|
|
1533
|
-
# Adds the specified
|
2142
|
+
# Adds the specified tag keys and values to the specified resource
|
2143
|
+
# share. The tags are attached only to the resource share, not to the
|
2144
|
+
# resources that are in the resource share.
|
1534
2145
|
#
|
1535
2146
|
# @option params [required, String] :resource_share_arn
|
1536
|
-
#
|
2147
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
|
2148
|
+
# that you want to add tags to.
|
2149
|
+
#
|
2150
|
+
#
|
2151
|
+
#
|
2152
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1537
2153
|
#
|
1538
2154
|
# @option params [required, Array<Types::Tag>] :tags
|
1539
|
-
#
|
2155
|
+
# A list of one or more tag key and value pairs. The tag key must be
|
2156
|
+
# present and not be an empty string. The tag value must be present but
|
2157
|
+
# can be an empty string.
|
1540
2158
|
#
|
1541
2159
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1542
2160
|
#
|
@@ -1561,14 +2179,20 @@ module Aws::RAM
|
|
1561
2179
|
req.send_request(options)
|
1562
2180
|
end
|
1563
2181
|
|
1564
|
-
# Removes the specified
|
1565
|
-
#
|
2182
|
+
# Removes the specified tag key and value pairs from the specified
|
2183
|
+
# resource share.
|
1566
2184
|
#
|
1567
2185
|
# @option params [required, String] :resource_share_arn
|
1568
|
-
#
|
2186
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
|
2187
|
+
# that you want to remove tags from. The tags are removed from the
|
2188
|
+
# resource share, not the resources in the resource share.
|
2189
|
+
#
|
2190
|
+
#
|
2191
|
+
#
|
2192
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1569
2193
|
#
|
1570
2194
|
# @option params [required, Array<String>] :tag_keys
|
1571
|
-
#
|
2195
|
+
# Specifies a list of one or more tag keys that you want to remove.
|
1572
2196
|
#
|
1573
2197
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1574
2198
|
#
|
@@ -1588,21 +2212,38 @@ module Aws::RAM
|
|
1588
2212
|
req.send_request(options)
|
1589
2213
|
end
|
1590
2214
|
|
1591
|
-
#
|
2215
|
+
# Modifies some of the properties of the specified resource share.
|
1592
2216
|
#
|
1593
2217
|
# @option params [required, String] :resource_share_arn
|
1594
|
-
#
|
2218
|
+
# Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
|
2219
|
+
# that you want to modify.
|
2220
|
+
#
|
2221
|
+
#
|
2222
|
+
#
|
2223
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1595
2224
|
#
|
1596
2225
|
# @option params [String] :name
|
1597
|
-
#
|
2226
|
+
# If specified, the new name that you want to attach to the resource
|
2227
|
+
# share.
|
1598
2228
|
#
|
1599
2229
|
# @option params [Boolean] :allow_external_principals
|
1600
|
-
#
|
2230
|
+
# Specifies whether principals outside your organization in
|
1601
2231
|
# Organizations can be associated with a resource share.
|
1602
2232
|
#
|
1603
2233
|
# @option params [String] :client_token
|
1604
|
-
#
|
1605
|
-
# idempotency of the request.
|
2234
|
+
# Specifies a unique, case-sensitive identifier that you provide to
|
2235
|
+
# ensure the idempotency of the request. This lets you safely retry the
|
2236
|
+
# request without accidentally performing the same operation a second
|
2237
|
+
# time. Passing the same value to a later call to an operation requires
|
2238
|
+
# that you also pass the same value for all other parameters. We
|
2239
|
+
# recommend that you use a [UUID type of value.][1].
|
2240
|
+
#
|
2241
|
+
# If you don't provide this value, then Amazon Web Services generates a
|
2242
|
+
# random one for you.
|
2243
|
+
#
|
2244
|
+
#
|
2245
|
+
#
|
2246
|
+
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
1606
2247
|
#
|
1607
2248
|
# @return [Types::UpdateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1608
2249
|
#
|
@@ -1656,7 +2297,7 @@ module Aws::RAM
|
|
1656
2297
|
params: params,
|
1657
2298
|
config: config)
|
1658
2299
|
context[:gem_name] = 'aws-sdk-ram'
|
1659
|
-
context[:gem_version] = '1.
|
2300
|
+
context[:gem_version] = '1.37.0'
|
1660
2301
|
Seahorse::Client::Request.new(handlers, context)
|
1661
2302
|
end
|
1662
2303
|
|