Schemas / Client / get_discovered_schema

get_discovered_schema#

Schemas.Client.get_discovered_schema(**kwargs)#

Get the discovered schema that was generated based on sampled events.

See also: AWS API Documentation

Request Syntax

response = client.get_discovered_schema(
    Events=[
        'string',
    ],
    Type='OpenApi3'|'JSONSchemaDraft4'
)
Parameters:
  • Events (list) –

    [REQUIRED]

    An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.

    • (string) –

  • Type (string) –

    [REQUIRED]

    The type of event.

Return type:

dict

Returns:

Response Syntax

{
    'Content': 'string'
}

Response Structure

  • (dict) –

    200 response

    • Content (string) –

      The source of the schema definition.

Exceptions

  • Schemas.Client.exceptions.ServiceUnavailableException

  • Schemas.Client.exceptions.BadRequestException

  • Schemas.Client.exceptions.UnauthorizedException

  • Schemas.Client.exceptions.InternalServerErrorException

  • Schemas.Client.exceptions.ForbiddenException