RAM / Client / delete_resource_share

delete_resource_share#

RAM.Client.delete_resource_share(**kwargs)#

Deletes the specified resource share.

Warning

This doesn’t delete any of the resources that were associated with the resource share; it only stops the sharing of those resources through this resource share.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource_share(
    resourceShareArn='string',
    clientToken='string'
)
Parameters:
  • resourceShareArn (string) –

    [REQUIRED]

    Specifies the Amazon Resource Name (ARN) of the resource share 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'
}

Response Structure

  • (dict) –

    • returnValue (boolean) –

      A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

    • 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.

Exceptions