AWS Device Farm
API Reference (API Version 2015-06-23)

DeviceFilter

Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.

Contents

attribute

The aspect of a device such as platform or model used as the selection criteria in a device filter.

The supported operators for each attribute are provided in the following list.

ARN

The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are "ANDROID" or "IOS".

Supported operators: EQUALS

OS_VERSION

The operating system version. For example, "10.3.2".

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

The device model. For example, "iPad 5th Gen".

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".

Supported operators: EQUALS

FORM_FACTOR

The device form factor. Valid values are "PHONE" or "TABLET".

Supported operators: EQUALS

MANUFACTURER

The device manufacturer. For example, "Apple".

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".

Supported operators: EQUALS

INSTANCE_ARN

The Amazon Resource Name (ARN) of the device instance.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are "PUBLIC" or "PRIVATE".

Supported operators: EQUALS

Type: String

Valid Values: ARN | PLATFORM | OS_VERSION | MODEL | AVAILABILITY | FORM_FACTOR | MANUFACTURER | REMOTE_ACCESS_ENABLED | REMOTE_DEBUG_ENABLED | INSTANCE_ARN | INSTANCE_LABELS | FLEET_TYPE

Required: No

operator

Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

Type: String

Valid Values: EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | GREATER_THAN | GREATER_THAN_OR_EQUALS | IN | NOT_IN | CONTAINS

Required: No

values

An array of one or more filter values used in a device filter.

Operator Values

  • The IN and NOT_IN operators can take a values array that has more than one element.

  • The other operators require an array with a single element.

Attribute Values

  • The PLATFORM attribute can be set to "ANDROID" or "IOS".

  • The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".

  • The FORM_FACTOR attribute can be set to "PHONE" or "TABLET".

  • The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE".

Type: Array of strings

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: