Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

StopJob - AWS Device Farm Documentation

StopJob

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are 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.

arn

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

Type: String

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

Pattern: ^arn:.+

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.

job

The job that was stopped.

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

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.