AWS Resource Access Manager · A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request. Type: String resourceShareAssociations (p. 6) Information

AWS Resource Access ManagerAPI Reference

API Version 2018-01-04

AWS Resource Access Manager API Reference

AWS Resource Access Manager: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

AcceptResourceShareInvitation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

AssociateResourceShare .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

AssociateResourceSharePermission .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

CreateResourceShare .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

DeleteResourceShare .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

DisassociateResourceShare .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

DisassociateResourceSharePermission .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

API Version 2018-01-04iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

EnableSharingWithAwsOrganization .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

GetPermission .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

GetResourcePolicies ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

GetResourceShareAssociations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

GetResourceShareInvitations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

GetResourceShares .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

ListPendingInvitationResources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

API Version 2018-01-04iv


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

ListPermissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

ListPrincipals ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

ListResources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

ListResourceSharePermissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

PromoteResourceShareCreatedFromPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

RejectResourceShareInvitation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

API Version 2018-01-04v


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

UpdateResourceShare .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Principal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Resource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

ResourceShare .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

ResourceShareAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

ResourceShareInvitation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

ResourceSharePermissionDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

ResourceSharePermissionSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

TagFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

API Version 2018-01-04vi


WelcomeUse AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource,you create a resource share, associate the resource with the resource share, and specify the principalsthat can access the resources associated with the resource share. The following principals are supported:AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWSOrganizations.

For more information, see the AWS Resource Access Manager User Guide.

This document was last published on June 3, 2020.


https://docs.aws.amazon.com/ram/latest/userguide/


ActionsThe following actions are supported:

• AcceptResourceShareInvitation (p. 3)• AssociateResourceShare (p. 6)• AssociateResourceSharePermission (p. 10)• CreateResourceShare (p. 13)• DeleteResourceShare (p. 17)• DisassociateResourceShare (p. 20)• DisassociateResourceSharePermission (p. 23)• EnableSharingWithAwsOrganization (p. 26)• GetPermission (p. 28)• GetResourcePolicies (p. 31)• GetResourceShareAssociations (p. 34)• GetResourceShareInvitations (p. 38)• GetResourceShares (p. 41)• ListPendingInvitationResources (p. 45)• ListPermissions (p. 48)• ListPrincipals (p. 51)• ListResources (p. 55)• ListResourceSharePermissions (p. 59)• PromoteResourceShareCreatedFromPolicy (p. 62)• RejectResourceShareInvitation (p. 64)• TagResource (p. 67)• UntagResource (p. 69)• UpdateResourceShare (p. 71)


AWS Resource Access Manager API ReferenceAcceptResourceShareInvitation

AcceptResourceShareInvitationAccepts an invitation to a resource share from another AWS account.

Request SyntaxPOST /acceptresourceshareinvitation HTTP/1.1Content-type: application/json

{ "clientToken": "string", "resourceShareInvitationArn": "string"}

URI Request ParametersThe request does not use any URI parameters.

Request BodyThe request accepts the following data in JSON format.

clientToken (p. 3)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Required: NoresourceShareInvitationArn (p. 3)

The Amazon Resource Name (ARN) of the invitation.

Type: String

Required: Yes

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "clientToken": "string", "resourceShareInvitation": { "invitationTimestamp": number, "receiverAccountId": "string", "resourceShareArn": "string", "resourceShareAssociations": [ { "associatedEntity": "string", "associationType": "string", "creationTime": number, "external": boolean, "lastUpdatedTime": number,


AWS Resource Access Manager API ReferenceResponse Elements

"resourceShareArn": "string", "resourceShareName": "string", "status": "string", "statusMessage": "string" } ], "resourceShareInvitationArn": "string", "resourceShareName": "string", "senderAccountId": "string", "status": "string" }}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

clientToken (p. 3)


Type: StringresourceShareInvitation (p. 3)

Information about the invitation.

Type: ResourceShareInvitation (p. 82) object

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 92).

IdempotentParameterMismatchException

A client token input parameter was reused with an operation, but at least one of the other inputparameters is different from the previous call to the operation.

HTTP Status Code: 400InvalidClientTokenException

A client token is not valid.

HTTP Status Code: 400MalformedArnException

The format of an Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400OperationNotPermittedException

The requested operation is not permitted.

HTTP Status Code: 400ResourceShareInvitationAlreadyAcceptedException

The invitation was already accepted.


AWS Resource Access Manager API ReferenceSee Also

HTTP Status Code: 400ResourceShareInvitationAlreadyRejectedException

The invitation was already rejected.

HTTP Status Code: 400ResourceShareInvitationArnNotFoundException

The Amazon Resource Name (ARN) for an invitation was not found.

HTTP Status Code: 400ResourceShareInvitationExpiredException

The invitation is expired.

HTTP Status Code: 400ServerInternalException

The service could not respond to the request due to an internal problem.

HTTP Status Code: 500ServiceUnavailableException

The service is not available.

HTTP Status Code: 503

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/AcceptResourceShareInvitation

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/AcceptResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/AcceptResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/AcceptResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/AcceptResourceShareInvitation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/AcceptResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/AcceptResourceShareInvitation

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/AcceptResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/AcceptResourceShareInvitation

AWS Resource Access Manager API ReferenceAssociateResourceShare

AssociateResourceShareAssociates the specified resource share with the specified principals and resources.

Request SyntaxPOST /associateresourceshare HTTP/1.1Content-type: application/json

{ "clientToken": "string", "principals": [ "string" ], "resourceArns": [ "string" ], "resourceShareArn": "string"}



clientToken (p. 6)


Type: String

Required: Noprincipals (p. 6)

The principals.

Type: Array of strings

Required: NoresourceArns (p. 6)

The Amazon Resource Names (ARN) of the resources.


Required: NoresourceShareArn (p. 6)

The Amazon Resource Name (ARN) of the resource share.

Type: String

Required: Yes

Response SyntaxHTTP/1.1 200



Content-type: application/json

{ "clientToken": "string", "resourceShareAssociations": [ { "associatedEntity": "string", "associationType": "string", "creationTime": number, "external": boolean, "lastUpdatedTime": number, "resourceShareArn": "string", "resourceShareName": "string", "status": "string", "statusMessage": "string" } ]}



clientToken (p. 6)


Type: StringresourceShareAssociations (p. 6)

Information about the associations.

Type: Array of ResourceShareAssociation (p. 80) objects






HTTP Status Code: 400InvalidParameterException

A parameter is not valid.

HTTP Status Code: 400InvalidStateTransitionException

The requested state transition is not valid.









HTTP Status Code: 400ResourceShareLimitExceededException

The requested resource share exceeds the limit for your account.





HTTP Status Code: 503UnknownResourceException

A specified resource was not found.







https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/AssociateResourceShare

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/AssociateResourceShare

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/AssociateResourceShare

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/AssociateResourceShare

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/AssociateResourceShare

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/AssociateResourceShare

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/AssociateResourceShare

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/AssociateResourceShare

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/AssociateResourceShare



AWS Resource Access Manager API ReferenceAssociateResourceSharePermission

AssociateResourceSharePermissionAssociates a permission with a resource share.

Request SyntaxPOST /associateresourcesharepermission HTTP/1.1Content-type: application/json

{ "clientToken": "string", "permissionArn": "string", "replace": boolean, "resourceShareArn": "string"}



clientToken (p. 10)


Type: String

Required: No

permissionArn (p. 10)

The ARN of the AWS RAM permission to associate with the resource share.

Type: String

Required: Yes

replace (p. 10)

Indicates whether the permission should replace the permissions that are currently associated withthe resource share. Use true to replace the current permissions. Use false to add the permission tothe current permission.

Type: Boolean

Required: No

resourceShareArn (p. 10)


Type: String

Required: Yes


AWS Resource Access Manager API ReferenceResponse Syntax


{ "clientToken": "string", "returnValue": boolean}



clientToken (p. 11)


Type: StringreturnValue (p. 11)

Indicates whether the request succeeded.

Type: Boolean


InvalidClientTokenException













ServiceUnavailableException








https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/AssociateResourceSharePermission

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/AssociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/AssociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/AssociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/AssociateResourceSharePermission

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/AssociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/AssociateResourceSharePermission

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/AssociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/AssociateResourceSharePermission

AWS Resource Access Manager API ReferenceCreateResourceShare

CreateResourceShareCreates a resource share.

Request SyntaxPOST /createresourceshare HTTP/1.1Content-type: application/json

{ "allowExternalPrincipals": boolean, "clientToken": "string", "name": "string", "permissionArns": [ "string" ], "principals": [ "string" ], "resourceArns": [ "string" ], "tags": [ { "key": "string", "value": "string" } ]}



allowExternalPrincipals (p. 13)

Indicates whether principals outside your AWS organization can be associated with a resource share.

Type: Boolean

Required: NoclientToken (p. 13)


Type: String

Required: Noname (p. 13)

The name of the resource share.

Type: String

Required: YespermissionArns (p. 13)

The ARNs of the permissions to associate with the resource share. If you do not specify an ARN forthe permission, AWS RAM automatically attaches the default version of the permission for eachresource type.




Required: No

principals (p. 13)

The principals to associate with the resource share. The possible values are IDs of AWS accounts, theARN of an OU or organization from AWS Organizations.


Required: No

resourceArns (p. 13)

The Amazon Resource Names (ARN) of the resources to associate with the resource share.


Required: No

tags (p. 13)

One or more tags.

Type: Array of Tag (p. 88) objects

Required: No


{ "clientToken": "string", "resourceShare": { "allowExternalPrincipals": boolean, "creationTime": number, "featureSet": "string", "lastUpdatedTime": number, "name": "string", "owningAccountId": "string", "resourceShareArn": "string", "status": "string", "statusMessage": "string", "tags": [ { "key": "string", "value": "string" } ] }}




AWS Resource Access Manager API ReferenceErrors

clientToken (p. 14)


Type: StringresourceShare (p. 14)

Information about the resource share.

Type: ResourceShare (p. 78) object























HTTP Status Code: 503TagPolicyViolationException

