Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListJobRuns

Lists job runs based on a set of parameters.

Request Syntax


GET /applications/applicationId/jobruns?createdAtAfter=createdAtAfter&createdAtBefore=createdAtBefore&maxResults=maxResults&mode=mode&nextToken=nextToken&states=states HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The ID of the application for which to list the job run.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[0-9a-z]+$

Required: Yes

createdAtAfter

The lower bound of the option to filter by creation date and time.

createdAtBefore

The upper bound of the option to filter by creation date and time.

maxResults

The maximum number of job runs that can be listed.

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

mode

The mode of the job runs to list.

Valid Values: BATCH | STREAMING

nextToken

The token for the next set of job run results.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[A-Za-z0-9_=-]+$

states

An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

Array Members: Minimum number of 0 items. Maximum number of 8 items.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "jobRuns": [ 
      { 
         "applicationId": "string",
         "arn": "string",
         "attempt": number,
         "attemptCreatedAt": number,
         "attemptUpdatedAt": number,
         "createdAt": number,
         "createdBy": "string",
         "executionRole": "string",
         "id": "string",
         "mode": "string",
         "name": "string",
         "releaseLabel": "string",
         "state": "string",
         "stateDetails": "string",
         "type": "string",
         "updatedAt": number
      }
   ],
   "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.

jobRuns

The output lists information about the specified job runs.

Type: Array of JobRunSummary objects

nextToken

The output displays the token for the next set of job run results. This is required for pagination and is available as a response of the previous request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[A-Za-z0-9_=-]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400