ListDevicePools - AWS Device Farm Documentation
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

ListDevicePools

Gets information about device pools.

Request Syntax

{
   "arn": "string",
   "nextToken": "string",
   "type": "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 project ARN.

Type: String

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

Pattern: ^arn:.+

Required: Yes

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

type

The device pools' type.

Allowed values include:

  • CURATED: A device pool that is created and managed by AWS Device Farm.

  • PRIVATE: A device pool that is created and managed by the device pool developer.

Type: String

Valid Values: CURATED | PRIVATE

Required: No

Response Syntax

{
   "devicePools": [ 
      { 
         "arn": "string",
         "description": "string",
         "maxDevices": number,
         "name": "string",
         "rules": [ 
            { 
               "attribute": "string",
               "operator": "string",
               "value": "string"
            }
         ],
         "type": "string"
      }
   ],
   "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.

devicePools

Information about the device pools.

Type: Array of DevicePool objects

nextToken

If the number of items that are returned is significantly large, this is an identifier that is also returned. It 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: