ListBatchJobExecutions - AWS Mainframe Modernization (M2)

ListBatchJobExecutions

Lists historical, current, and scheduled batch job executions for a specific application.

Request Syntax

GET /applications/applicationId/batch-job-executions?executionIds=executionIds&jobName=jobName&maxResults=maxResults&nextToken=nextToken&startedAfter=startedAfter&startedBefore=startedBefore&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The unique identifier of the application.

Pattern: ^\S{1,80}$

Required: Yes

executionIds

The unique identifier of each batch job execution.

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: ^\S{1,80}$

jobName

The name of each batch job execution.

Pattern: ^\S{1,100}$

maxResults

The maximum number of batch job executions to return.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

A pagination token to control the number of batch job executions displayed in the list.

Pattern: ^\S{1,2000}$

startedAfter

The time after which the batch job executions started.

startedBefore

The time before the batch job executions started.

status

The status of the batch job executions.

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

Request Body

The request does not have a request body.

Response Syntax

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

batchJobExecutions

Returns a list of batch job executions for an application.

Type: Array of BatchJobExecutionSummary objects

nextToken

A pagination token that's returned when the response doesn't contain all batch job executions.

Type: String

Pattern: ^\S{1,2000}$

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: