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

StopRun

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

Request Syntax

Copy
{ "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.

arn

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

Type: String

Length Constraints: Minimum length of 32.

Required: Yes

Response Syntax

Copy
{ "run": { "arn": "string", "billingMethod": "string", "completedJobs": number, "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "message": "string", "name": "string", "networkProfile": { "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number }, "platform": "string", "result": "string", "started": number, "status": "string", "stopped": number, "totalJobs": number, "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.

run

The run that was stopped.

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