Glue / Client / delete_schema

delete_schema#

Glue.Client.delete_schema(**kwargs)#

Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.

See also: AWS API Documentation

Request Syntax

response = client.delete_schema(
    SchemaId={
        'SchemaArn': 'string',
        'SchemaName': 'string',
        'RegistryName': 'string'
    }
)
Parameters:

SchemaId (dict) –

[REQUIRED]

This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

  • SchemaArn (string) –

    The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

  • SchemaName (string) –

    The name of the schema. One of SchemaArn or SchemaName has to be provided.

  • RegistryName (string) –

    The name of the schema registry that contains the schema.

Return type:

dict

Returns:

Response Syntax

{
    'SchemaArn': 'string',
    'SchemaName': 'string',
    'Status': 'AVAILABLE'|'PENDING'|'DELETING'
}

Response Structure

  • (dict) –

    • SchemaArn (string) –

      The Amazon Resource Name (ARN) of the schema being deleted.

    • SchemaName (string) –

      The name of the schema being deleted.

    • Status (string) –

      The status of the schema.

Exceptions

  • Glue.Client.exceptions.InvalidInputException

  • Glue.Client.exceptions.EntityNotFoundException

  • Glue.Client.exceptions.AccessDeniedException

  • Glue.Client.exceptions.ConcurrentModificationException