The specified tag is a reserved word and cannot be used.







https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/CreateResourceShare

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/CreateResourceShare

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/CreateResourceShare

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/CreateResourceShare

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/CreateResourceShare

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/CreateResourceShare

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/CreateResourceShare

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/CreateResourceShare

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/CreateResourceShare

AWS Resource Access Manager API ReferenceDeleteResourceShare

DeleteResourceShareDeletes the specified resource share.

Request Syntax

DELETE /deleteresourceshare?clientToken=clientToken&resourceShareArn=resourceShareArn HTTP/1.1

URI Request ParametersThe request requires the following URI parameters.

clientToken (p. 17)




Request BodyThe request does not have a request body.

Response Syntax

HTTP/1.1 200Content-type: application/json




clientToken (p. 17)


Type: String

returnValue (p. 17)


Type: Boolean
























• AWS Command Line Interface


https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/DeleteResourceShare


• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/DeleteResourceShare

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/DeleteResourceShare

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/DeleteResourceShare

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/DeleteResourceShare

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/DeleteResourceShare

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/DeleteResourceShare

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/DeleteResourceShare

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/DeleteResourceShare

AWS Resource Access Manager API ReferenceDisassociateResourceShare

DisassociateResourceShareDisassociates the specified principals or resources from the specified resource share.

Request SyntaxPOST /disassociateresourceshare HTTP/1.1Content-type: application/json

{ "clientToken": "string", "principals": [ "string" ], "resourceArns": [ "string" ], "resourceShareArn": "string"}



clientToken (p. 20)


Type: String


The principals.



The Amazon Resource Names (ARNs) of the resources.




Type: String

Required: Yes





{ "clientToken": "string", "resourceShareAssociations": [ { "associatedEntity": "string", "associationType": "string", "creationTime": number, "external": boolean, "lastUpdatedTime": number, "resourceShareArn": "string", "resourceShareName": "string", "status": "string", "statusMessage": "string" } ]}



clientToken (p. 20)
































https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/DisassociateResourceShare

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/DisassociateResourceShare

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/DisassociateResourceShare

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/DisassociateResourceShare

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/DisassociateResourceShare

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/DisassociateResourceShare

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/DisassociateResourceShare

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/DisassociateResourceShare

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/DisassociateResourceShare

AWS Resource Access Manager API ReferenceDisassociateResourceSharePermission

DisassociateResourceSharePermissionDisassociates an AWS RAM permission from a resource share.

Request SyntaxPOST /disassociateresourcesharepermission HTTP/1.1Content-type: application/json

{ "clientToken": "string", "permissionArn": "string", "resourceShareArn": "string"}



clientToken (p. 23)


Type: String

Required: NopermissionArn (p. 23)

The ARN of the permission to disassociate from the resource share.

Type: String

Required: YesresourceShareArn (p. 23)


Type: String

Required: Yes







clientToken (p. 23)


Type: StringreturnValue (p. 23)


Type: Boolean


InvalidClientTokenException




















https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/DisassociateResourceSharePermission

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/DisassociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/DisassociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/DisassociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/DisassociateResourceSharePermission

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/DisassociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/DisassociateResourceSharePermission

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/DisassociateResourceSharePermission

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/DisassociateResourceSharePermission

AWS Resource Access Manager API ReferenceEnableSharingWithAwsOrganization

EnableSharingWithAwsOrganizationEnables resource sharing within your AWS Organization.

The caller must be the master account for the AWS Organization.

Request SyntaxPOST /enablesharingwithawsorganization HTTP/1.1




{ "returnValue": boolean}



returnValue (p. 26)


Type: Boolean


OperationNotPermittedException












https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/EnableSharingWithAwsOrganization

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/EnableSharingWithAwsOrganization

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/EnableSharingWithAwsOrganization

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/EnableSharingWithAwsOrganization

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/EnableSharingWithAwsOrganization

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/EnableSharingWithAwsOrganization

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/EnableSharingWithAwsOrganization

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/EnableSharingWithAwsOrganization

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/EnableSharingWithAwsOrganization

AWS Resource Access Manager API ReferenceGetPermission

GetPermissionGets the contents of an AWS RAM permission in JSON format.

Request SyntaxPOST /getpermission HTTP/1.1Content-type: application/json

{ "permissionArn": "string", "permissionVersion": number}



permissionArn (p. 28)

The ARN of the permission.

Type: String

Required: YespermissionVersion (p. 28)

The identifier for the version of the permission.

Type: Integer

Required: No


{ "permission": { "arn": "string", "creationTime": number, "defaultVersion": boolean, "lastUpdatedTime": number, "name": "string", "permission": "string", "resourceType": "string", "version": "string" }}





permission (p. 28)

Information about the permission.

Type: ResourceSharePermissionDetail (p. 84) object


InvalidParameterException














• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/GetPermission

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/GetPermission

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/GetPermission

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/GetPermission


• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/GetPermission

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/GetPermission

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/GetPermission

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/GetPermission

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/GetPermission

AWS Resource Access Manager API ReferenceGetResourcePolicies

GetResourcePoliciesGets the policies for the specified resources that you own and have shared.

Request SyntaxPOST /getresourcepolicies HTTP/1.1Content-type: application/json

{ "maxResults": number, "nextToken": "string", "principal": "string", "resourceArns": [ "string" ]}



maxResults (p. 31)

The maximum number of results to return with a single call. To retrieve the remaining results, makeanother call with the returned nextToken value.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: NonextToken (p. 31)

The token for the next page of results.

Type: String

Required: Noprincipal (p. 31)

The principal.

Type: String




Required: Yes




{ "nextToken": "string", "policies": [ "string" ]}



nextToken (p. 32)

The token to use to retrieve the next page of results. This value is null when there are no moreresults to return.

Type: Stringpolicies (p. 32)

A key policy document, in JSON format.



InvalidNextTokenException

The specified value for NextToken is not valid.















https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/GetResourcePolicies

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/GetResourcePolicies

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/GetResourcePolicies

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/GetResourcePolicies

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/GetResourcePolicies

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/GetResourcePolicies

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/GetResourcePolicies

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/GetResourcePolicies

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/GetResourcePolicies

AWS Resource Access Manager API ReferenceGetResourceShareAssociations

GetResourceShareAssociationsGets the resources or principals for the resource shares that you own.

Request SyntaxPOST /getresourceshareassociations HTTP/1.1Content-type: application/json

{ "associationStatus": "string", "associationType": "string", "maxResults": number, "nextToken": "string", "principal": "string", "resourceArn": "string", "resourceShareArns": [ "string" ]}



associationStatus (p. 34)

The association status.

Type: String

Valid Values: ASSOCIATING | ASSOCIATED | FAILED | DISASSOCIATING |DISASSOCIATED

Required: NoassociationType (p. 34)

The association type. Specify PRINCIPAL to list the principals that are associated with the specifiedresource share. Specify RESOURCE to list the resources that are associated with the specifiedresource share.

Type: String

Valid Values: PRINCIPAL | RESOURCE

Required: YesmaxResults (p. 34)


Type: Integer






Type: String


The principal. You cannot specify this parameter if the association type is RESOURCE.

Type: String

Required: NoresourceArn (p. 34)

The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if theassociation type is PRINCIPAL.

Type: String

Required: NoresourceShareArns (p. 34)

The Amazon Resource Names (ARN) of the resource shares.


Required: No


{ "nextToken": "string", "resourceShareAssociations": [ { "associatedEntity": "string", "associationType": "string", "creationTime": number, "external": boolean, "lastUpdatedTime": number, "resourceShareArn": "string", "resourceShareName": "string", "status": "string", "statusMessage": "string" } ]}





nextToken (p. 35)


























https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/GetResourceShareAssociations

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/GetResourceShareAssociations

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/GetResourceShareAssociations

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/GetResourceShareAssociations

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/GetResourceShareAssociations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/GetResourceShareAssociations

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/GetResourceShareAssociations

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/GetResourceShareAssociations

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/GetResourceShareAssociations

AWS Resource Access Manager API ReferenceGetResourceShareInvitations

GetResourceShareInvitationsGets the invitations for resource sharing that you've received.

Request SyntaxPOST /getresourceshareinvitations HTTP/1.1Content-type: application/json

{ "maxResults": number, "nextToken": "string", "resourceShareArns": [ "string" ], "resourceShareInvitationArns": [ "string" ]}



maxResults (p. 38)


Type: Integer




Type: String

Required: NoresourceShareArns (p. 38)



Required: NoresourceShareInvitationArns (p. 38)

The Amazon Resource Names (ARN) of the invitations.


Required: No




{ "nextToken": "string", "resourceShareInvitations": [ { "invitationTimestamp": number, "receiverAccountId": "string", "resourceShareArn": "string", "resourceShareAssociations": [ { "associatedEntity": "string", "associationType": "string", "creationTime": number, "external": boolean, "lastUpdatedTime": number, "resourceShareArn": "string", "resourceShareName": "string", "status": "string", "statusMessage": "string" } ], "resourceShareInvitationArn": "string", "resourceShareName": "string", "senderAccountId": "string", "status": "string" } ]}



nextToken (p. 39)


Type: StringresourceShareInvitations (p. 39)

Information about the invitations.

Type: Array of ResourceShareInvitation (p. 82) objects


InvalidMaxResultsException

The specified value for MaxResults is not valid.



HTTP Status Code: 400InvalidNextTokenException
















https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/GetResourceShareInvitations

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/GetResourceShareInvitations

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/GetResourceShareInvitations

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/GetResourceShareInvitations

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/GetResourceShareInvitations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/GetResourceShareInvitations

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/GetResourceShareInvitations

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/GetResourceShareInvitations

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/GetResourceShareInvitations

AWS Resource Access Manager API ReferenceGetResourceShares

GetResourceSharesGets the resource shares that you own or the resource shares that are shared with you.

Request SyntaxPOST /getresourceshares HTTP/1.1Content-type: application/json

{ "maxResults": number, "name": "string", "nextToken": "string", "resourceOwner": "string", "resourceShareArns": [ "string" ], "resourceShareStatus": "string", "tagFilters": [ { "tagKey": "string", "tagValues": [ "string" ] } ]}



