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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


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.


The device pool's description.

Type: String

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

Required: No


The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that 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


The device pool's name.

Type: String

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

Required: Yes


The ARN of the project for the device pool.

Type: String

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

Required: Yes


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.


The newly created device pool.

Type: DevicePool object


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


An invalid argument was specified.

HTTP Status Code: 400


A limit was exceeded.

HTTP Status Code: 400


The specified entity was not found.

HTTP Status Code: 400


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: