CancelBatchJobExecution
Important
AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see AWS Mainframe Modernization availability change.
Cancels the running of a specific batch job execution.
Request Syntax
POST /applications/applicationId/batch-job-executions/executionId/cancel HTTP/1.1
Content-type: application/json
{
"authSecretsManagerArn": "string"
}URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The unique identifier of the application.
Pattern:
\S{1,80}Required: Yes
- executionId
-
The unique identifier of the batch job execution.
Pattern:
\S{1,80}Required: Yes
Request Body
The request accepts the following data in JSON format.
- authSecretsManagerArn
-
The AWS Secrets Manager containing user's credentials for authentication and authorization for Cancel Batch Job Execution operation.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The account or role doesn't have the right permissions to make the request.
HTTP Status Code: 403
- ConflictException
-
The parameters provided in the request conflict with existing resources.
- resourceId
-
The ID of the conflicting resource.
- resourceType
-
The type of the conflicting resource.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred during the processing of the request.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
- resourceId
-
The ID of the missing resource.
- resourceType
-
The type of the missing resource.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests made exceeds the limit.
- quotaCode
-
The identifier of the throttled request.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request.
- serviceCode
-
The identifier of the service that the throttled request was made to.
HTTP Status Code: 429
- ValidationException
-
One or more parameters provided in the request is not valid.
- fieldList
-
The list of fields that failed service validation.
- reason
-
The reason why it failed service validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
