device_instances

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

Overview

Name	device_instances
Type	Resource
Id	aws.devicefarm.device_instances

Fields

The following fields are returned by SELECT queries:

get_device_instance

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the device instance. (pattern: <code>^arn:aws:devicefarm:.+</code>)
device_arn	string	The ARN of the device. (pattern: <code>^arn:aws:devicefarm:.+</code>)
instance_profile	object	A object that contains information about the instance profile.
labels	array	An array of strings that describe the device instance.
status	string	The status of the device instance. Valid values are listed here. (IN_USE, PREPARING, AVAILABLE, NOT_AVAILABLE)
udid	string	Unique device identifier for the device instance.

list_device_instances

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the device instance. (pattern: <code>^arn:aws:devicefarm:.+</code>)
device_arn	string	The ARN of the device. (pattern: <code>^arn:aws:devicefarm:.+</code>)
instance_profile	object	A object that contains information about the instance profile.
labels	array	An array of strings that describe the device instance.
status	string	The status of the device instance. Valid values are listed here. (IN_USE, PREPARING, AVAILABLE, NOT_AVAILABLE)
udid	string	Unique device identifier for the device instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_device_instance	select	region		Returns information about a device instance that belongs to a private device fleet.
list_device_instances	select	region		Returns information about the private device instances associated with one or more AWS accounts.
update_device_instance	update	region, arn		Updates information about a private device instance.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_device_instance

Returns information about a device instance that belongs to a private device fleet.

SELECT
arn,
device_arn,
instance_profile,
labels,
status,
udid
FROM aws.devicefarm.device_instances
WHERE region = '{{ region }}' -- required
;

list_device_instances

Returns information about the private device instances associated with one or more AWS accounts.

SELECT
arn,
device_arn,
instance_profile,
labels,
status,
udid
FROM aws.devicefarm.device_instances
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_device_instance

Updates information about a private device instance.

UPDATE aws.devicefarm.device_instances
SET 
arn = '{{ arn }}',
profileArn = '{{ profileArn }}',
labels = '{{ labels }}'
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
device_instance;