Glue / Client / get_schema
get_schema#
- Glue.Client.get_schema(**kwargs)#
Describes the specified schema in detail.
See also: AWS API Documentation
Request Syntax
response = client.get_schema( SchemaId={ 'SchemaArn': 'string', 'SchemaName': 'string', 'RegistryName': 'string' } )
- Parameters:
SchemaId (dict) –
[REQUIRED]
This is a wrapper structure to contain schema identity fields. The structure contains:
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
SchemaArn (string) –
The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName (string) –
The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName (string) –
The name of the schema registry that contains the schema.
- Return type:
dict
- Returns:
Response Syntax
{ 'RegistryName': 'string', 'RegistryArn': 'string', 'SchemaName': 'string', 'SchemaArn': 'string', 'Description': 'string', 'DataFormat': 'AVRO'|'JSON'|'PROTOBUF', 'Compatibility': 'NONE'|'DISABLED'|'BACKWARD'|'BACKWARD_ALL'|'FORWARD'|'FORWARD_ALL'|'FULL'|'FULL_ALL', 'SchemaCheckpoint': 123, 'LatestSchemaVersion': 123, 'NextSchemaVersion': 123, 'SchemaStatus': 'AVAILABLE'|'PENDING'|'DELETING', 'CreatedTime': 'string', 'UpdatedTime': 'string' }
Response Structure
(dict) –
RegistryName (string) –
The name of the registry.
RegistryArn (string) –
The Amazon Resource Name (ARN) of the registry.
SchemaName (string) –
The name of the schema.
SchemaArn (string) –
The Amazon Resource Name (ARN) of the schema.
Description (string) –
A description of schema if specified when created
DataFormat (string) –
The data format of the schema definition. Currently
AVRO
,JSON
andPROTOBUF
are supported.Compatibility (string) –
The compatibility mode of the schema.
SchemaCheckpoint (integer) –
The version number of the checkpoint (the last time the compatibility mode was changed).
LatestSchemaVersion (integer) –
The latest version of the schema associated with the returned schema definition.
NextSchemaVersion (integer) –
The next version of the schema associated with the returned schema definition.
SchemaStatus (string) –
The status of the schema.
CreatedTime (string) –
The date and time the schema was created.
UpdatedTime (string) –
The date and time the schema was updated.
Exceptions