maxResults (p. 41)


Type: Integer




Type: String



Type: String

Required: No



resourceOwner (p. 41)

The type of owner.

Type: String

Valid Values: SELF | OTHER-ACCOUNTS

Required: YesresourceShareArns (p. 41)



Required: NoresourceShareStatus (p. 41)

The status of the resource share.

Type: String

Valid Values: PENDING | ACTIVE | FAILED | DELETING | DELETED

Required: NotagFilters (p. 41)

One or more tag filters.

Type: Array of TagFilter (p. 89) objects

Required: No


{ "nextToken": "string", "resourceShares": [ { "allowExternalPrincipals": boolean, "creationTime": number, "featureSet": "string", "lastUpdatedTime": number, "name": "string", "owningAccountId": "string", "resourceShareArn": "string", "status": "string", "statusMessage": "string", "tags": [ { "key": "string", "value": "string" } ] } ]}





nextToken (p. 42)


Type: StringresourceShares (p. 42)

Information about the resource shares.

Type: Array of ResourceShare (p. 78) objects




















https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/GetResourceShares

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/GetResourceShares

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/GetResourceShares

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/GetResourceShares

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/GetResourceShares

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/GetResourceShares

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/GetResourceShares

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/GetResourceShares

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/GetResourceShares

AWS Resource Access Manager API ReferenceListPendingInvitationResources

ListPendingInvitationResourcesLists the resources in a resource share that is shared with you but that the invitation is still pending for.

Request SyntaxPOST /listpendinginvitationresources HTTP/1.1Content-type: application/json

{ "maxResults": number, "nextToken": "string", "resourceShareInvitationArn": "string"}



maxResults (p. 45)


Type: Integer




Type: String



Type: String

Required: Yes


{



"nextToken": "string", "resources": [ { "arn": "string", "creationTime": number, "lastUpdatedTime": number, "resourceGroupArn": "string", "resourceShareArn": "string", "status": "string", "statusMessage": "string", "type": "string" } ]}



nextToken (p. 45)


Type: Stringresources (p. 45)

Information about the resources included the resource share.

Type: Array of Resource (p. 76) objects








HTTP Status Code: 400MissingRequiredParameterException

A required input parameter is missing.




ResourceShareInvitationAlreadyRejectedException














https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/ListPendingInvitationResources

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/ListPendingInvitationResources

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ListPendingInvitationResources

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ListPendingInvitationResources

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ListPendingInvitationResources

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/ListPendingInvitationResources

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/ListPendingInvitationResources

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/ListPendingInvitationResources

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ListPendingInvitationResources

AWS Resource Access Manager API ReferenceListPermissions

ListPermissionsLists the AWS RAM permissions.

Request SyntaxPOST /listpermissions HTTP/1.1Content-type: application/json

{ "maxResults": number, "nextToken": "string", "resourceType": "string"}



maxResults (p. 48)


Type: Integer




Type: String

Required: NoresourceType (p. 48)

Specifies the resource type for which to list permissions. For example, to list only permissions thatapply to EC2 subnets, specify ec2:Subnet.

Type: String

Required: No




{ "nextToken": "string", "permissions": [ { "arn": "string", "creationTime": number, "defaultVersion": boolean, "lastUpdatedTime": number, "name": "string", "resourceType": "string", "status": "string", "version": "string" } ]}



nextToken (p. 48)


Type: Stringpermissions (p. 48)

Information about the permissions.

Type: Array of ResourceSharePermissionSummary (p. 86) objects



















https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/ListPermissions

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/ListPermissions

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ListPermissions

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ListPermissions

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ListPermissions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/ListPermissions

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/ListPermissions

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/ListPermissions

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ListPermissions

AWS Resource Access Manager API ReferenceListPrincipals

ListPrincipalsLists the principals that you have shared resources with or that have shared resources with you.

Request SyntaxPOST /listprincipals HTTP/1.1Content-type: application/json

{ "maxResults": number, "nextToken": "string", "principals": [ "string" ], "resourceArn": "string", "resourceOwner": "string", "resourceShareArns": [ "string" ], "resourceType": "string"}



maxResults (p. 51)


Type: Integer




Type: String


The principals.


Required: NoresourceArn (p. 51)

The Amazon Resource Name (ARN) of the resource.

Type: String

Required: No



resourceOwner (p. 51)

The type of owner.

Type: String






The resource type.

Valid values: appmesh:Mesh | codebuild:Project | codebuild:ReportGroup| ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet |ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component| imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster |route53resolver:ResolverRule

Type: String

Required: No


{ "nextToken": "string", "principals": [ { "creationTime": number, "external": boolean, "id": "string", "lastUpdatedTime": number, "resourceShareArn": "string" } ]}



nextToken (p. 52)




Type: Stringprincipals (p. 52)

The principals.

Type: Array of Principal (p. 75) objects
















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python


https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/ListPrincipals

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/ListPrincipals

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ListPrincipals

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ListPrincipals

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ListPrincipals

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/ListPrincipals

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/ListPrincipals

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/ListPrincipals


• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ListPrincipals

AWS Resource Access Manager API ReferenceListResources

ListResourcesLists the resources that you added to a resource shares or the resources that are shared with you.

Request SyntaxPOST /listresources HTTP/1.1Content-type: application/json

{ "maxResults": number, "nextToken": "string", "principal": "string", "resourceArns": [ "string" ], "resourceOwner": "string", "resourceShareArns": [ "string" ], "resourceType": "string"}



maxResults (p. 55)


Type: Integer




Type: String


The principal.

Type: String






Required: NoresourceOwner (p. 55)

The type of owner.

Type: String






The resource type.

Valid values: appmesh:Mesh | codebuild:Project | codebuild:ReportGroup| ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet |ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component| imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster |route53resolver:ResolverRule

Type: String

Required: No


{ "nextToken": "string", "resources": [ { "arn": "string", "creationTime": number, "lastUpdatedTime": number, "resourceGroupArn": "string", "resourceShareArn": "string", "status": "string", "statusMessage": "string", "type": "string" } ]}





nextToken (p. 56)


Type: Stringresources (p. 56)

Information about the resources.

Type: Array of Resource (p. 76) objects






HTTP Status Code: 400InvalidResourceTypeException

The specified resource type is not valid.















https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/ListResources

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/ListResources

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ListResources

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ListResources

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ListResources

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/ListResources

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/ListResources

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/ListResources

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ListResources

AWS Resource Access Manager API ReferenceListResourceSharePermissions

ListResourceSharePermissionsLists the AWS RAM permissions that are associated with a resource share.

Request SyntaxPOST /listresourcesharepermissions HTTP/1.1Content-type: application/json

{ "maxResults": number, "nextToken": "string", "resourceShareArn": "string"}



maxResults (p. 59)


Type: Integer




Type: String



Type: String

Required: Yes


{



"nextToken": "string", "permissions": [ { "arn": "string", "creationTime": number, "defaultVersion": boolean, "lastUpdatedTime": number, "name": "string", "resourceType": "string", "status": "string", "version": "string" } ]}



nextToken (p. 59)


Type: Stringpermissions (p. 59)

The permissions associated with the resource share.

Type: Array of ResourceSharePermissionSummary (p. 86) objects













ServerInternalException










https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/ListResourceSharePermissions

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/ListResourceSharePermissions

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ListResourceSharePermissions

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ListResourceSharePermissions

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ListResourceSharePermissions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/ListResourceSharePermissions

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/ListResourceSharePermissions

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/ListResourceSharePermissions

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ListResourceSharePermissions

AWS Resource Access Manager API ReferencePromoteResourceShareCreatedFromPolicy

PromoteResourceShareCreatedFromPolicyResource shares that were created by attaching a policy to a resource are visible only to the resourceshare owner, and the resource share cannot be modified in AWS RAM.

Use this API action to promote the resource share. When you promote the resource share, it becomes:

• Visible to all principals that it is shared with.• Modifiable in AWS RAM.

Request SyntaxPOST /promoteresourcesharecreatedfrompolicy?resourceShareArn=resourceShareArn HTTP/1.1

URI Request ParametersThe request requires the following URI parameters.


The ARN of the resource share to promote.



{ "returnValue": boolean}



returnValue (p. 62)


Type: Boolean




















https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

AWS Resource Access Manager API ReferenceRejectResourceShareInvitation

RejectResourceShareInvitationRejects an invitation to a resource share from another AWS account.

Request SyntaxPOST /rejectresourceshareinvitation HTTP/1.1Content-type: application/json

{ "clientToken": "string", "resourceShareInvitationArn": "string"}



clientToken (p. 64)


Type: String



Type: String

Required: Yes


{ "clientToken": "string", "resourceShareInvitation": { "invitationTimestamp": number, "receiverAccountId": "string", "resourceShareArn": "string", "resourceShareAssociations": [ { "associatedEntity": "string", "associationType": "string", "creationTime": number, "external": boolean, "lastUpdatedTime": number,



"resourceShareArn": "string", "resourceShareName": "string", "status": "string", "statusMessage": "string" } ], "resourceShareInvitationArn": "string", "resourceShareName": "string", "senderAccountId": "string", "status": "string" }}



clientToken (p. 64)


Type: StringresourceShareInvitation (p. 64)

Information about the invitation.

Type: ResourceShareInvitation (p. 82) object










HTTP Status Code: 400ResourceShareInvitationAlreadyAcceptedException

The invitation was already accepted.



HTTP Status Code: 400ResourceShareInvitationAlreadyRejectedException














https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/RejectResourceShareInvitation

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/RejectResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/RejectResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/RejectResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/RejectResourceShareInvitation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/RejectResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/RejectResourceShareInvitation

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/RejectResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/RejectResourceShareInvitation

AWS Resource Access Manager API ReferenceTagResource

TagResourceAdds the specified tags to the specified resource share that you own.

Request SyntaxPOST /tagresource HTTP/1.1Content-type: application/json

{ "resourceShareArn": "string", "tags": [ { "key": "string", "value": "string" } ]}





Type: String

Required: Yestags (p. 67)

One or more tags.


Required: Yes


Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.








HTTP Status Code: 400ResourceArnNotFoundException

An Amazon Resource Name (ARN) was not found.





HTTP Status Code: 503TagLimitExceededException

The requested tags exceed the limit for your account.

HTTP Status Code: 400TagPolicyViolationException

The specified tag is a reserved word and cannot be used.





https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/TagResource

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/TagResource

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/TagResource

AWS Resource Access Manager API ReferenceUntagResource

UntagResourceRemoves the specified tags from the specified resource share that you own.

Request SyntaxPOST /untagresource HTTP/1.1Content-type: application/json

{ "resourceShareArn": "string", "tagKeys": [ "string" ]}





Type: String

Required: YestagKeys (p. 69)

The tag keys of the tags to remove.


Required: Yes


Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.














https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/UntagResource

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/UntagResource

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/UntagResource

AWS Resource Access Manager API ReferenceUpdateResourceShare

UpdateResourceShareUpdates the specified resource share that you own.

Request SyntaxPOST /updateresourceshare HTTP/1.1Content-type: application/json

{ "allowExternalPrincipals": boolean, "clientToken": "string", "name": "string", "resourceShareArn": "string"}



allowExternalPrincipals (p. 71)


Type: Boolean

Required: NoclientToken (p. 71)


Type: String



Type: String



Type: String

Required: Yes





{ "clientToken": "string", "resourceShare": { "allowExternalPrincipals": boolean, "creationTime": number, "featureSet": "string", "lastUpdatedTime": number, "name": "string", "owningAccountId": "string", "resourceShareArn": "string", "status": "string", "statusMessage": "string", "tags": [ { "key": "string", "value": "string" } ] }}



clientToken (p. 71)


Type: StringresourceShare (p. 71)

Information about the resource share.

Type: ResourceShare (p. 78) object


























https://docs.aws.amazon.com/goto/aws-cli/ram-2018-01-04/UpdateResourceShare

https://docs.aws.amazon.com/goto/DotNetSDKV3/ram-2018-01-04/UpdateResourceShare

https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/UpdateResourceShare

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/UpdateResourceShare

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/UpdateResourceShare

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/ram-2018-01-04/UpdateResourceShare

https://docs.aws.amazon.com/goto/SdkForPHPV3/ram-2018-01-04/UpdateResourceShare

https://docs.aws.amazon.com/goto/boto3/ram-2018-01-04/UpdateResourceShare

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/UpdateResourceShare


Data TypesThe AWS Resource Access Manager API contains several data types that various actions use. This sectiondescribes each data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• Principal (p. 75)• Resource (p. 76)• ResourceShare (p. 78)• ResourceShareAssociation (p. 80)• ResourceShareInvitation (p. 82)• ResourceSharePermissionDetail (p. 84)• ResourceSharePermissionSummary (p. 86)• Tag (p. 88)• TagFilter (p. 89)


AWS Resource Access Manager API ReferencePrincipal

PrincipalDescribes a principal for use with AWS Resource Access Manager.

ContentscreationTime

The time when the principal was associated with the resource share.

Type: Timestamp

Required: Noexternal

Indicates whether the principal belongs to the same AWS organization as the AWS account thatowns the resource share.

Type: Boolean

Required: Noid

The ID of the principal.

Type: String

Required: NolastUpdatedTime

The time when the association was last updated.

Type: Timestamp

Required: NoresourceShareArn


Type: String

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/Principal

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/Principal

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/Principal

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/Principal

AWS Resource Access Manager API ReferenceResource

ResourceDescribes a resource associated with a resource share.

Contentsarn

The Amazon Resource Name (ARN) of the resource.

Type: String

Required: NocreationTime

The time when the resource was associated with the resource share.

Type: Timestamp



Type: Timestamp

Required: NoresourceGroupArn

The ARN of the resource group. This value is returned only if the resource is a resource group.

Type: String



Type: String

Required: Nostatus

The status of the resource.

Type: String

Valid Values: AVAILABLE | ZONAL_RESOURCE_INACCESSIBLE | LIMIT_EXCEEDED |UNAVAILABLE | PENDING

Required: NostatusMessage

A message about the status of the resource.

Type: String

Required: No



type

The resource type.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/Resource

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/Resource

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/Resource

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/Resource

AWS Resource Access Manager API ReferenceResourceShare

ResourceShareDescribes a resource share.

ContentsallowExternalPrincipals


Type: Boolean


The time when the resource share was created.

Type: Timestamp

Required: NofeatureSet

Indicates how the resource share was created. Possible values include:• CREATED_FROM_POLICY - Indicates that the resource share was created from an AWS Identity

and Access Management (AWS IAM) policy attached to a resource. These resource shares are visibleonly to the AWS account that created it. They cannot be modified in AWS RAM.

• PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For moreinformation, see PromoteResourceShareCreatedFromPolicy (p. 62).

• STANDARD - Indicates that the resource share was created in AWS RAM using the console or APIs.These resource shares are visible to all principals. They can be modified in AWS RAM.

Type: String

