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

ListDevices

Gets information about unique device types.

Request Syntax

{ "arn": "string", "filters": [ { "attribute": "string", "operator": "string", "values": [ "string" ] } ], "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

arn

The Amazon Resource Name (ARN) of the project.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Required: No

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". This attribute will be ignored, as remote debugging is no longer supported.

    • 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 "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.

Type: Array of DeviceFilter objects

Required: No

nextToken

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.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

Required: No

Response Syntax

{ "devices": [ { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

devices

Information about the devices.

Type: Array of Device objects

nextToken

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

ArgumentException

An invalid argument was specified.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

See Also

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