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

StartJobRun

Starts a job run. 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


POST /virtualclusters/virtualClusterId/jobruns HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configurationOverrides": { 
      "applicationConfiguration": [ 
         { 
            "classification": "string",
            "configurations": [ 
               "Configuration"
            ],
            "properties": { 
               "string" : "string" 
            }
         }
      ],
      "monitoringConfiguration": { 
         "cloudWatchMonitoringConfiguration": { 
            "logGroupName": "string",
            "logStreamNamePrefix": "string"
         },
         "containerLogRotationConfiguration": { 
            "maxFilesToKeep": number,
            "rotationSize": "string"
         },
         "managedLogs": { 
            "allowAWSToRetainLogs": "string",
            "encryptionKeyArn": "string"
         },
         "persistentAppUI": "string",
         "s3MonitoringConfiguration": { 
            "logUri": "string"
         }
      }
   },
   "executionRoleArn": "string",
   "jobDriver": { 
      "sparkSqlJobDriver": { 
         "entryPoint": "string",
         "sparkSqlParameters": "string"
      },
      "sparkSubmitJobDriver": { 
         "entryPoint": "string",
         "entryPointArguments": [ "string" ],
         "sparkSubmitParameters": "string"
      }
   },
   "jobTemplateId": "string",
   "jobTemplateParameters": { 
      "string" : "string" 
   },
   "name": "string",
   "releaseLabel": "string",
   "retryPolicyConfiguration": { 
      "maxAttempts": number
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

virtualClusterId

The virtual cluster ID for which the job run request is submitted.

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

Pattern: [0-9a-z]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

The client idempotency token of the job run request.

Type: String

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

Pattern: .*\S.*

Required: Yes

configurationOverrides

The configuration overrides for the job run.

Type: ConfigurationOverrides object

Required: No

executionRoleArn

The execution role ARN for the job run.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$

Required: No

jobDriver

The job driver for the job run.

Type: JobDriver object

Required: No

jobTemplateId

The job template ID to be used to start the job run.

Type: String

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

Pattern: [0-9a-z]+

Required: No

jobTemplateParameters

The values of job template parameters to start a job run.

Type: String to string map

Map Entries: Maximum number of 100 items.

Key Length Constraints: Minimum length of 1. Maximum length of 512.

Key Pattern: [\.\-_\#A-Za-z0-9]+

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

Value Pattern: .*\S.*

Required: No

name

The name of the job run.

Type: String

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

Pattern: [\.\-_/#A-Za-z0-9]+

Required: No

releaseLabel

The Amazon EMR release version to use for the job run.

Type: String

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

Pattern: [\.\-_/A-Za-z0-9]+

Required: No

retryPolicyConfiguration

The retry policy configuration for the job run.

Type: RetryPolicyConfiguration object

Required: No

tags

The tags assigned to job runs.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: .*\S.*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: .*\S.*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "name": "string",
   "virtualClusterId": "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.

arn

This output lists the ARN of job run.

Type: String

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

Pattern: ^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):\/virtualclusters\/[0-9a-zA-Z]+\/jobruns\/[0-9a-zA-Z]+$

id

This output displays the started job run ID.

Type: String

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

Pattern: [0-9a-z]+

name

This output displays the name of the started job run.

Type: String

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

Pattern: [\.\-_/#A-Za-z0-9]+

virtualClusterId

This output displays the virtual cluster ID for which the job run was submitted.

Type: String

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

Pattern: [0-9a-z]+

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

ValidationException

There are invalid parameters in the client request.

HTTP Status Code: 400