RAM / Client / set_default_permission_version

set_default_permission_version#

RAM.Client.set_default_permission_version(**kwargs)#

Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.

See also: AWS API Documentation

Request Syntax

response = client.set_default_permission_version(
    permissionArn='string',
    permissionVersion=123,
    clientToken='string'
)
Parameters:

  • permissionArn (string) –

    [REQUIRED]

    Specifies the Amazon Resource Name (ARN) of the customer managed permission whose default version you want to change.

  • permissionVersion (integer) –

    [REQUIRED]

    Specifies the version number that you want to designate as the default for customer managed permission. To see a list of all available version numbers, use ListPermissionVersions.

  • 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 boolean value that indicates whether the operation was successful.

    • 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

  • RAM.Client.exceptions.InvalidParameterException

  • RAM.Client.exceptions.MalformedArnException

  • RAM.Client.exceptions.ServerInternalException

  • RAM.Client.exceptions.ServiceUnavailableException

  • RAM.Client.exceptions.UnknownResourceException

  • RAM.Client.exceptions.InvalidClientTokenException

  • RAM.Client.exceptions.IdempotentParameterMismatchException