Keyspaces / Client / delete_type

delete_type

Keyspaces.Client.delete_type(**kwargs)

The DeleteType operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table or another UDT.

To configure the required permissions, see Permissions to delete a UDT in the Amazon Keyspaces Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_type(
    keyspaceName='string',
    typeName='string'
)

Parameters:

• keyspaceName (string) –

  [REQUIRED]

  The name of the keyspace of the to be deleted type.

• typeName (string) –

  [REQUIRED]

  The name of the type to be deleted.

Return type:

dict

Returns:

Response Syntax

{
    'keyspaceArn': 'string',
    'typeName': 'string'
}

Response Structure

• (dict) –

  • keyspaceArn (string) –

    The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource Name (ARN).

  • typeName (string) –

    The name of the type that was deleted.

Exceptions

• Keyspaces.Client.exceptions.ValidationException

• Keyspaces.Client.exceptions.ServiceQuotaExceededException

• Keyspaces.Client.exceptions.InternalServerException

• Keyspaces.Client.exceptions.ConflictException

• Keyspaces.Client.exceptions.AccessDeniedException

• Keyspaces.Client.exceptions.ResourceNotFoundException