Start Discoverer - Amazon EventBridge Schemas

Start Discoverer

URI

/v1/discoverers/id/discovererId/start

HTTP methods

POST

Operation ID: StartDiscoverer

Starts the discoverer

Path parameters
NameTypeRequiredDescription
discovererIdStringTrue

The ID of the discoverer.

Responses
Status codeResponse modelDescription
200DiscovererStateOutput

200 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

Response bodies

{ "DiscovererId": "string", "State": enum }
{ "Message": "string", "Code": "string" }

Properties

DiscovererState

  • STARTED

  • STOPPED

DiscovererStateOutput

PropertyTypeRequiredDescription
DiscovererId

string

False

The ID of the discoverer.

State

DiscovererState

False

The state of the discoverer.

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.