Discover - Amazon EventBridge Schemas

Discover

Allows you get the discovered schemas that have been inferred from events on an event bus.

URI

/v1/discover

HTTP Methods

POST

Operation ID: GetDiscoveredSchema

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

Responses
Status Code Response Model Description
200 GetDiscoveredSchemaOutput

200 response

400 ErrorOutput

400 response

401 ErrorOutput

401 response

403 ErrorOutput

403 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

Schemas

Request Bodies

Example POST

{ "Type": enum, "Events": [ "string" ] }

Response Bodies

Example GetDiscoveredSchemaOutput

{ "Content": "string" }

Example ErrorOutput

{ "Message": "string", "Code": "string" }

Properties

ErrorOutput

Property Type Required Description
Message

string

True

The message string of the error output.

Code

string

True

The error code.

GetDiscoveredSchemaInput

Property Type Required Description
Type

Type

True

The type of event.

Events

Array of type string

True

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.

GetDiscoveredSchemaOutput

Property Type Required Description
Content

string

False

The source of the schema definition.

Type

The type of schema to export.

  • OpenApi3

  • JSONSchemaDraft4