ListJobRuns
Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
Request Syntax
GET /virtualclusters/virtualClusterId
/jobruns?createdAfter=createdAfter
&createdBefore=createdBefore
&maxResults=maxResults
&name=name
&nextToken=nextToken
&states=states
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- createdAfter
-
The date and time after which the job runs were submitted.
- createdBefore
-
The date and time before which the job runs were submitted.
- maxResults
-
The maximum number of job runs that can be listed.
- name
-
The name of the job run.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_/#A-Za-z0-9]+
- nextToken
-
The token for the next set of job runs to return.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*
- states
-
The states of the job run.
Array Members: Maximum number of 10 items.
Valid Values:
PENDING | SUBMITTED | RUNNING | FAILED | CANCELLED | CANCEL_PENDING | COMPLETED
- virtualClusterId
-
The ID of the virtual cluster for which to list the job run.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9a-z]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"jobRuns": [
{
"arn": "string",
"clientToken": "string",
"configurationOverrides": {
"applicationConfiguration": [
{
"classification": "string",
"configurations": [
"Configuration"
],
"properties": {
"string" : "string"
}
}
],
"monitoringConfiguration": {
"cloudWatchMonitoringConfiguration": {
"logGroupName": "string",
"logStreamNamePrefix": "string"
},
"containerLogRotationConfiguration": {
"maxFilesToKeep": number,
"rotationSize": "string"
},
"persistentAppUI": "string",
"s3MonitoringConfiguration": {
"logUri": "string"
}
}
},
"createdAt": "string",
"createdBy": "string",
"executionRoleArn": "string",
"failureReason": "string",
"finishedAt": "string",
"id": "string",
"jobDriver": {
"sparkSqlJobDriver": {
"entryPoint": "string",
"sparkSqlParameters": "string"
},
"sparkSubmitJobDriver": {
"entryPoint": "string",
"entryPointArguments": [ "string" ],
"sparkSubmitParameters": "string"
}
},
"name": "string",
"releaseLabel": "string",
"retryPolicyConfiguration": {
"maxAttempts": number
},
"retryPolicyExecution": {
"currentAttemptCount": number
},
"state": "string",
"stateDetails": "string",
"tags": {
"string" : "string"
},
"virtualClusterId": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
This is an internal server exception.
HTTP Status Code: 500
- ValidationException
-
There are invalid parameters in the client request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: