aws-sdk-ram 1.33.0 → 1.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -339,14 +339,32 @@ module Aws::RAM
339
339
  # @!group API Operations
340
340
 
341
341
  # Accepts an invitation to a resource share from another Amazon Web
342
- # Services account.
342
+ # Services account. After you accept the invitation, the resources
343
+ # included in the resource share are available to interact with in the
344
+ # relevant Amazon Web Services Management Consoles and tools.
343
345
  #
344
346
  # @option params [required, String] :resource_share_invitation_arn
345
- # The Amazon Resource Name (ARN) of the invitation.
347
+ # The [Amazon Resoure Name (ARN)][1] of the invitation that you want to
348
+ # accept.
349
+ #
350
+ #
351
+ #
352
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
346
353
  #
347
354
  # @option params [String] :client_token
348
- # A unique, case-sensitive identifier that you provide to ensure the
349
- # idempotency of the request.
355
+ # Specifies a unique, case-sensitive identifier that you provide to
356
+ # ensure the idempotency of the request. This lets you safely retry the
357
+ # request without accidentally performing the same operation a second
358
+ # time. Passing the same value to a later call to an operation requires
359
+ # that you also pass the same value for all other parameters. We
360
+ # recommend that you use a [UUID type of value.][1].
361
+ #
362
+ # If you don't provide this value, then Amazon Web Services generates a
363
+ # random one for you.
364
+ #
365
+ #
366
+ #
367
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
350
368
  #
351
369
  # @return [Types::AcceptResourceShareInvitationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
352
370
  #
@@ -391,42 +409,78 @@ module Aws::RAM
391
409
  req.send_request(options)
392
410
  end
393
411
 
394
- # Associates the specified resource share with the specified principals
395
- # and resources.
412
+ # Adds the specified list of principals and list of resources to a
413
+ # resource share. Principals that already have access to this resource
414
+ # share immediately receive access to the added resources. Newly added
415
+ # principals immediately receive access to the resources shared in this
416
+ # resource share.
396
417
  #
397
418
  # @option params [required, String] :resource_share_arn
398
- # The Amazon Resource Name (ARN) of the resource share.
419
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
420
+ # that you want to add principals or resources to.
421
+ #
422
+ #
423
+ #
424
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
399
425
  #
400
426
  # @option params [Array<String>] :resource_arns
401
- # The Amazon Resource Names (ARNs) of the resources.
427
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] of the resources
428
+ # that you want to share. This can be `null` if you want to add only
429
+ # principals.
430
+ #
431
+ #
432
+ #
433
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
402
434
  #
403
435
  # @option params [Array<String>] :principals
404
- # The principals to associate with the resource share. The possible
405
- # values are:
436
+ # Specifies a list of principals to whom you want to the resource share.
437
+ # This can be `null` if you want to add only resources.
438
+ #
439
+ # What the principals can do with the resources in the share is
440
+ # determined by the RAM permissions that you associate with the resource
441
+ # share. See AssociateResourceSharePermission.
406
442
  #
407
- # * An Amazon Web Services account ID
443
+ # You can include the following values:
408
444
  #
409
- # * An Amazon Resource Name (ARN) of an organization in Organizations
445
+ # * An Amazon Web Services account ID, for example: `123456789012`
410
446
  #
411
- # * An ARN of an organizational unit (OU) in Organizations
447
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
448
+ # Organizations, for example:
449
+ # `organizations::123456789012:organization/o-exampleorgid`
412
450
  #
413
- # * An ARN of an IAM role
451
+ # * An ARN of an organizational unit (OU) in Organizations, for example:
452
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
414
453
  #
415
- # * An ARN of an IAM user
454
+ # * An ARN of an IAM role, for example:
455
+ # `iam::123456789012:role/rolename`
416
456
  #
417
- # <note markdown="1"> Not all resource types can be shared with IAM roles and IAM users. For
418
- # more information, see [Sharing with IAM roles and IAM users][1] in the
457
+ # * An ARN of an IAM user, for example: `iam::123456789012user/username`
458
+ #
459
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
460
+ # more information, see [Sharing with IAM roles and users][2] in the
419
461
  # *Resource Access Manager User Guide*.
420
462
  #
421
463
  # </note>
422
464
  #
423
465
  #
424
466
  #
425
- # [1]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
467
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
468
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
426
469
  #
427
470
  # @option params [String] :client_token
428
- # A unique, case-sensitive identifier that you provide to ensure the
429
- # idempotency of the request.
471
+ # Specifies a unique, case-sensitive identifier that you provide to
472
+ # ensure the idempotency of the request. This lets you safely retry the
473
+ # request without accidentally performing the same operation a second
474
+ # time. Passing the same value to a later call to an operation requires
475
+ # that you also pass the same value for all other parameters. We
476
+ # recommend that you use a [UUID type of value.][1].
477
+ #
478
+ # If you don't provide this value, then Amazon Web Services generates a
479
+ # random one for you.
480
+ #
481
+ #
482
+ #
483
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
430
484
  #
431
485
  # @return [Types::AssociateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
432
486
  #
@@ -465,28 +519,64 @@ module Aws::RAM
465
519
  req.send_request(options)
466
520
  end
467
521
 
468
- # Associates a permission with a resource share.
522
+ # Adds or replaces the RAM permission for a resource type included in a
523
+ # resource share. You can have exactly one permission associated with
524
+ # each resource type in the resource share. You can add a new RAM
525
+ # permission only if there are currently no resources of that resource
526
+ # type currently in the resource share.
469
527
  #
470
528
  # @option params [required, String] :resource_share_arn
471
- # The Amazon Resource Name (ARN) of the resource share.
529
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share to
530
+ # which you want to add or replace permissions.
531
+ #
532
+ #
533
+ #
534
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
472
535
  #
473
536
  # @option params [required, String] :permission_arn
474
- # The Amazon Resource Name (ARN) of the RAM permission to associate with
475
- # the resource share.
537
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the RAM permission to
538
+ # associate with the resource share. To find the ARN for a permission,
539
+ # use either the ListPermissions operation or go to the [Permissions
540
+ # library][2] page in the RAM console and then choose the name of the
541
+ # permission. The ARN is displayed on the detail page.
542
+ #
543
+ #
544
+ #
545
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
546
+ # [2]: https://console.aws.amazon.com/ram/home#Permissions:
476
547
  #
477
548
  # @option params [Boolean] :replace
478
- # Indicates whether the permission should replace the permissions that
479
- # are currently associated with the resource share. Use `true` to
480
- # replace the current permissions. Use `false` to add the permission to
481
- # the current permission.
549
+ # Specifies whether the specified permission should replace or add to
550
+ # the existing permission associated with the resource share. Use `true`
551
+ # to replace the current permissions. Use `false` to add the permission
552
+ # to the current permission. The default value is `false`.
553
+ #
554
+ # <note markdown="1"> A resource share can have only one permission per resource type. If a
555
+ # resource share already has a permission for the specified resource
556
+ # type and you don't set `replace` to `true` then the operation returns
557
+ # an error. This helps prevent accidental overwriting of a permission.
558
+ #
559
+ # </note>
482
560
  #
483
561
  # @option params [String] :client_token
484
- # A unique, case-sensitive identifier that you provide to ensure the
485
- # idempotency of the request.
562
+ # Specifies a unique, case-sensitive identifier that you provide to
563
+ # ensure the idempotency of the request. This lets you safely retry the
564
+ # request without accidentally performing the same operation a second
565
+ # time. Passing the same value to a later call to an operation requires
566
+ # that you also pass the same value for all other parameters. We
567
+ # recommend that you use a [UUID type of value.][1].
568
+ #
569
+ # If you don't provide this value, then Amazon Web Services generates a
570
+ # random one for you.
571
+ #
572
+ #
573
+ #
574
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
486
575
  #
487
576
  # @option params [Integer] :permission_version
488
- # The version of the RAM permissions to associate with the resource
489
- # share.
577
+ # Specifies the version of the RAM permission to associate with the
578
+ # resource share. If you don't specify this parameter, the operation
579
+ # uses the version designated as the default.
490
580
  #
491
581
  # @return [Types::AssociateResourceSharePermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
492
582
  #
@@ -517,10 +607,10 @@ module Aws::RAM
517
607
  req.send_request(options)
518
608
  end
519
609
 
520
- # Creates a resource share. You must provide a list of the Amazon
521
- # Resource Names (ARNs) for the resources you want to share. You must
522
- # also specify who you want to share the resources with, and the
523
- # permissions that you grant them.
610
+ # Creates a resource share. You can provide a list of the [Amazon
611
+ # Resource Names (ARNs)][1] for the resources that you want to share, a
612
+ # list of principals you want to share the resources with, and the
613
+ # permissions to grant those principals.
524
614
  #
525
615
  # <note markdown="1"> Sharing a resource makes it available for use by principals outside of
526
616
  # the Amazon Web Services account that created the resource. Sharing
@@ -529,53 +619,86 @@ module Aws::RAM
529
619
  #
530
620
  # </note>
531
621
  #
622
+ #
623
+ #
624
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
625
+ #
532
626
  # @option params [required, String] :name
533
- # The name of the resource share.
627
+ # Specifies the name of the resource share.
534
628
  #
535
629
  # @option params [Array<String>] :resource_arns
536
- # The ARNs of the resources to associate with the resource share.
630
+ # Specifies a list of one or more ARNs of the resources to associate
631
+ # with the resource share.
537
632
  #
538
633
  # @option params [Array<String>] :principals
539
- # The principals to associate with the resource share. The possible
540
- # values are:
634
+ # Specifies a list of one or more principals to associate with the
635
+ # resource share.
541
636
  #
542
- # * An Amazon Web Services account ID
637
+ # You can include the following values:
543
638
  #
544
- # * An Amazon Resource Name (ARN) of an organization in Organizations
639
+ # * An Amazon Web Services account ID, for example: `123456789012`
545
640
  #
546
- # * An ARN of an organizational unit (OU) in Organizations
641
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
642
+ # Organizations, for example:
643
+ # `organizations::123456789012:organization/o-exampleorgid`
547
644
  #
548
- # * An ARN of an IAM role
645
+ # * An ARN of an organizational unit (OU) in Organizations, for example:
646
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
549
647
  #
550
- # * An ARN of an IAM user
648
+ # * An ARN of an IAM role, for example:
649
+ # `iam::123456789012:role/rolename`
551
650
  #
552
- # <note markdown="1"> Not all resource types can be shared with IAM roles and IAM users. For
553
- # more information, see [Sharing with IAM roles and IAM users][1] in the
651
+ # * An ARN of an IAM user, for example: `iam::123456789012user/username`
652
+ #
653
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
654
+ # more information, see [Sharing with IAM roles and users][2] in the
554
655
  # *Resource Access Manager User Guide*.
555
656
  #
556
657
  # </note>
557
658
  #
558
659
  #
559
660
  #
560
- # [1]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
661
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
662
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
561
663
  #
562
664
  # @option params [Array<Types::Tag>] :tags
563
- # One or more tags.
665
+ # Specifies one or more tags to attach to the resource share itself. It
666
+ # doesn't attach the tags to the resources associated with the resource
667
+ # share.
564
668
  #
565
669
  # @option params [Boolean] :allow_external_principals
566
- # Indicates whether principals outside your organization in
567
- # Organizations can be associated with a resource share.
670
+ # Specifies whether principals outside your organization in
671
+ # Organizations can be associated with a resource share. A value of
672
+ # `true` lets you share with individual Amazon Web Services accounts
673
+ # that are *not* in your organization. A value of `false` only has
674
+ # meaning if your account is a member of an Amazon Web Services
675
+ # Organization. The default value is `true`.
568
676
  #
569
677
  # @option params [String] :client_token
570
- # A unique, case-sensitive identifier that you provide to ensure the
571
- # idempotency of the request.
678
+ # Specifies a unique, case-sensitive identifier that you provide to
679
+ # ensure the idempotency of the request. This lets you safely retry the
680
+ # request without accidentally performing the same operation a second
681
+ # time. Passing the same value to a later call to an operation requires
682
+ # that you also pass the same value for all other parameters. We
683
+ # recommend that you use a [UUID type of value.][1].
684
+ #
685
+ # If you don't provide this value, then Amazon Web Services generates a
686
+ # random one for you.
687
+ #
688
+ #
689
+ #
690
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
572
691
  #
573
692
  # @option params [Array<String>] :permission_arns
574
- # The Amazon Resource Names (ARNs) of the permissions to associate with
575
- # the resource share. If you do not specify an ARN for the permission,
576
- # RAM automatically attaches the default version of the permission for
577
- # each resource type. Only one permission can be associated with each
578
- # resource type in a resource share.
693
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the RAM permission
694
+ # to associate with the resource share. If you do not specify an ARN for
695
+ # the permission, RAM automatically attaches the default version of the
696
+ # permission for each resource type. You can associate only one
697
+ # permission with each resource type included in the resource share.
698
+ #
699
+ #
700
+ #
701
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
579
702
  #
580
703
  # @return [Types::CreateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
581
704
  #
@@ -624,14 +747,33 @@ module Aws::RAM
624
747
  req.send_request(options)
625
748
  end
626
749
 
627
- # Deletes the specified resource share.
750
+ # Deletes the specified resource share. This doesn't delete any of the
751
+ # resources that were associated with the resource share; it only stops
752
+ # the sharing of those resources outside of the Amazon Web Services
753
+ # account that created them.
628
754
  #
629
755
  # @option params [required, String] :resource_share_arn
630
- # The Amazon Resource Name (ARN) of the resource share.
756
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share to
757
+ # delete.
758
+ #
759
+ #
760
+ #
761
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
631
762
  #
632
763
  # @option params [String] :client_token
633
- # A unique, case-sensitive identifier that you provide to ensure the
634
- # idempotency of the request.
764
+ # Specifies a unique, case-sensitive identifier that you provide to
765
+ # ensure the idempotency of the request. This lets you safely retry the
766
+ # request without accidentally performing the same operation a second
767
+ # time. Passing the same value to a later call to an operation requires
768
+ # that you also pass the same value for all other parameters. We
769
+ # recommend that you use a [UUID type of value.][1].
770
+ #
771
+ # If you don't provide this value, then Amazon Web Services generates a
772
+ # random one for you.
773
+ #
774
+ #
775
+ #
776
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
635
777
  #
636
778
  # @return [Types::DeleteResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
637
779
  #
@@ -663,17 +805,68 @@ module Aws::RAM
663
805
  # resource share.
664
806
  #
665
807
  # @option params [required, String] :resource_share_arn
666
- # The Amazon Resource Name (ARN) of the resource share.
808
+ # Specifies [Amazon Resoure Name (ARN)][1] of the resource share that
809
+ # you want to remove resources from.
810
+ #
811
+ #
812
+ #
813
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
667
814
  #
668
815
  # @option params [Array<String>] :resource_arns
669
- # The Amazon Resource Names (ARNs) of the resources.
816
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] for one or more
817
+ # resources that you want to remove from the resource share. After the
818
+ # operation runs, these resources are no longer shared with principals
819
+ # outside of the Amazon Web Services account that created the resources.
820
+ #
821
+ #
822
+ #
823
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
670
824
  #
671
825
  # @option params [Array<String>] :principals
672
- # The principals.
826
+ # Specifies a list of one or more principals that no longer are to have
827
+ # access to the resources in this resource share.
828
+ #
829
+ # You can include the following values:
830
+ #
831
+ # * An Amazon Web Services account ID, for example: `123456789012`
832
+ #
833
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
834
+ # Organizations, for example:
835
+ # `organizations::123456789012:organization/o-exampleorgid`
836
+ #
837
+ # * An ARN of an organizational unit (OU) in Organizations, for example:
838
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
839
+ #
840
+ # * An ARN of an IAM role, for example:
841
+ # `iam::123456789012:role/rolename`
842
+ #
843
+ # * An ARN of an IAM user, for example: `iam::123456789012user/username`
844
+ #
845
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
846
+ # more information, see [Sharing with IAM roles and users][2] in the
847
+ # *Resource Access Manager User Guide*.
848
+ #
849
+ # </note>
850
+ #
851
+ #
852
+ #
853
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
854
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
673
855
  #
674
856
  # @option params [String] :client_token
675
- # A unique, case-sensitive identifier that you provide to ensure the
676
- # idempotency of the request.
857
+ # Specifies a unique, case-sensitive identifier that you provide to
858
+ # ensure the idempotency of the request. This lets you safely retry the
859
+ # request without accidentally performing the same operation a second
860
+ # time. Passing the same value to a later call to an operation requires
861
+ # that you also pass the same value for all other parameters. We
862
+ # recommend that you use a [UUID type of value.][1].
863
+ #
864
+ # If you don't provide this value, then Amazon Web Services generates a
865
+ # random one for you.
866
+ #
867
+ #
868
+ #
869
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
677
870
  #
678
871
  # @return [Types::DisassociateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
679
872
  #
@@ -712,18 +905,42 @@ module Aws::RAM
712
905
  req.send_request(options)
713
906
  end
714
907
 
715
- # Disassociates an RAM permission from a resource share.
908
+ # Disassociates an RAM permission from a resource share. Permission
909
+ # changes take effect immediately. You can remove a RAM permission from
910
+ # a resource share only if there are currently no resources of the
911
+ # relevant resource type currently attached to the resource share.
716
912
  #
717
913
  # @option params [required, String] :resource_share_arn
718
- # The Amazon Resource Name (ARN) of the resource share.
914
+ # The [Amazon Resoure Name (ARN)][1] of the resource share from which
915
+ # you want to disassociate a permission.
916
+ #
917
+ #
918
+ #
919
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
719
920
  #
720
921
  # @option params [required, String] :permission_arn
721
- # The Amazon Resource Name (ARN) of the permission to disassociate from
722
- # the resource share.
922
+ # The [Amazon Resoure Name (ARN)][1] of the permission to disassociate
923
+ # from the resource share. Changes to permissions take effect
924
+ # immediately.
925
+ #
926
+ #
927
+ #
928
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
723
929
  #
724
930
  # @option params [String] :client_token
725
- # A unique, case-sensitive identifier that you provide to ensure the
726
- # idempotency of the request.
931
+ # Specifies a unique, case-sensitive identifier that you provide to
932
+ # ensure the idempotency of the request. This lets you safely retry the
933
+ # request without accidentally performing the same operation a second
934
+ # time. Passing the same value to a later call to an operation requires
935
+ # that you also pass the same value for all other parameters. We
936
+ # recommend that you use a [UUID type of value.][1].
937
+ #
938
+ # If you don't provide this value, then Amazon Web Services generates a
939
+ # random one for you.
940
+ #
941
+ #
942
+ #
943
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
727
944
  #
728
945
  # @return [Types::DisassociateResourceSharePermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
729
946
  #
@@ -753,8 +970,16 @@ module Aws::RAM
753
970
  end
754
971
 
755
972
  # Enables resource sharing within your organization in Organizations.
973
+ # Calling this operation enables RAM to retrieve information about the
974
+ # organization and its structure. This lets you share resources with all
975
+ # of the accounts in an organization by specifying the organization's
976
+ # ID, or all of the accounts in an organizational unit (OU) by
977
+ # specifying the OU's ID. Until you enable sharing within the
978
+ # organization, you can specify only individual Amazon Web Services
979
+ # accounts, or for supported resource types, IAM users and roles.
756
980
  #
757
- # The caller must be the master account for the organization.
981
+ # You must call this operation from an IAM user or role in the
982
+ # organization's management account.
758
983
  #
759
984
  # @return [Types::EnableSharingWithAwsOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
760
985
  #
@@ -776,10 +1001,21 @@ module Aws::RAM
776
1001
  # Gets the contents of an RAM permission in JSON format.
777
1002
  #
778
1003
  # @option params [required, String] :permission_arn
779
- # The Amazon Resource Name (ARN) of the permission.
1004
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the permission whose
1005
+ # contents you want to retrieve. To find the ARN for a permission, use
1006
+ # either the ListPermissions operation or go to the [Permissions
1007
+ # library][2] page in the RAM console and then choose the name of the
1008
+ # permission. The ARN is displayed on the detail page.
1009
+ #
1010
+ #
1011
+ #
1012
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1013
+ # [2]: https://console.aws.amazon.com/ram/home#Permissions:
780
1014
  #
781
1015
  # @option params [Integer] :permission_version
782
- # The identifier for the version of the permission.
1016
+ # Specifies identifier for the version of the RAM permission to
1017
+ # retrieve. If you don't specify this parameter, the operation
1018
+ # retrieves the default version.
783
1019
  #
784
1020
  # @return [Types::GetPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
785
1021
  #
@@ -813,22 +1049,38 @@ module Aws::RAM
813
1049
  req.send_request(options)
814
1050
  end
815
1051
 
816
- # Gets the policies for the specified resources that you own and have
817
- # shared.
1052
+ # Retrieves the resource policies for the specified resources that you
1053
+ # own and have shared.
818
1054
  #
819
1055
  # @option params [required, Array<String>] :resource_arns
820
- # The Amazon Resource Names (ARNs) of the resources.
1056
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the resources whose
1057
+ # policies you want to retrieve.
1058
+ #
1059
+ #
1060
+ #
1061
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
821
1062
  #
822
1063
  # @option params [String] :principal
823
- # The principal.
1064
+ # Specifies the principal.
824
1065
  #
825
1066
  # @option params [String] :next_token
