Skip to main content

discovered_devices

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

Overview

Namediscovered_devices
TypeResource
Idaws.iot_managed_integrations.discovered_devices

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
authentication_materialstringThe authentication material required for connecting to the discovered device, such as credentials or tokens. (pattern: <code>[0-9A-Za-z!#$%&()*+-;<=>?@^_`{|}~/: {},\"]+</code>)
brandstringThe brand of the discovered device. (pattern: <code>[A-Za-z0-9-_ ]+</code>)
connector_device_idstringThe third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII). (pattern: <code>[a-zA-Z0-9_.,@-]+</code>)
connector_device_namestringThe name of the device as defined by the connector or third-party system. (pattern: <code>[\p{L}\p{N} ._-]+</code>)
device_typesarrayThe list of device types or categories that the discovered device belongs to.
discovered_atstring (date-time)The timestamp indicating when the device was discovered.
managed_thing_idstringThe identifier of the managed thing created for this discovered device, if one exists. (pattern: <code>[a-zA-Z0-9:_-]*</code>)
modelstringThe model of the discovered device. (pattern: <code>[A-Za-z0-9-_ ]+</code>)
modificationstringThe status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery. (DISCOVERED, UPDATED, NO_CHANGE)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_discovered_devicesselectidentifier, regionNextToken, MaxResultsLists all devices discovered during a specific device discovery task.

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.

NameDatatypeDescription
identifierstringThe identifier of the device discovery job to list discovered devices for.
regionstringAWS region (default: us-east-1)
MaxResultsintegerThe maximum number of discovered devices to return in a single response.
NextTokenstringA token used for pagination of results.

SELECT examples

Lists all devices discovered during a specific device discovery task.

SELECT
authentication_material,
brand,
connector_device_id,
connector_device_name,
device_types,
discovered_at,
managed_thing_id,
model,
modification
FROM aws.iot_managed_integrations.discovered_devices
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;