Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateResourceShare

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.

Note

Sharing a resource makes it available for use by principals outside of the AWS 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" ],
   "sources": [ "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.

name

Specifies the name of the resource share.

Type: String

Required: Yes

allowExternalPrincipals

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

Type: Boolean

Required: No

clientToken

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 AWS generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Type: String

Required: No

permissionArns

Specifies the Amazon Resource Names (ARNs) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS 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

principals

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

You can include the following values:

An AWS account ID, for example: 123456789012
An Amazon Resource Name (ARN) of an organization in AWS Organizations, for example: arn:aws:organizations::123456789012:organization/o-exampleorgid
An ARN of an organizational unit (OU) in AWS 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
A service principal name, for example: service-id.amazonaws.com

Note

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

Type: Array of strings

Required: No

resourceArns

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

Type: Array of strings

Required: No

sources

Specifies from which source accounts the service principal has access to the resources in this resource share.

Type: Array of strings

Required: No

tags

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.

clientToken

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

resourceShare

An object with information about the new resource share.

Type: ResourceShare object

Errors

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

IdempotentParameterMismatchException

The operation failed because the client token input parameter matched one that was 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

InvalidClientTokenException

The operation failed because the specified client token isn't valid.

HTTP Status Code: 400

InvalidParameterException

The operation failed because a parameter you specified isn't valid.

HTTP Status Code: 400

InvalidStateTransitionException

The operation failed because the requested operation isn't valid for the resource share in its current state.

HTTP Status Code: 400

MalformedArnException

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

HTTP Status Code: 400

OperationNotPermittedException

The operation failed because the requested operation isn't permitted.

HTTP Status Code: 400

ResourceShareLimitExceededException

The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your AWS account, see the AWS RAM page in the Service Quotas console.

HTTP Status Code: 400

ServerInternalException

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

HTTP Status Code: 500

ServiceUnavailableException

The operation failed because the service isn't available. Try again later.

HTTP Status Code: 503

TagPolicyViolationException

The operation failed because the specified tag key is a reserved word and can't be used.

HTTP Status Code: 400

UnknownResourceException

The operation failed because a specified resource couldn't be found.

HTTP Status Code: 400