describe_schema

describe_schema(**kwargs)

Retrieve the schema definition.

See also: AWS API Documentation

Request Syntax

response = client.describe_schema(
    RegistryName='string',
    SchemaName='string',
    SchemaVersion='string'
)
Parameters
  • RegistryName (string) --

    [REQUIRED]

    The name of the registry.

  • SchemaName (string) --

    [REQUIRED]

    The name of the schema.

  • SchemaVersion (string) -- Specifying this limits the results to only this schema version.
Return type

dict

Returns

Response Syntax

{
    'Content': 'string',
    'Description': 'string',
    'LastModified': datetime(2015, 1, 1),
    'SchemaArn': 'string',
    'SchemaName': 'string',
    'SchemaVersion': 'string',
    'Tags': {
        'string': 'string'
    },
    'Type': 'string',
    'VersionCreatedDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    200 response

    • Content (string) --

      The source of the schema definition.

    • Description (string) --

      The description of the schema.

    • LastModified (datetime) --

      The date and time that schema was modified.

    • SchemaArn (string) --

      The ARN of the schema.

    • SchemaName (string) --

      The name of the schema.

    • SchemaVersion (string) --

      The version number of the schema

    • Tags (dict) --

      Tags associated with the resource.

      • (string) --
        • (string) --
    • Type (string) --

      The type of the schema.

    • VersionCreatedDate (datetime) --

      The date the schema version was created.

Exceptions

  • Schemas.Client.exceptions.BadRequestException
  • Schemas.Client.exceptions.UnauthorizedException
  • Schemas.Client.exceptions.InternalServerErrorException
  • Schemas.Client.exceptions.ForbiddenException
  • Schemas.Client.exceptions.NotFoundException
  • Schemas.Client.exceptions.ServiceUnavailableException