826
- # The token for the next page of results.
1067
+ # Specifies that you want to receive the next page of results. Valid
1068
+ # only if you received a `NextToken` response in the previous request.
1069
+ # If you did, it indicates that more output is available. Set this
1070
+ # parameter to the value provided by the previous call's `NextToken`
1071
+ # response to request the next page of results.
827
1072
  #
828
1073
  # @option params [Integer] :max_results
829
- # The maximum number of results to return with a single call. To
830
- # retrieve the remaining results, make another call with the returned
831
- # `nextToken` value.
1074
+ # Specifies the total number of results that you want included on each
1075
+ # page of the response. If you do not include this parameter, it
1076
+ # defaults to a value that is specific to the operation. If additional
1077
+ # items exist beyond the number you specify, the `NextToken` response
1078
+ # element is returned with a value (not null). Include the specified
1079
+ # value as the `NextToken` request parameter in the next call to the
1080
+ # operation to get the next part of the results. Note that the service
1081
+ # might return fewer results than the maximum even when there are more
1082
+ # results available. You should check `NextToken` after every operation
1083
+ # to ensure that you receive all of the results.
832
1084
  #
833
1085
  # @return [Types::GetResourcePoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
834
1086
  #
@@ -861,35 +1113,73 @@ module Aws::RAM
861
1113
  req.send_request(options)
862
1114
  end
863
1115
 
864
- # Gets the resources or principals for the resource shares that you own.
1116
+ # Retrieves the resource and principal associations for resource shares
1117
+ # that you own.
865
1118
  #
866
1119
  # @option params [required, String] :association_type
867
- # The association type. Specify `PRINCIPAL` to list the principals that
868
- # are associated with the specified resource share. Specify `RESOURCE`
869
- # to list the resources that are associated with the specified resource
870
- # share.
1120
+ # Specifies whether you want to retrieve the associations that involve a
1121
+ # specified resource or principal.
1122
+ #
1123
+ # * `PRINCIPAL` – list the principals that are associated with the
1124
+ # specified resource share.
1125
+ #
1126
+ # * `RESOURCE` – list the resources that are associated with the
1127
+ # specified resource share.
871
1128
  #
872
1129
  # @option params [Array<String>] :resource_share_arns
873
- # The Amazon Resource Names (ARN) of the resource shares.
1130
+ # Specifies a list of [Amazon Resource Names (ARNs)][1] of the resource
1131
+ # share whose associations you want to retrieve.
1132
+ #
1133
+ #
1134
+ #
1135
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
874
1136
  #
875
1137
  # @option params [String] :resource_arn
876
- # The Amazon Resource Name (ARN) of the resource. You cannot specify
877
- # this parameter if the association type is `PRINCIPAL`.
1138
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource whose
1139
+ # resource shares you want to retrieve.
1140
+ #
1141
+ # You cannot specify this parameter if the association type is
1142
+ # `PRINCIPAL`.
1143
+ #
1144
+ #
1145
+ #
1146
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
878
1147
  #
879
1148
  # @option params [String] :principal
880
- # The principal. You cannot specify this parameter if the association
881
- # type is `RESOURCE`.
1149
+ # Specifies the ID of the principal whose resource shares you want to
1150
+ # retrieve. This can be an Amazon Web Services account ID, an
1151
+ # organization ID, an organizational unit ID, or the [Amazon Resoure
1152
+ # Name (ARN)][1] of an individual IAM user or role.
1153
+ #
1154
+ # You cannot specify this parameter if the association type is
1155
+ # `RESOURCE`.
1156
+ #
1157
+ #
1158
+ #
1159
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
882
1160
  #
883
1161
  # @option params [String] :association_status
884
- # The association status.
1162
+ # Specifies that you want to retrieve only associations with this
1163
+ # status.
885
1164
  #
886
1165
  # @option params [String] :next_token
887
- # The token for the next page of results.
1166
+ # Specifies that you want to receive the next page of results. Valid
1167
+ # only if you received a `NextToken` response in the previous request.
1168
+ # If you did, it indicates that more output is available. Set this
1169
+ # parameter to the value provided by the previous call's `NextToken`
1170
+ # response to request the next page of results.
888
1171
  #
889
1172
  # @option params [Integer] :max_results
890
- # The maximum number of results to return with a single call. To
891
- # retrieve the remaining results, make another call with the returned
892
- # `nextToken` value.
1173
+ # Specifies the total number of results that you want included on each
1174
+ # page of the response. If you do not include this parameter, it
1175
+ # defaults to a value that is specific to the operation. If additional
1176
+ # items exist beyond the number you specify, the `NextToken` response
1177
+ # element is returned with a value (not null). Include the specified
1178
+ # value as the `NextToken` request parameter in the next call to the
1179
+ # operation to get the next part of the results. Note that the service
1180
+ # might return fewer results than the maximum even when there are more
1181
+ # results available. You should check `NextToken` after every operation
1182
+ # to ensure that you receive all of the results.
893
1183
  #
894
1184
  # @return [Types::GetResourceShareAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
895
1185
  #
@@ -933,21 +1223,44 @@ module Aws::RAM
933
1223
  req.send_request(options)
934
1224
  end
935
1225
 
936
- # Gets the invitations that you have received for resource shares.
1226
+ # Retrieves details about invitations that you have received for
1227
+ # resource shares.
937
1228
  #
938
1229
  # @option params [Array<String>] :resource_share_invitation_arns
939
- # The Amazon Resource Names (ARN) of the invitations.
1230
+ # Specifies the [Amazon Resource Names (ARNs)][1] of the resource share
1231
+ # invitations you want information about.
1232
+ #
1233
+ #
1234
+ #
1235
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
940
1236
  #
941
1237
  # @option params [Array<String>] :resource_share_arns
942
- # The Amazon Resource Names (ARN) of the resource shares.
1238
+ # Specifies that you want details about invitations only for the
1239
+ # resource shares described by this list of [Amazon Resource Names
1240
+ # (ARNs)][1]
1241
+ #
1242
+ #
1243
+ #
1244
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
943
1245
  #
944
1246
  # @option params [String] :next_token
945
- # The token for the next page of results.
1247
+ # Specifies that you want to receive the next page of results. Valid
1248
+ # only if you received a `NextToken` response in the previous request.
1249
+ # If you did, it indicates that more output is available. Set this
1250
+ # parameter to the value provided by the previous call's `NextToken`
1251
+ # response to request the next page of results.
946
1252
  #
947
1253
  # @option params [Integer] :max_results
948
- # The maximum number of results to return with a single call. To
949
- # retrieve the remaining results, make another call with the returned
950
- # `nextToken` value.
1254
+ # Specifies the total number of results that you want included on each
1255
+ # page of the response. If you do not include this parameter, it
1256
+ # defaults to a value that is specific to the operation. If additional
1257
+ # items exist beyond the number you specify, the `NextToken` response
1258
+ # element is returned with a value (not null). Include the specified
1259
+ # value as the `NextToken` request parameter in the next call to the
1260
+ # operation to get the next part of the results. Note that the service
1261
+ # might return fewer results than the maximum even when there are more
1262
+ # results available. You should check `NextToken` after every operation
1263
+ # to ensure that you receive all of the results.
951
1264
  #
952
1265
  # @return [Types::GetResourceShareInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
953
1266
  #
@@ -997,35 +1310,65 @@ module Aws::RAM
997
1310
  req.send_request(options)
998
1311
  end
999
1312
 
1000
- # Gets the resource shares that you own or the resource shares that are
1313
+ # Retrieves details about the resource shares that you own or that are
1001
1314
  # shared with you.
1002
1315
  #
1003
1316
  # @option params [Array<String>] :resource_share_arns
1004
- # The Amazon Resource Names (ARNs) of the resource shares.
1317
+ # Specifies the [Amazon Resource Names (ARNs)][1] of individual resource
1318
+ # shares that you want information about.
1319
+ #
1320
+ #
1321
+ #
1322
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1005
1323
  #
1006
1324
  # @option params [String] :resource_share_status
1007
- # The status of the resource share.
1325
+ # Specifies that you want to retrieve details of only those resource
1326
+ # shares that have this status.
1008
1327
  #
1009
1328
  # @option params [required, String] :resource_owner
1010
- # The type of owner.
1329
+ # Specifies that you want to retrieve details of only those resource
1330
+ # shares that match the following:
1331
+ #
1332
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1333
+ #
1334
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts
1335
+ # share with you
1011
1336
  #
1012
1337
  # @option params [String] :name
1013
- # The name of the resource share.
1338
+ # Specifies the name of an individual resource share that you want to
1339
+ # retrieve details about.
1014
1340
  #
1015
1341
  # @option params [Array<Types::TagFilter>] :tag_filters
1016
- # One or more tag filters.
1342
+ # Specifies that you want to retrieve details of only those resource
1343
+ # shares that match the specified tag keys and values.
1017
1344
  #
1018
1345
  # @option params [String] :next_token
1019
- # The token for the next page of results.
1346
+ # Specifies that you want to receive the next page of results. Valid
1347
+ # only if you received a `NextToken` response in the previous request.
1348
+ # If you did, it indicates that more output is available. Set this
1349
+ # parameter to the value provided by the previous call's `NextToken`
1350
+ # response to request the next page of results.
1020
1351
  #
1021
1352
  # @option params [Integer] :max_results
1022
- # The maximum number of results to return with a single call. To
1023
- # retrieve the remaining results, make another call with the returned
1024
- # `nextToken` value.
1353
+ # Specifies the total number of results that you want included on each
1354
+ # page of the response. If you do not include this parameter, it
1355
+ # defaults to a value that is specific to the operation. If additional
1356
+ # items exist beyond the number you specify, the `NextToken` response
1357
+ # element is returned with a value (not null). Include the specified
1358
+ # value as the `NextToken` request parameter in the next call to the
1359
+ # operation to get the next part of the results. Note that the service
1360
+ # might return fewer results than the maximum even when there are more
1361
+ # results available. You should check `NextToken` after every operation
1362
+ # to ensure that you receive all of the results.
1025
1363
  #
1026
1364
  # @option params [String] :permission_arn
1027
- # The Amazon Resource Name (ARN) of the RAM permission that is
1028
- # associated with the resource share.
1365
+ # Specifies that you want to retrieve details of only those resource
1366
+ # shares that use the RAM permission with this [Amazon Resoure Name
1367
+ # (ARN)][1].
1368
+ #
1369
+ #
1370
+ #
1371
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1029
1372
  #
1030
1373
  # @return [Types::GetResourceSharesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1031
1374
  #
@@ -1079,18 +1422,51 @@ module Aws::RAM
1079
1422
  end
1080
1423
 
1081
1424
  # Lists the resources in a resource share that is shared with you but
1082
- # that the invitation is still pending for.
1425
+ # for which the invitation is still `PENDING`. That means that you
1426
+ # haven't accepted or rejected the invitation and the invitation
1427
+ # hasn't expired.
1083
1428
  #
1084
1429
  # @option params [required, String] :resource_share_invitation_arn
1085
- # The Amazon Resource Name (ARN) of the invitation.
1430
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the invitation. You
1431
+ # can use GetResourceShareInvitations to find the ARN of the invitation.
1432
+ #
1433
+ #
1434
+ #
1435
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1086
1436
  #
1087
1437
  # @option params [String] :next_token
1088
- # The token for the next page of results.
1438
+ # Specifies that you want to receive the next page of results. Valid
1439
+ # only if you received a `NextToken` response in the previous request.
1440
+ # If you did, it indicates that more output is available. Set this
1441
+ # parameter to the value provided by the previous call's `NextToken`
1442
+ # response to request the next page of results.
1089
1443
  #
1090
1444
  # @option params [Integer] :max_results
1091
- # The maximum number of results to return with a single call. To
1092
- # retrieve the remaining results, make another call with the returned
1093
- # `nextToken` value.
1445
+ # Specifies the total number of results that you want included on each
1446
+ # page of the response. If you do not include this parameter, it
1447
+ # defaults to a value that is specific to the operation. If additional
1448
+ # items exist beyond the number you specify, the `NextToken` response
1449
+ # element is returned with a value (not null). Include the specified
1450
+ # value as the `NextToken` request parameter in the next call to the
1451
+ # operation to get the next part of the results. Note that the service
1452
+ # might return fewer results than the maximum even when there are more
1453
+ # results available. You should check `NextToken` after every operation
1454
+ # to ensure that you receive all of the results.
1455
+ #
1456
+ # @option params [String] :resource_region_scope
1457
+ # Specifies that you want the results to include only resources that
1458
+ # have the specified scope.
1459
+ #
1460
+ # * `ALL` – the results include both global and regional resources or
1461
+ # resource types.
1462
+ #
1463
+ # * `GLOBAL` – the results include only global resources or resource
1464
+ # types.
1465
+ #
1466
+ # * `REGIONAL` – the results include only regional resources or resource
1467
+ # types.
1468
+ #
1469
+ # The default value is `ALL`.
1094
1470
  #
1095
1471
  # @return [Types::ListPendingInvitationResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1096
1472
  #
@@ -1105,6 +1481,7 @@ module Aws::RAM
1105
1481
  # resource_share_invitation_arn: "String", # required
1106
1482
  # next_token: "String",
1107
1483
  # max_results: 1,
1484
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
1108
1485
  # })
1109
1486
  #
1110
1487
  # @example Response structure
@@ -1118,6 +1495,7 @@ module Aws::RAM
1118
1495
  # resp.resources[0].status_message #=> String
1119
1496
  # resp.resources[0].creation_time #=> Time
1120
1497
  # resp.resources[0].last_updated_time #=> Time
1498
+ # resp.resources[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
1121
1499
  # resp.next_token #=> String
1122
1500
  #
1123
1501
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPendingInvitationResources AWS API Documentation
@@ -1129,20 +1507,33 @@ module Aws::RAM
1129
1507
  req.send_request(options)
1130
1508
  end
1131
1509
 
1132
- # Lists the RAM permissions.
1510
+ # Retrieves a list of available RAM permissions that you can use for the
1511
+ # supported resource types.
1133
1512
  #
1134
1513
  # @option params [String] :resource_type
1135
- # Specifies the resource type for which to list permissions. For
1136
- # example, to list only permissions that apply to EC2 subnets, specify
1137
- # `ec2:Subnet`.
1514
+ # Specifies that you want to list permissions for only the specified
1515
+ # resource type. For example, to list only permissions that apply to EC2
1516
+ # subnets, specify `ec2:Subnet`. You can use the ListResourceTypes
1517
+ # operation to get the specific string required.
1138
1518
  #
1139
1519
  # @option params [String] :next_token
1140
- # The token for the next page of results.
1520
+ # Specifies that you want to receive the next page of results. Valid
1521
+ # only if you received a `NextToken` response in the previous request.
1522
+ # If you did, it indicates that more output is available. Set this
1523
+ # parameter to the value provided by the previous call's `NextToken`
1524
+ # response to request the next page of results.
1141
1525
  #
1142
1526
  # @option params [Integer] :max_results
1143
- # The maximum number of results to return with a single call. To
1144
- # retrieve the remaining results, make another call with the returned
1145
- # `nextToken` value.
1527
+ # Specifies the total number of results that you want included on each
1528
+ # page of the response. If you do not include this parameter, it
1529
+ # defaults to a value that is specific to the operation. If additional
1530
+ # items exist beyond the number you specify, the `NextToken` response
1531
+ # element is returned with a value (not null). Include the specified
1532
+ # value as the `NextToken` request parameter in the next call to the
1533
+ # operation to get the next part of the results. Note that the service
1534
+ # might return fewer results than the maximum even when there are more
1535
+ # results available. You should check `NextToken` after every operation
1536
+ # to ensure that you receive all of the results.
1146
1537
  #
1147
1538
  # @return [Types::ListPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1148
1539
  #
@@ -1182,49 +1573,91 @@ module Aws::RAM
1182
1573
  req.send_request(options)
1183
1574
  end
1184
1575
 
1185
- # Lists the principals that you have shared resources with or that have
1186
- # shared resources with you.
1576
+ # Lists the principals that you are sharing resources with or that are
1577
+ # sharing resources with you.
1187
1578
  #
1188
1579
  # @option params [required, String] :resource_owner
1189
- # The type of owner.
1580
+ # Specifies that you want to list information for only resource shares
1581
+ # that match the following:
1582
+ #
1583
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1584
+ #
1585
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts
1586
+ # share with you
1190
1587
  #
1191
1588
  # @option params [String] :resource_arn
1192
- # The Amazon Resource Name (ARN) of the resource.
1589
+ # Specifies that you want to list principal information for the resource
1590
+ # share with the specified [Amazon Resoure Name (ARN)][1].
1591
+ #
1592
+ #
1593
+ #
1594
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1193
1595
  #
1194
1596
  # @option params [Array<String>] :principals
1195
- # The principals.
1597
+ # Specifies that you want to list information for only the listed
1598
+ # principals.
1599
+ #
1600
+ # You can include the following values:
1601
+ #
1602
+ # * An Amazon Web Services account ID, for example: `123456789012`
1603
+ #
1604
+ # * An [Amazon Resoure Name (ARN)][1] of an organization in
1605
+ # Organizations, for example:
1606
+ # `organizations::123456789012:organization/o-exampleorgid`
1607
+ #
1608
+ # * An ARN of an organizational unit (OU) in Organizations, for example:
1609
+ # `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`
1610
+ #
1611
+ # * An ARN of an IAM role, for example:
1612
+ # `iam::123456789012:role/rolename`
1613
+ #
1614
+ # * An ARN of an IAM user, for example: `iam::123456789012user/username`
1615
+ #
1616
+ # <note markdown="1"> Not all resource types can be shared with IAM roles and users. For
1617
+ # more information, see [Sharing with IAM roles and users][2] in the
1618
+ # *Resource Access Manager User Guide*.
1619
+ #
1620
+ # </note>
1621
+ #
1622
+ #
1623
+ #
1624
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1625
+ # [2]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types
1196
1626
  #
1197
1627
  # @option params [String] :resource_type
1198
- # The resource type.
1199
- #
1200
- # Valid values: `acm-pca:CertificateAuthority` \| `appmesh:Mesh` \|
1201
- # `codebuild:Project` \| `codebuild:ReportGroup` \|
1202
- # `ec2:CapacityReservation` \| `ec2:DedicatedHost` \|
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`
1628
+ # Specifies that you want to list information for only principals
1629
+ # associated with resource shares that include the specified resource
1630
+ # type.
1631
+ #
1632
+ # For a list of valid values, query the ListResourceTypes operation.
1217
1633
  #
1218
1634
  # @option params [Array<String>] :resource_share_arns
1219
- # The Amazon Resource Names (ARN) of the resource shares.
1635
+ # Specifies that you want to list information for only principals
1636
+ # associated with the resource shares specified by a list the [Amazon
1637
+ # Resource Names (ARNs)][1].
1638
+ #
1639
+ #
1640
+ #
1641
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1220
1642
  #
1221
1643
  # @option params [String] :next_token
1222
- # The token for the next page of results.
1644
+ # Specifies that you want to receive the next page of results. Valid
1645
+ # only if you received a `NextToken` response in the previous request.
1646
+ # If you did, it indicates that more output is available. Set this
1647
+ # parameter to the value provided by the previous call's `NextToken`
1648
+ # response to request the next page of results.
1223
1649
  #
1224
1650
  # @option params [Integer] :max_results
1225
- # The maximum number of results to return with a single call. To
1226
- # retrieve the remaining results, make another call with the returned
1227
- # `nextToken` value.
1651
+ # Specifies the total number of results that you want included on each
1652
+ # page of the response. If you do not include this parameter, it
1653
+ # defaults to a value that is specific to the operation. If additional
1654
+ # items exist beyond the number you specify, the `NextToken` response
1655
+ # element is returned with a value (not null). Include the specified
1656
+ # value as the `NextToken` request parameter in the next call to the
1657
+ # operation to get the next part of the results. Note that the service
1658
+ # might return fewer results than the maximum even when there are more
1659
+ # results available. You should check `NextToken` after every operation
1660
+ # to ensure that you receive all of the results.
1228
1661
  #
1229
1662
  # @return [Types::ListPrincipalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1230
1663
  #
@@ -1267,15 +1700,31 @@ module Aws::RAM
1267
1700
  # Lists the RAM permissions that are associated with a resource share.
1268
1701
  #
1269
1702
  # @option params [required, String] :resource_share_arn
1270
- # The Amazon Resource Name (ARN) of the resource share.
1703
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share for
1704
+ # which you want to retrieve the associated permissions.
1705
+ #
1706
+ #
1707
+ #
1708
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1271
1709
  #
1272
1710
  # @option params [String] :next_token
1273
- # 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.
1274
1716
  #
1275
1717
  # @option params [Integer] :max_results
1276
- # The maximum number of results to return with a single call. To
1277
- # retrieve the remaining results, make another call with the returned
1278
- # `nextToken` value.
1718
+ # Specifies the total number of results that you want included on each
1719
+ # page of the response. If you do not include this parameter, it
1720
+ # defaults to a value that is specific to the operation. If additional
1721
+ # items exist beyond the number you specify, the `NextToken` response
1722
+ # element is returned with a value (not null). Include the specified
1723
+ # value as the `NextToken` request parameter in the next call to the
1724
+ # operation to get the next part of the results. Note that the service
1725
+ # might return fewer results than the maximum even when there are more
1726
+ # results available. You should check `NextToken` after every operation
1727
+ # to ensure that you receive all of the results.
1279
1728
  #
1280
1729
  # @return [Types::ListResourceSharePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1281
1730
  #
@@ -1315,15 +1764,41 @@ module Aws::RAM
1315
1764
  req.send_request(options)
1316
1765
  end
1317
1766
 
1318
- # Lists the shareable resource types supported by RAM.
1767
+ # Lists the resource types that can be shared by RAM.
1319
1768
  #
1320
1769
  # @option params [String] :next_token
1321
- # The token for the next page of results.
1770
+ # Specifies that you want to receive the next page of results. Valid
1771
+ # only if you received a `NextToken` response in the previous request.
1772
+ # If you did, it indicates that more output is available. Set this
1773
+ # parameter to the value provided by the previous call's `NextToken`
1774
+ # response to request the next page of results.
1322
1775
  #
1323
1776
  # @option params [Integer] :max_results
1324
- # The maximum number of results to return with a single call. To
1325
- # retrieve the remaining results, make another call with the returned
1326
- # `nextToken` value.
1777
+ # Specifies the total number of results that you want included on each
1778
+ # page of the response. If you do not include this parameter, it
1779
+ # defaults to a value that is specific to the operation. If additional
1780
+ # items exist beyond the number you specify, the `NextToken` response
1781
+ # element is returned with a value (not null). Include the specified
1782
+ # value as the `NextToken` request parameter in the next call to the
1783
+ # operation to get the next part of the results. Note that the service
1784
+ # might return fewer results than the maximum even when there are more
1785
+ # results available. You should check `NextToken` after every operation
1786
+ # to ensure that you receive all of the results.
1787
+ #
1788
+ # @option params [String] :resource_region_scope
1789
+ # Specifies that you want the results to include only resources that
1790
+ # have the specified scope.
1791
+ #
1792
+ # * `ALL` – the results include both global and regional resources or
1793
+ # resource types.
1794
+ #
1795
+ # * `GLOBAL` – the results include only global resources or resource
1796
+ # types.
1797
+ #
1798
+ # * `REGIONAL` – the results include only regional resources or resource
1799
+ # types.
1800
+ #
1801
+ # The default value is `ALL`.
1327
1802
  #
1328
1803
  # @return [Types::ListResourceTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1329
1804
  #
@@ -1337,6 +1812,7 @@ module Aws::RAM
1337
1812
  # resp = client.list_resource_types({
1338
1813
  # next_token: "String",
1339
1814
  # max_results: 1,
1815
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
1340
1816
  # })
1341
1817
  #
1342
1818
  # @example Response structure
@@ -1344,6 +1820,7 @@ module Aws::RAM
1344
1820
  # resp.resource_types #=> Array
1345
1821
  # resp.resource_types[0].resource_type #=> String
1346
1822
  # resp.resource_types[0].service_name #=> String
1823
+ # resp.resource_types[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
1347
1824
  # resp.next_token #=> String
1348
1825
  #
1349
1826
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypes AWS API Documentation
@@ -1359,45 +1836,73 @@ module Aws::RAM
1359
1836
  # resources that are shared with you.
1360
1837
  #
1361
1838
  # @option params [required, String] :resource_owner
1362
- # The type of owner.
1839
+ # Specifies that you want to list only the resource shares that match
1840
+ # the following:
1841
+ #
1842
+ # * <b> <code>SELF</code> </b> – resources that you are sharing
1843
+ #
1844
+ # * <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts
1845
+ # share with you
1363
1846
  #
1364
1847
  # @option params [String] :principal
1365
- # The principal.
1848
+ # Specifies that you want to list only the resource shares that are
1849
+ # associated with the specified principal.
1366
1850
  #
1367
1851
  # @option params [String] :resource_type
1368
- # The resource type.
1369
- #
1370
- # Valid values: `acm-pca:CertificateAuthority` \| `appmesh:Mesh` \|
1371
- # `codebuild:Project` \| `codebuild:ReportGroup` \|
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`
1852
+ # Specifies that you want to list only the resource shares that include
1853
+ # resources of the specified resource type.
1854
+ #
1855
+ # For valid values, query the ListResourceTypes operation.
1387
1856
  #
1388
1857
  # @option params [Array<String>] :resource_arns
1389
- # The Amazon Resource Names (ARNs) of the resources.
1858
+ # Specifies that you want to list only the resource shares that include
1859
+ # resources with the specified [Amazon Resource Names (ARNs)][1].
1860
+ #
1861
+ #
1862
+ #
1863
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1390
1864
  #
1391
1865
  # @option params [Array<String>] :resource_share_arns
1392
- # The Amazon Resource Names (ARN) of the resource shares.
1866
+ # Specifies that you want to list only resources in the resource shares
1867
+ # identified by the specified [Amazon Resource Names (ARNs)][1].
1868
+ #
1869
+ #
1870
+ #
1871
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1393
1872
  #
1394
1873
  # @option params [String] :next_token
1395
- # The token for the next page of results.
1874
+ # Specifies that you want to receive the next page of results. Valid
1875
+ # only if you received a `NextToken` response in the previous request.
1876
+ # If you did, it indicates that more output is available. Set this
1877
+ # parameter to the value provided by the previous call's `NextToken`
1878
+ # response to request the next page of results.
1396
1879
  #
1397
1880
  # @option params [Integer] :max_results
1398
- # The maximum number of results to return with a single call. To
1399
- # retrieve the remaining results, make another call with the returned
1400
- # `nextToken` value.
1881
+ # Specifies the total number of results that you want included on each
1882
+ # page of the response. If you do not include this parameter, it
1883
+ # defaults to a value that is specific to the operation. If additional
1884
+ # items exist beyond the number you specify, the `NextToken` response
1885
+ # element is returned with a value (not null). Include the specified
1886
+ # value as the `NextToken` request parameter in the next call to the
1887
+ # operation to get the next part of the results. Note that the service
1888
+ # might return fewer results than the maximum even when there are more
1889
+ # results available. You should check `NextToken` after every operation
1890
+ # to ensure that you receive all of the results.
1891
+ #
1892
+ # @option params [String] :resource_region_scope
1893
+ # Specifies that you want the results to include only resources that
1894
+ # have the specified scope.
1895
+ #
1896
+ # * `ALL` – the results include both global and regional resources or
1897
+ # resource types.
1898
+ #
1899
+ # * `GLOBAL` – the results include only global resources or resource
1900
+ # types.
1901
+ #
1902
+ # * `REGIONAL` – the results include only regional resources or resource
1903
+ # types.
1904
+ #
1905
+ # The default value is `ALL`.
1401
1906
  #
1402
1907
  # @return [Types::ListResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1403
1908
  #
@@ -1416,6 +1921,7 @@ module Aws::RAM
1416
1921
  # resource_share_arns: ["String"],
1417
1922
  # next_token: "String",
1418
1923
  # max_results: 1,
1924
+ # resource_region_scope: "ALL", # accepts ALL, REGIONAL, GLOBAL
1419
1925
  # })
1420
1926
  #
1421
1927
  # @example Response structure
@@ -1429,6 +1935,7 @@ module Aws::RAM
1429
1935
  # resp.resources[0].status_message #=> String
