POST
/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop
http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop<p>Stops a Device Advisor test suite run that is currently running.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StopSuiteRun</a> action.</p>
Access Token Required: API Key
Path Parameters
suiteDefinitionIdstringrequired
Suite definition ID of the test suite run to be stopped.
suiteRunIdstringrequired
Suite run ID of the test suite run to be stopped.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}