Discoverers - Amazon EventBridge Schemas

Discoverers

Discoverers allow you to infer EventBridge Schemas based on the events on an event bus.

URI

/v1/discoverers

HTTP methods

GET

Operation ID: ListDiscoverers

List the discoverers.

Query parameters
NameTypeRequiredDescription
sourceArnPrefixStringFalse

Specifying this limits the results to only those ARNs that start with the specified prefix.

limitStringFalse

The maximum number of results to return per page.

nextTokenStringFalse

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.

discovererIdPrefixStringFalse

Specifying this limits the results to only those discoverer IDs that start with the specified prefix.

Responses
Status codeResponse modelDescription
200ListDiscoverersOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

500ErrorOutput

500 response

503ErrorOutput

503 response

POST

Operation ID: CreateDiscoverer

Creates a discoverer.

Responses
Status codeResponse modelDescription
201DiscovererOutput

201 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

409ErrorOutput

409 response

500ErrorOutput

500 response

503ErrorOutput

503 response

OPTIONS

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "CrossAccount": boolean, "Description": "string", "SourceArn": "string", "tags": { } }

Response bodies

{ "NextToken": "string", "Discoverers": [ { "DiscovererArn": "string", "DiscovererId": "string", "CrossAccount": boolean, "SourceArn": "string", "State": enum, "tags": { } } ] }
{ "DiscovererArn": "string", "DiscovererId": "string", "CrossAccount": boolean, "Description": "string", "SourceArn": "string", "State": enum, "tags": { } }
{ "Message": "string", "Code": "string" }

Properties

CreateDiscovererInput

PropertyTypeRequiredDescription
CrossAccount

boolean

False

Allows for the discovery of the event schemas that are sent to the event bus from another account. (default: true)

Description

string

MinLength: 0

MaxLength: 256

False

A description for the discoverer.

SourceArn

string

MinLength: 20

MaxLength: 1600

True

The ARN of the event bus.

tags

Tags

False

Tags associated with the resource.

DiscovererOutput

PropertyTypeRequiredDescription
CrossAccount

boolean

False

Whether cross-account events are discovered.

Description

string

False

The description of the discoverer.

DiscovererArn

string

False

The ARN of the discoverer.

DiscovererId

string

False

The ID of the discoverer.

SourceArn

string

False

The ARN of the event bus.

State

DiscovererState

False

The state of the discoverer.

tags

Tags

False

Tags associated with the resource.

DiscovererState

  • STARTED

  • STOPPED

DiscovererSummary

A summary of the discoverer.

PropertyTypeRequiredDescription
CrossAccount

boolean

False

Whether cross-account events are discovered.

DiscovererArn

string

False

The ARN of the discoverer.

DiscovererId

string

False

The ID of the discoverer.

SourceArn

string

False

The ARN of the event bus.

State

DiscovererState

False

The state of the discoverer.

tags

Tags

False

Tags associated with the resource.

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.

ListDiscoverersOutput

PropertyTypeRequiredDescription
Discoverers

Array of type DiscovererSummary

False

An array of DiscovererSummary information.

NextToken

string

False

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.

Tags

Key-value pairs associated with a resource.

PropertyTypeRequiredDescription

*

string

False