Valid Values: CREATED_FROM_POLICY | PROMOTING_TO_STANDARD | STANDARD


The time when the resource share was last updated.

Type: Timestamp

Required: Noname


Type: String

Required: NoowningAccountId

The ID of the AWS account that owns the resource share.

Type: String

Required: No



resourceShareArn


Type: String

Required: Nostatus

The status of the resource share.

Type: String

Valid Values: PENDING | ACTIVE | FAILED | DELETING | DELETED


A message about the status of the resource share.

Type: String

Required: Notags

The tags for the resource share.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ResourceShare

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ResourceShare

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ResourceShare

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ResourceShare

AWS Resource Access Manager API ReferenceResourceShareAssociation

ResourceShareAssociationDescribes an association with a resource share.

ContentsassociatedEntity

The associated entity. For resource associations, this is the ARN of the resource. For principalassociations, this is the ID of an AWS account or the ARN of an OU or organization from AWSOrganizations.

Type: String

Required: NoassociationType

The association type.

Type: String

Valid Values: PRINCIPAL | RESOURCE


The time when the association was created.

Type: Timestamp

Required: Noexternal

Indicates whether the principal belongs to the same AWS organization as the AWS account thatowns the resource share.

Type: Boolean



Type: Timestamp



Type: String

Required: NoresourceShareName


Type: String



Required: Nostatus

The status of the association.

Type: String

Valid Values: ASSOCIATING | ASSOCIATED | FAILED | DISASSOCIATING |DISASSOCIATED


A message about the status of the association.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ResourceShareAssociation

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ResourceShareAssociation

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ResourceShareAssociation

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ResourceShareAssociation

AWS Resource Access Manager API ReferenceResourceShareInvitation

ResourceShareInvitationDescribes an invitation to join a resource share.

ContentsinvitationTimestamp

The date and time when the invitation was sent.

Type: Timestamp

Required: NoreceiverAccountId

The ID of the AWS account that received the invitation.

Type: String



Type: String

Required: NoresourceShareAssociations

This member has been deprecated.

To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.


Required: NoresourceShareInvitationArn


Type: String

Required: NoresourceShareName


Type: String

Required: NosenderAccountId

The ID of the AWS account that sent the invitation.

Type: String

Required: No


https://docs.aws.amazon.com/ram/latest/APIReference/API_ListPendingInvitationResources.html

https://docs.aws.amazon.com/ram/latest/APIReference/API_ListPendingInvitationResources.html


status

The status of the invitation.

Type: String

Valid Values: PENDING | ACCEPTED | REJECTED | EXPIRED

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ResourceShareInvitation

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ResourceShareInvitation

AWS Resource Access Manager API ReferenceResourceSharePermissionDetail

ResourceSharePermissionDetailInformation about an AWS RAM permission.

Contentsarn


Type: String


The date and time when the permission was created.

Type: Timestamp

Required: NodefaultVersion

The identifier for the version of the permission that is set as the default version.

Type: Boolean


The date and time when the permission was last updated.

Type: Timestamp

Required: Noname

The name of the permission.

Type: String

Required: Nopermission

The permission's effect and actions in JSON format. The effect indicates whether the actions areallowed or denied. The actions list the API actions to which the principal is granted or deniedaccess.

Type: String

Required: NoresourceType

The resource type to which the permission applies.

Type: String

Required: No



version


Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ResourceSharePermissionDetail

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ResourceSharePermissionDetail

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ResourceSharePermissionDetail

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ResourceSharePermissionDetail

AWS Resource Access Manager API ReferenceResourceSharePermissionSummary

ResourceSharePermissionSummaryInformation about a permission that is associated with a resource share.

Contentsarn


Type: String


The date and time when the permission was created.

Type: Timestamp

Required: NodefaultVersion

The identifier for the version of the permission that is set as the default version.

Type: Boolean


The date and time when the permission was last updated.

Type: Timestamp

Required: Noname

The name of the permission.

Type: String

Required: NoresourceType

The type of resource to which the permission applies.

Type: String

Required: Nostatus

The current status of the permission.

Type: String

Required: Noversion




Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/ResourceSharePermissionSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/ResourceSharePermissionSummary

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/ResourceSharePermissionSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/ResourceSharePermissionSummary

AWS Resource Access Manager API ReferenceTag

TagInformation about a tag.

Contentskey

The key of the tag.

Type: String

Required: Novalue

The value of the tag.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/Tag

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/Tag

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/Tag

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/Tag

AWS Resource Access Manager API ReferenceTagFilter

TagFilterUsed to filter information based on tags.

ContentstagKey

The tag key.

Type: String

Required: NotagValues

The tag values.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/ram-2018-01-04/TagFilter

https://docs.aws.amazon.com/goto/SdkForGoV1/ram-2018-01-04/TagFilter

https://docs.aws.amazon.com/goto/SdkForJava/ram-2018-01-04/TagFilter

https://docs.aws.amazon.com/goto/SdkForRubyV3/ram-2018-01-04/TagFilter


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



Documents

AWS Resource Access Manager · A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request. Type: String resourceShareAssociations (p. 6) Information