Describe or Update Discoverer - Amazon EventBridge Schemas

Describe or Update Discoverer

URI

/v1/discoverers/id/discovererId

HTTP methods

GET

Operation ID: DescribeDiscoverer

Describes the discoverer.

Path parameters
NameTypeRequiredDescription
discovererIdStringTrue

The ID of the discoverer.

Responses
Status codeResponse modelDescription
200DiscovererOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

503ErrorOutput

503 response

PUT

Operation ID: UpdateDiscoverer

Updates the discoverer

Path parameters
NameTypeRequiredDescription
discovererIdStringTrue

The ID of the discoverer.

Responses
Status codeResponse modelDescription
200DiscovererOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

503ErrorOutput

503 response

DELETE

Operation ID: DeleteDiscoverer

Deletes a discoverer.

Path parameters
NameTypeRequiredDescription
discovererIdStringTrue

The ID of the discoverer.

Responses
Status codeResponse modelDescription
204None

204 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

503ErrorOutput

503 response

OPTIONS

Path parameters
NameTypeRequiredDescription
discovererIdStringTrue

The ID of the discoverer.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

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

Response bodies

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

Properties

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

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.

Tags

Key-value pairs associated with a resource.

PropertyTypeRequiredDescription

*

string

False

UpdateDiscovererInput

PropertyTypeRequiredDescription
CrossAccount

boolean

False
Description

string

MinLength: 0

MaxLength: 256

False

The description of the discoverer to update.