DeletePermission - AWS RAM

DeletePermission

Deletes the specified customer managed permission in the AWS Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.

Request Syntax

DELETE /deletepermission?clientToken=clientToken&permissionArn=permissionArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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.

permissionArn

Specifies the Amazon Resource Name (ARN) of the customer managed permission that you want to delete.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "clientToken": "string", "permissionStatus": "string", "returnValue": boolean }

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

permissionStatus

This operation is performed asynchronously, and this response parameter indicates the current status.

Type: String

Valid Values: ATTACHABLE | UNATTACHABLE | DELETING | DELETED

returnValue

A boolean that indicates whether the delete operations succeeded.

Type: Boolean

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

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

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

UnknownResourceException

The operation failed because a specified resource couldn't be 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: