Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDeviceDiscovery

Get the current state of a device discovery.

Request Syntax


GET /device-discoveries/Identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identifier

The id of the device discovery job request.

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [A-Za-z0-9]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AccountAssociationId": "string",
   "Arn": "string",
   "ConnectorAssociationId": "string",
   "ControllerId": "string",
   "DiscoveryType": "string",
   "FinishedAt": number,
   "Id": "string",
   "StartedAt": number,
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountAssociationId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-zA-Z]+

Arn

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

Type: String

Pattern: arn:aws:iotmanagedintegrations:[0-9a-zA-Z-]+:[0-9]+:device-discovery/[0-9a-zA-Z]+

ConnectorAssociationId

This parameter has been deprecated.

The ID tracking the current discovery process for one connector association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-zA-Z]+

ControllerId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9:_-]*

DiscoveryType

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

Type: String

Valid Values: ZWAVE | ZIGBEE | CLOUD | CUSTOM

FinishedAt

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

Type: Timestamp

Id

The id of the device discovery job request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [A-Za-z0-9]+

StartedAt

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

Type: Timestamp

Status

The status of the device discovery job request.

Type: String

Valid Values: RUNNING | SUCCEEDED | FAILED | TIMED_OUT

Tags

This parameter has been deprecated.

A set of key/value pairs that are used to manage the device discovery request.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400