CreatePermission - 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 customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.

Request Syntax

POST /createpermission HTTP/1.1 Content-type: application/json { "clientToken": "string", "name": "string", "policyTemplate": "string", "resourceType": "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 customer managed permission. The name must be unique within the Amazon Web Services Region.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: [\w.-]*

Required: Yes


A string in JSON format string that contains the following elements of a resource-based policy:

  • Effect: must be set to ALLOW.

  • Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon services in the Amazon Identity and Access Management User Guide.

  • Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Amazon Identity and Access Management User Guide.

This template can't include either the Resource or Principal elements. Those are both filled in by Amazon RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

Type: String

Required: Yes


Specifies the name of the resource type that this customer managed permission applies to.

The format is <service-code>:<resource-type> and is not case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet. To see the list of valid values for this parameter, query the ListResourceTypes operation.

Type: String

Required: Yes


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.

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

Type: String

Required: No


Specifies a list of one or more tag key and value pairs to attach to the permission.

Type: Array of Tag objects

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "clientToken": "string", "permission": { "arn": "string", "creationTime": number, "defaultVersion": boolean, "featureSet": "string", "isResourceTypeDefault": boolean, "lastUpdatedTime": number, "name": "string", "permissionType": "string", "resourceType": "string", "status": "string", "tags": [ { "key": "string", "value": "string" } ], "version": "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


A structure with information about this customer managed permission.

Type: ResourceSharePermissionSummary object


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


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


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

HTTP Status Code: 400


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

HTTP Status Code: 400


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

HTTP Status Code: 400


The operation failed because the policy template that you provided isn't valid.

HTTP Status Code: 400


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

HTTP Status Code: 400


The operation failed because a permission with the specified name already exists in the requested Amazon Web Services Region. Choose a different name.

HTTP Status Code: 409


The operation failed because it would exceed the maximum number of permissions you can create in each Amazon Web Services Region. To view the limits for your Amazon Web Services account, see the Amazon RAM page in the Service Quotas console.

HTTP Status Code: 400


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

HTTP Status Code: 500


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

HTTP Status Code: 503

See Also

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