device_discoveries

Creates, updates, deletes, gets or lists a device_discoveries resource.

Overview

Name	device_discoveries
Type	Resource
Id	aws.iot_managed_integrations.device_discoveries

Fields

The following fields are returned by SELECT queries:

get_device_discovery

Name	Datatype	Description
account_association_id	string	The identifier of the account association used for the device discovery. (pattern: <code>[0-9a-zA-Z]+</code>)
arn	string	The Amazon Resource Name (ARN) of the device discovery job request. (pattern: <code>arn:aws:iotmanagedintegrations:[0-9a-zA-Z-]+:[0-9]+:device-discovery/[0-9a-zA-Z]+</code>)
connector_association_id	string	The ID tracking the current discovery process for one connector association. (pattern: <code>[0-9a-zA-Z]+</code>)
controller_id	string	The id of the end-user's IoT hub. (pattern: <code>[a-zA-Z0-9:_-]*</code>)
discovery_type	string	The discovery type supporting the type of device to be discovered in the device discovery job request. (ZWAVE, ZIGBEE, CLOUD, CUSTOM, CONTROLLER_CAPABILITY_REDISCOVERY)
finished_at	string (date-time)	The timestamp value for the completion time of the device discovery.
id	string	The id of the device discovery job request. (pattern: <code>[A-Za-z0-9]+</code>)
started_at	string (date-time)	The timestamp value for the start time of the device discovery.
status	string	The status of the device discovery job request. (RUNNING, SUCCEEDED, FAILED, TIMED_OUT)
tags	object	A set of key/value pairs that are used to manage the device discovery request.

list_device_discoveries

Name	Datatype	Description
discovery_type	string	The type of discovery process used to find devices. (ZWAVE, ZIGBEE, CLOUD, CUSTOM, CONTROLLER_CAPABILITY_REDISCOVERY)
id	string	The unique identifier of the device discovery job. (pattern: <code>[A-Za-z0-9]+</code>)
status	string	The current status of the device discovery job. (RUNNING, SUCCEEDED, FAILED, TIMED_OUT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_device_discovery	select	identifier, region		Get the current state of a device discovery.
list_device_discoveries	select	region	NextToken, MaxResults, TypeFilter, StatusFilter	Lists all device discovery tasks, with optional filtering by type and status.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
identifier	string	The id of the device discovery job request.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of device discovery jobs to return in a single response.
NextToken	string	A token used for pagination of results.
StatusFilter	string	The status to filter device discovery jobs by.
TypeFilter	string	The discovery type to filter device discovery jobs by.

SELECT examples

get_device_discovery

Get the current state of a device discovery.

SELECT
account_association_id,
arn,
connector_association_id,
controller_id,
discovery_type,
finished_at,
id,
started_at,
status,
tags
FROM aws.iot_managed_integrations.device_discoveries
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_device_discoveries

Lists all device discovery tasks, with optional filtering by type and status.

SELECT
discovery_type,
id,
status
FROM aws.iot_managed_integrations.device_discoveries
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND TypeFilter = '{{ TypeFilter }}'
AND StatusFilter = '{{ StatusFilter }}'
;