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


Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.

Request Syntax

{ "arn": "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.


Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.

Type: String

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

Required: Yes

Response Syntax

{ "job": { "arn": "string", "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "device": { "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 } }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "instanceArn": "string", "message": "string", "name": "string", "result": "string", "started": number, "status": "string", "stopped": number, "type": "string", "videoCapture": boolean, "videoEndpoint": "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 job that was stopped.

Type: Job 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: