BatchStopJobRun
Stops one or more job runs for a specified job definition.
Request Syntax
{
"JobName": "string",
"JobRunIds": [ "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.
- JobName
-
The name of the job definition for which to stop job runs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
- JobRunIds
-
A list of the
JobRunIdsthat should be stopped for that job definition.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
Response Syntax
{
"Errors": [
{
"ErrorDetail": {
"ErrorCode": "string",
"ErrorMessage": "string"
},
"JobName": "string",
"JobRunId": "string"
}
],
"SuccessfulSubmissions": [
{
"JobName": "string",
"JobRunId": "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.
- Errors
-
A list of the errors that were encountered in trying to stop
JobRuns, including theJobRunIdfor which each error was encountered and details about the error.Type: Array of BatchStopJobRunError objects
- SuccessfulSubmissions
-
A list of the JobRuns that were successfully submitted for stopping.
Type: Array of BatchStopJobRunSuccessfulSubmission objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
