CreateResourceShare
Creates a resource share.
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.
- allowExternalPrincipals
-
Indicates whether principals outside your AWS organization can be associated with a resource share.
Type: Boolean
Required: No
- clientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Required: No
- name
-
The name of the resource share.
Type: String
Required: Yes
- permissionArns
-
The ARNs of the permissions 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.
Type: Array of strings
Required: No
- principals
-
The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.
Type: Array of strings
Required: No
- resourceArns
-
The Amazon Resource Names (ARN) of the resources to associate with the resource share.
Type: Array of strings
Required: No
- tags
-
One or more tags.
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
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
- resourceShare
-
Information about the resource share.
Type: ResourceShare object
Errors
For information about the errors that are common to all actions, see Common Errors.
- IdempotentParameterMismatchException
-
A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.
HTTP Status Code: 400
- InvalidClientTokenException
-
A client token is not valid.
HTTP Status Code: 400
- InvalidParameterException
-
A parameter is not valid.
HTTP Status Code: 400
- InvalidStateTransitionException
-
The requested state transition is not valid.
HTTP Status Code: 400
- MalformedArnException
-
The format of an Amazon Resource Name (ARN) is not valid.
HTTP Status Code: 400
- OperationNotPermittedException
-
The requested operation is not permitted.
HTTP Status Code: 400
- ResourceShareLimitExceededException
-
The requested resource share exceeds the limit for your account.
HTTP Status Code: 400
- ServerInternalException
-
The service could not respond to the request due to an internal problem.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is not available.
HTTP Status Code: 503
- TagPolicyViolationException
-
The specified tag is a reserved word and cannot be used.
HTTP Status Code: 400
- UnknownResourceException
-
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 AWS SDKs, see the following: