Schemas / Client / search_schemas

search_schemas#

Schemas.Client.search_schemas(**kwargs)#

Search the schemas

See also: AWS API Documentation

Request Syntax

response = client.search_schemas(
    Keywords='string',
    Limit=123,
    NextToken='string',
    RegistryName='string'
)
Parameters:

  • Keywords (string) –

    [REQUIRED]

    Specifying this limits the results to only schemas that include the provided keywords.

  • Limit (integer) –

  • NextToken (string) – The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

  • RegistryName (string) –

    [REQUIRED]

    The name of the registry.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Schemas': [
        {
            'RegistryName': 'string',
            'SchemaArn': 'string',
            'SchemaName': 'string',
            'SchemaVersions': [
                {
                    'CreatedDate': datetime(2015, 1, 1),
                    'SchemaVersion': 'string',
                    'Type': 'OpenApi3'|'JSONSchemaDraft4'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    200 response

    • NextToken (string) –

      The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    • Schemas (list) –

      An array of SearchSchemaSummary information.

      • (dict) –

        • RegistryName (string) –

          The name of the registry.

        • SchemaArn (string) –

          The ARN of the schema.

        • SchemaName (string) –

          The name of the schema.

        • SchemaVersions (list) –

          An array of schema version summaries.

          • (dict) –

            • CreatedDate (datetime) –

              The date the schema version was created.

            • SchemaVersion (string) –

              The version number of the schema

            • Type (string) –

              The type of schema.

Exceptions

  • Schemas.Client.exceptions.ServiceUnavailableException

  • Schemas.Client.exceptions.BadRequestException

  • Schemas.Client.exceptions.UnauthorizedException

  • Schemas.Client.exceptions.InternalServerErrorException

  • Schemas.Client.exceptions.ForbiddenException