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

UpdateDevicePool

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

Request Syntax

{ "arn": "string", "clearMaxDevices": boolean, "description": "string", "maxDevices": number, "name": "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.

arn

The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.

Type: String

Length Constraints: Minimum length of 32.

Required: Yes

clearMaxDevices

Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria that are specified for the rules parameter.

If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.

Type: Boolean

Required: No

description

A description of the device pool you wish to update.

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 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.

If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.

Type: Integer

Required: No

name

A string representing the name of the device pool you wish to update.

Type: String

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

Required: No

rules

Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.

Type: Array of Rule objects

Required: No

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 device pool you just updated.

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

See Also

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