devices

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

Overview

Name	devices
Type	Resource
Id	aws.snow_device_management.devices

Fields

The following fields are returned by SELECT queries:

describe_device

Name	Datatype	Description
associated_with_job	string	The ID of the job used when ordering the device.
device_capacities	array	The hardware specifications of the device.
device_state	string	The current state of the device. (UNLOCKED, LOCKED, UNLOCKING)
device_type	string	The type of Amazon Web Services Snow Family device.
last_reached_out_at	string (date-time)	When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.
last_updated_at	string (date-time)	When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.
managed_device_arn	string	The Amazon Resource Name (ARN) of the device.
managed_device_id	string	The ID of the device that you checked the information for.
physical_network_interfaces	array	The network interfaces available on the device.
software	object	The software installed on the device.
tags	object	Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

list_devices

Name	Datatype	Description
associated_with_job	string	The ID of the job used to order the device.
managed_device_arn	string	The Amazon Resource Name (ARN) of the device.
managed_device_id	string	The ID of the device.
tags	object	Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_device	select	managed_device_id, region		Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
list_devices	select	region	jobId, maxResults, nextToken	Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

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
managed_device_id	string	The ID of the device that you are checking the information of.
region	string	AWS region (default: us-east-1)
jobId	string	The ID of the job used to order the device.
maxResults	integer	The maximum number of devices to list per page.
nextToken	string	A pagination token to continue to the next page of results.

SELECT examples

describe_device

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

SELECT
associated_with_job,
device_capacities,
device_state,
device_type,
last_reached_out_at,
last_updated_at,
managed_device_arn,
managed_device_id,
physical_network_interfaces,
software,
tags
FROM aws.snow_device_management.devices
WHERE managed_device_id = '{{ managed_device_id }}' -- required
AND region = '{{ region }}' -- required
;

list_devices

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

SELECT
associated_with_job,
managed_device_arn,
managed_device_id,
tags
FROM aws.snow_device_management.devices
WHERE region = '{{ region }}' -- required
AND jobId = '{{ jobId }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;