CreateResourceShare - Amazon RAM
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.


Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

Request Syntax

POST /createresourceshare HTTP/1.1 Content-type: application/json { "allowExternalPrincipals": boolean, "clientToken": "string", "name": "string", "permissionArns": [ "string" ], "principals": [ "string" ], "resourceArns": [ "string" ], "tags": [ { "key": "string", "value": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


Specifies the name of the resource share.

Type: String

Required: Yes


Specifies whether principals outside your organization in Amazon Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Organization. The default value is true.

Type: Boolean

Required: No


Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon generates a random one for you.

Type: String

Required: No


Specifies the Amazon Resource Names (ARNs) of the Amazon RAM permission to associate with the resource share. If you do not specify an ARN for the permission, Amazon RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

Type: Array of strings

Required: No


Specifies a list of one or more principals to associate with the resource share.

You can include the following values:

  • An Amazon Web Services account ID, for example: 123456789012

  • An Amazon Resoure Name (ARN) of an organization in Amazon Organizations, for example: arn:aws:organizations::123456789012:organization/o-exampleorgid

  • An ARN of an organizational unit (OU) in Amazon Organizations, for example: arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

  • An ARN of an IAM role, for example: arn:aws:iam::123456789012:role/rolename

  • An ARN of an IAM user, for example: arn:aws:iam::123456789012user/username


Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Amazon Resource Access Manager User Guide.

Type: Array of strings

Required: No


Specifies a list of one or more ARNs of the resources to associate with the resource share.

Type: Array of strings

Required: No


Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.

Type: Array of Tag objects

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "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" } ] } }

Response Elements

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

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


The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Type: String


An object with information about the new resource share.

Type: ResourceShare object


For information about the errors that are common to all actions, see Common Errors.


The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

HTTP Status Code: 400


The client token is not valid.

HTTP Status Code: 400


A parameter is not valid.

HTTP Status Code: 400


The requested state transition is not valid.

HTTP Status Code: 400


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

HTTP Status Code: 400


The requested operation is not permitted.

HTTP Status Code: 400


This request would exceed the limit for resource shares for your account.

HTTP Status Code: 400


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

HTTP Status Code: 500


The service is not available.

HTTP Status Code: 503


The specified tag key is a reserved word and can't be used.

HTTP Status Code: 400


A specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: