Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483477323.4 KB

Get the current state of a device discovery.

get/device-discoveries/{Identifier}

Path parameters

Identifierstring required

The id of the device discovery job request.

Response

Success

Idstring required

The id of the device discovery job request.

Arnstring required

The Amazon Resource Name (ARN) of the device discovery job request.

DiscoveryType'ZWAVE' | 'ZIGBEE' | 'CLOUD' | 'CUSTOM' | 'CONTROLLER_CAPABILITY_REDISCOVERY' required

The discovery type supporting the type of device to be discovered in the device discovery job request.

Status'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'TIMED_OUT' required

The status of the device discovery job request.

StartedAtstring date-time required

The timestamp value for the start time of the device discovery.

ControllerIdstring

The id of the end-user's IoT hub.

ConnectorAssociationIdstring

The ID tracking the current discovery process for one connector association.ConnectorAssociationId has been deprecated

AccountAssociationIdstring

The identifier of the account association used for the device discovery.

FinishedAtstring date-time

The timestamp value for the completion time of the device discovery.

Tagsobject

A set of key/value pairs that are used to manage the device discovery request.Tags have been deprecated from this api