1430
1936
  # resp.resources[0].creation_time #=> Time
1431
1937
  # resp.resources[0].last_updated_time #=> Time
1938
+ # resp.resources[0].resource_region_scope #=> String, one of "REGIONAL", "GLOBAL"
1432
1939
  # resp.next_token #=> String
1433
1940
  #
1434
1941
  # @see http://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResources AWS API Documentation
@@ -1440,19 +1947,23 @@ module Aws::RAM
1440
1947
  req.send_request(options)
1441
1948
  end
1442
1949
 
1443
- # Resource shares that were created by attaching a policy to a resource
1444
- # are visible only to the resource share owner, and the resource share
1445
- # cannot be modified in RAM.
1950
+ # When you attach a resource-based permission policy to a resource, it
1951
+ # automatically creates a resource share. However, resource shares
1952
+ # created this way are visible only to the resource share owner, and the
1953
+ # resource share can't be modified in RAM.
1446
1954
  #
1447
- # Use this API action to promote the resource share. When you promote
1448
- # the resource share, it becomes:
1955
+ # You can use this operation to promote the resource share to a full RAM
1956
+ # resource share. When you promote a resource share, you can then manage
1957
+ # the resource share in RAM and it becomes visible to all of the
1958
+ # principals you shared it with.
1449
1959
  #
1450
- # * Visible to all principals that it is shared with.
1960
+ # @option params [required, String] :resource_share_arn
1961
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share to
1962
+ # promote.
1451
1963
  #
1452
- # * Modifiable in RAM.
1453
1964
  #
1454
- # @option params [required, String] :resource_share_arn
1455
- # The Amazon Resource Name (ARN) of the resource share to promote.
1965
+ #
1966
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1456
1967
  #
1457
1968
  # @return [Types::PromoteResourceShareCreatedFromPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1458
1969
  #
@@ -1481,11 +1992,27 @@ module Aws::RAM
1481
1992
  # Services account.
1482
1993
  #
1483
1994
  # @option params [required, String] :resource_share_invitation_arn
1484
- # The Amazon Resource Name (ARN) of the invitation.
1995
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the invitation that
1996
+ # you want to reject.
1997
+ #
1998
+ #
1999
+ #
2000
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1485
2001
  #
1486
2002
  # @option params [String] :client_token
1487
- # A unique, case-sensitive identifier that you provide to ensure the
1488
- # idempotency of the request.
2003
+ # Specifies a unique, case-sensitive identifier that you provide to
2004
+ # ensure the idempotency of the request. This lets you safely retry the
2005
+ # request without accidentally performing the same operation a second
2006
+ # time. Passing the same value to a later call to an operation requires
2007
+ # that you also pass the same value for all other parameters. We
2008
+ # recommend that you use a [UUID type of value.][1].
2009
+ #
2010
+ # If you don't provide this value, then Amazon Web Services generates a
2011
+ # random one for you.
2012
+ #
2013
+ #
2014
+ #
2015
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
1489
2016
  #
1490
2017
  # @return [Types::RejectResourceShareInvitationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1491
2018
  #
@@ -1530,13 +2057,22 @@ module Aws::RAM
1530
2057
  req.send_request(options)
1531
2058
  end
1532
2059
 
1533
- # Adds the specified tags to the specified resource share that you own.
2060
+ # Adds the specified tag keys and values to the specified resource
2061
+ # share. The tags are attached only to the resource share, not to the
2062
+ # resources that are in the resource share.
1534
2063
  #
1535
2064
  # @option params [required, String] :resource_share_arn
1536
- # The Amazon Resource Name (ARN) of the resource share.
2065
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2066
+ # that you want to add tags to.
2067
+ #
2068
+ #
2069
+ #
2070
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1537
2071
  #
1538
2072
  # @option params [required, Array<Types::Tag>] :tags
1539
- # One or more tags.
2073
+ # A list of one or more tag key and value pairs. The tag key must be
2074
+ # present and not be an empty string. The tag value must be present but
2075
+ # can be an empty string.
1540
2076
  #
1541
2077
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1542
2078
  #
@@ -1561,14 +2097,20 @@ module Aws::RAM
1561
2097
  req.send_request(options)
1562
2098
  end
1563
2099
 
1564
- # Removes the specified tags from the specified resource share that you
1565
- # own.
2100
+ # Removes the specified tag key and value pairs from the specified
2101
+ # resource share.
1566
2102
  #
1567
2103
  # @option params [required, String] :resource_share_arn
1568
- # The Amazon Resource Name (ARN) of the resource share.
2104
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2105
+ # that you want to remove tags from. The tags are removed from the
2106
+ # resource share, not the resources in the resource share.
2107
+ #
2108
+ #
2109
+ #
2110
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1569
2111
  #
1570
2112
  # @option params [required, Array<String>] :tag_keys
1571
- # The tag keys of the tags to remove.
2113
+ # Specifies a list of one or more tag keys that you want to remove.
1572
2114
  #
1573
2115
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1574
2116
  #
@@ -1588,21 +2130,38 @@ module Aws::RAM
1588
2130
  req.send_request(options)
1589
2131
  end
1590
2132
 
1591
- # Updates the specified resource share that you own.
2133
+ # Modifies some of the properties of the specified resource share.
1592
2134
  #
1593
2135
  # @option params [required, String] :resource_share_arn
1594
- # The Amazon Resource Name (ARN) of the resource share.
2136
+ # Specifies the [Amazon Resoure Name (ARN)][1] of the resource share
2137
+ # that you want to modify.
2138
+ #
2139
+ #
2140
+ #
2141
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1595
2142
  #
1596
2143
  # @option params [String] :name
1597
- # The name of the resource share.
2144
+ # If specified, the new name that you want to attach to the resource
2145
+ # share.
1598
2146
  #
1599
2147
  # @option params [Boolean] :allow_external_principals
1600
- # Indicates whether principals outside your organization in
2148
+ # Specifies whether principals outside your organization in
1601
2149
  # Organizations can be associated with a resource share.
1602
2150
  #
1603
2151
  # @option params [String] :client_token
1604
- # A unique, case-sensitive identifier that you provide to ensure the
1605
- # idempotency of the request.
2152
+ # Specifies a unique, case-sensitive identifier that you provide to
2153
+ # ensure the idempotency of the request. This lets you safely retry the
2154
+ # request without accidentally performing the same operation a second
2155
+ # time. Passing the same value to a later call to an operation requires
2156
+ # that you also pass the same value for all other parameters. We
2157
+ # recommend that you use a [UUID type of value.][1].
2158
+ #
2159
+ # If you don't provide this value, then Amazon Web Services generates a
2160
+ # random one for you.
2161
+ #
2162
+ #
2163
+ #
2164
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
1606
2165
  #
1607
2166
  # @return [Types::UpdateResourceShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1608
2167
  #
@@ -1656,7 +2215,7 @@ module Aws::RAM
1656
2215
  params: params,
1657
2216
  config: config)
1658
2217
  context[:gem_name] = 'aws-sdk-ram'
1659
- context[:gem_version] = '1.33.0'
2218
+ context[:gem_version] = '1.34.0'
1660
2219
  Seahorse::Client::Request.new(handlers, context)
1661
2220
  end
1662
2221