RAM / Client / delete_permission

delete_permission#

RAM.Client.delete_permission(**kwargs)#

Deletes the specified customer managed permission in the Amazon Web Services 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.

See also: AWS API Documentation

Request Syntax

response = client.delete_permission(
    permissionArn='string',
    clientToken='string'
)
Parameters:

  • permissionArn (string) –

    [REQUIRED]

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

  • clientToken (string) –

    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 Web Services 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.

Return type:

dict

Returns:

Response Syntax

{
    'returnValue': True|False,
    'clientToken': 'string',
    'permissionStatus': 'ATTACHABLE'|'UNATTACHABLE'|'DELETING'|'DELETED'
}

Response Structure

  • (dict) –

    • returnValue (boolean) –

      A boolean that indicates whether the delete operations succeeded.

    • clientToken (string) –

      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.

    • permissionStatus (string) –

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

Exceptions