Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateDevicePool

Creates a device pool.

Request Syntax


{
   "description": "string",
   "maxDevices": number,
   "name": "string",
   "projectArn": "string",
   "rules": [ 
      { 
         "attribute": "string",
         "operator": "string",
         "value": "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.

description

The device pool's description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16384.

Required: No

maxDevices

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

Type: Integer

Required: No

name

The device pool's name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

projectArn

The ARN of the project for the device pool.

Type: String

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

Pattern: ^arn:.+

Required: Yes

rules

The device pool's rules.

Type: Array of Rule objects

Required: Yes

Response Syntax


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

devicePool

The newly created device pool.

Type: DevicePool object

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