Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetJobRuns

Retrieves metadata for all runs of a given job definition.

Request Syntax


{
   "JobName": "string",
   "MaxResults": number,
   "NextToken": "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 retrieve all 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

MaxResults

The maximum size of the response.

Type: Integer

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

Required: No

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

Response Syntax


{
   "JobRuns": [ 
      { 
         "AllocatedCapacity": number,
         "Arguments": { 
            "string" : "string" 
         },
         "Attempt": number,
         "CompletedOn": number,
         "DPUSeconds": number,
         "ErrorMessage": "string",
         "ExecutionClass": "string",
         "ExecutionTime": number,
         "GlueVersion": "string",
         "Id": "string",
         "JobName": "string",
         "JobRunState": "string",
         "LastModifiedOn": number,
         "LogGroupName": "string",
         "MaxCapacity": number,
         "NotificationProperty": { 
            "NotifyDelayAfter": number
         },
         "NumberOfWorkers": number,
         "PredecessorRuns": [ 
            { 
               "JobName": "string",
               "RunId": "string"
            }
         ],
         "PreviousRunId": "string",
         "SecurityConfiguration": "string",
         "StartedOn": number,
         "Timeout": number,
         "TriggerName": "string",
         "WorkerType": "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.

JobRuns

A list of job-run metadata objects.

Type: Array of JobRun objects

NextToken

A continuation token, if not all requested job runs have been returned.

Type: String

Errors

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

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

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