# StopRun


Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. 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](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_StopRun_RequestSyntax) **   <a name="devicefarm-StopRun-request-arn"></a>
Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax


```
{
   "run": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "string",
      "completedJobs": number,
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "devicePoolArn": "string",
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "deviceSelectionResult": { 
         "filters": [ 
            { 
               "attribute": "string",
               "operator": "string",
               "values": [ "string" ]
            }
         ],
         "matchedDevicesCount": number,
         "maxDevices": number
      },
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "eventCount": number,
      "executionRoleArn": "string",
      "jobTimeoutMinutes": number,
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": 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
      },
      "parsingResultUrl": "string",
      "platform": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      },
      "result": "string",
      "resultCode": "string",
      "seed": number,
      "skipAppResign": boolean,
      "started": number,
      "status": "string",
      "stopped": number,
      "testSpecArn": "string",
      "totalJobs": number,
      "type": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      },
      "webUrl": "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](#API_StopRun_ResponseSyntax) **   <a name="devicefarm-StopRun-response-run"></a>
The run that was stopped.  
Type: [Run](API_Run.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** LimitExceededException **   
A limit was exceeded.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** NotFoundException **   
The specified entity was not found.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** ServiceAccountException **   
There was a problem with the service account.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/StopRun)