AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DeviceFilter

import "github.com/aws/aws-sdk-go/service/devicefarm"

type DeviceFilter struct { Attribute *string `locationName:"attribute" type:"string" enum:"DeviceFilterAttribute"` Operator *string `locationName:"operator" type:"string" enum:"RuleOperator"` Values []*string `locationName:"values" type:"list"` }

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.

Attribute

Type: *string

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.

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

Supported operators: EQUALS, IN, NOT_IN

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

Supported operators: EQUALS

OS_VERSIONThe 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

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

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

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

Supported operators: EQUALS

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

Supported operators: EQUALS

MANUFACTURERThe device manufacturer. For example, "Apple".

Supported operators: EQUALS, IN, NOT_IN

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

Supported operators: EQUALS

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

Supported operators: EQUALS

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

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELSThe label of the device instance.

Supported operators: CONTAINS

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

Supported operators: EQUALS

Operator

Type: *string

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.

Values

Type: []*string

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".

Method

GoString

func (s DeviceFilter) GoString() string

GoString returns the string representation

SetAttribute

func (s *DeviceFilter) SetAttribute(v string) *DeviceFilter

SetAttribute sets the Attribute field's value.

SetOperator

func (s *DeviceFilter) SetOperator(v string) *DeviceFilter

SetOperator sets the Operator field's value.

SetValues

func (s *DeviceFilter) SetValues(v []*string) *DeviceFilter

SetValues sets the Values field's value.

String

func (s DeviceFilter) String() string

String returns the string representation

On this page: