class Aws::DeviceFarm::Types::ListDevicesRequest

Represents the result of a list devices request.

@note When making an API call, you may pass ListDevicesRequest

data as a hash:

    {
      arn: "AmazonResourceName",
      next_token: "PaginationToken",
      filters: [
        {
          attribute: "ARN", # required, accepts ARN, PLATFORM, OS_VERSION, MODEL, AVAILABILITY, FORM_FACTOR, MANUFACTURER, REMOTE_ACCESS_ENABLED, REMOTE_DEBUG_ENABLED, INSTANCE_ARN, INSTANCE_LABELS, FLEET_TYPE
          operator: "EQUALS", # required, accepts EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, NOT_IN, CONTAINS
          values: ["String"], # required
        },
      ],
    }

@!attribute [rw] arn

The Amazon Resource Name (ARN) of the project.
@return [String]

@!attribute [rw] next_token

An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
@return [String]

@!attribute [rw] filters

Used to select a set of devices. A filter is made up of an
attribute, an operator, and one or more values.

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

  Allowed values include:

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

  * PLATFORM: The device platform. Valid values are ANDROID or IOS.

  * OS\_VERSION: The operating system version (for example, 10.3.2).

  * MODEL: The device model (for example, iPad 5th Gen).

  * AVAILABILITY: The current availability of the device. Valid
    values are AVAILABLE, HIGHLY\_AVAILABLE, BUSY, or
    TEMPORARY\_NOT\_AVAILABLE.

  * FORM\_FACTOR: The device form factor. Valid values are PHONE or
    TABLET.

  * MANUFACTURER: The device manufacturer (for example, Apple).

  * REMOTE\_ACCESS\_ENABLED: Whether the device is enabled for
    remote access. Valid values are TRUE or FALSE.

  * REMOTE\_DEBUG\_ENABLED: Whether the device is enabled for remote
    debugging. Valid values are TRUE or FALSE. Because remote
    debugging is [no longer supported][1], this attribute is
    ignored.

  * INSTANCE\_ARN: The Amazon Resource Name (ARN) of the device
    instance.

  * INSTANCE\_LABELS: The label of the device instance.

  * FLEET\_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.

* Operator: The filter operator.

  * The EQUALS operator is available for every attribute except
    INSTANCE\_LABELS.

  * The CONTAINS operator is available for the INSTANCE\_LABELS and
    MODEL attributes.

  * The IN and NOT\_IN operators are available for the ARN,
    OS\_VERSION, MODEL, MANUFACTURER, and INSTANCE\_ARN attributes.

  * The LESS\_THAN, GREATER\_THAN, LESS\_THAN\_OR\_EQUALS, and
    GREATER\_THAN\_OR\_EQUALS operators are also available for the
    OS\_VERSION attribute.

* Values: An array of one or more filter values.

  * The IN and NOT\_IN operators take a values array that has one or
    more elements.

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

  * In a request, the AVAILABILITY attribute takes the following
    values: AVAILABLE, HIGHLY\_AVAILABLE, BUSY, or
    TEMPORARY\_NOT\_AVAILABLE.

[1]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html
@return [Array<Types::DeviceFilter>]

@see docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/ListDevicesRequest AWS API Documentation

Constants

SENSITIVE