Glue / Client / list_schemas

list_schemas#

Glue.Client.list_schemas(**kwargs)#

Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.

When the RegistryId is not provided, all the schemas across registries will be part of the API response.

See also: AWS API Documentation

Request Syntax

response = client.list_schemas(
    RegistryId={
        'RegistryName': 'string',
        'RegistryArn': 'string'
    },
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • RegistryId (dict) –

    A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

    • RegistryName (string) –

      Name of the registry. Used only for lookup. One of RegistryArn or RegistryName has to be provided.

    • RegistryArn (string) –

      Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.

  • MaxResults (integer) – Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

  • NextToken (string) – A continuation token, if this is a continuation call.

Return type:

dict

Returns:

Response Syntax

{
    'Schemas': [
        {
            'RegistryName': 'string',
            'SchemaName': 'string',
            'SchemaArn': 'string',
            'Description': 'string',
            'SchemaStatus': 'AVAILABLE'|'PENDING'|'DELETING',
            'CreatedTime': 'string',
            'UpdatedTime': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Schemas (list) –

      An array of SchemaListItem objects containing details of each schema.

      • (dict) –

        An object that contains minimal details for a schema.

        • RegistryName (string) –

          the name of the registry where the schema resides.

        • SchemaName (string) –

          The name of the schema.

        • SchemaArn (string) –

          The Amazon Resource Name (ARN) for the schema.

        • Description (string) –

          A description for the schema.

        • SchemaStatus (string) –

          The status of the schema.

        • CreatedTime (string) –

          The date and time that a schema was created.

        • UpdatedTime (string) –

          The date and time that a schema was updated.

    • NextToken (string) –

      A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Exceptions

  • Glue.Client.exceptions.InvalidInputException

  • Glue.Client.exceptions.AccessDeniedException

  • Glue.Client.exceptions.EntityNotFoundException

  • Glue.Client.exceptions.InternalServiceException