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
Name Type Required Description
discovererId String True

The ID of the discoverer.

Responses
Status Code Response Model Description
200 DiscovererOutput

200 response

400 ErrorOutput

400 response

401 ErrorOutput

401 response

403 ErrorOutput

403 response

404 ErrorOutput

404 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

PUT

Operation ID: UpdateDiscoverer

Updates the discoverer

Path Parameters
Name Type Required Description
discovererId String True

The ID of the discoverer.

Responses
Status Code Response Model Description
200 DiscovererOutput

200 response

400 ErrorOutput

400 response

401 ErrorOutput

401 response

403 ErrorOutput

403 response

404 ErrorOutput

404 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

DELETE

Operation ID: DeleteDiscoverer

Deletes a discoverer.

Path Parameters
Name Type Required Description
discovererId String True

The ID of the discoverer.

Responses
Status Code Response Model Description
204 None

204 response

400 ErrorOutput

400 response

401 ErrorOutput

401 response

403 ErrorOutput

403 response

404 ErrorOutput

404 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

Schemas

Request Bodies

Example PUT

{ "Description": "string" }

Response Bodies

Example DiscovererOutput

{ "DiscovererArn": "string", "DiscovererId": "string", "Description": "string", "SourceArn": "string", "State": enum, "tags": { } }

Example ErrorOutput

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

Properties

DiscovererOutput

Property Type Required Description
DiscovererArn

string

False

The ARN of the discoverer.

DiscovererId

string

False

The ID of the discoverer.

Description

string

False

The description 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

Property Type Required Description
Message

string

True

The message string of the error output.

Code

string

True

The error code.

Tags

Key-value pairs associated with a resource.

Property Type Required Description

*

string

False

UpdateDiscovererInput

Property Type Required Description
Description

string

MinLength: 0

MaxLength: 256

False

The description of the discoverer to update.