discovered_devices
Creates, updates, deletes, gets or lists a discovered_devices resource.
Overview
| Name | discovered_devices |
| Type | Resource |
| Id | aws.iot_managed_integrations.discovered_devices |
Fields
The following fields are returned by SELECT queries:
- list_discovered_devices
| Name | Datatype | Description |
|---|---|---|
authentication_material | string | The authentication material required for connecting to the discovered device, such as credentials or tokens. (pattern: <code>[0-9A-Za-z!#$%&()*+-;<=>?@^_`{|}~/: {},\"]+</code>) |
brand | string | The brand of the discovered device. (pattern: <code>[A-Za-z0-9-_ ]+</code>) |
connector_device_id | string | The 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_name | string | The name of the device as defined by the connector or third-party system. (pattern: <code>[\p{L}\p{N} ._-]+</code>) |
device_types | array | The list of device types or categories that the discovered device belongs to. |
discovered_at | string (date-time) | The timestamp indicating when the device was discovered. |
managed_thing_id | string | The identifier of the managed thing created for this discovered device, if one exists. (pattern: <code>[a-zA-Z0-9:_-]*</code>) |
model | string | The model of the discovered device. (pattern: <code>[A-Za-z0-9-_ ]+</code>) |
modification | string | The 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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_discovered_devices | select | identifier, region | NextToken, MaxResults | Lists 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.
| Name | Datatype | Description |
|---|---|---|
identifier | string | The identifier of the device discovery job to list discovered devices for. |
region | string | AWS region (default: us-east-1) |
MaxResults | integer | The maximum number of discovered devices to return in a single response. |
NextToken | string | A token used for pagination of results. |
SELECT examples
- list_discovered_devices
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 }}'
;