GetBatchJobExecution - AWS Mainframe Modernization (M2)

GetBatchJobExecution

Gets the details of a specific batch job execution for a specific application.

Request Syntax

GET /applications/applicationId/batch-job-executions/executionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The 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 does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "applicationId": "string", "endTime": number, "executionId": "string", "jobId": "string", "jobName": "string", "jobType": "string", "jobUser": "string", "startTime": number, "status": "string", "statusReason": "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.

applicationId

The identifier of the application.

Type: String

Pattern: ^\S{1,80}$

endTime

The timestamp when the batch job execution ended.

Type: Timestamp

executionId

The unique identifier for this batch job execution.

Type: String

Pattern: ^\S{1,80}$

jobId

The unique identifier for this batch job.

Type: String

Pattern: ^\S{1,100}$

jobName

The name of this batch job.

Type: String

Pattern: ^\S{1,100}$

jobType

The type of job.

Type: String

Valid Values: VSE | JES2 | JES3

jobUser

The user for the job.

Type: String

Pattern: ^\S{1,100}$

startTime

The timestamp when the batch job execution started.

Type: Timestamp

status

The status of the batch job execution.

Type: String

Valid Values: Submitting | Holding | Dispatching | Running | Cancelling | Cancelled | Succeeded | Failed | Succeeded With Warning

statusReason

The reason for the reported status.

Type: String

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

InternalServerException

An unexpected error occurred during the processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The number of requests made exceeds the limit.

HTTP Status Code: 429

ValidationException

One or more parameters provided in the request is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: