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

StartJobRun

Starts a job run.

Request Syntax


POST /applications/applicationId/jobruns HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configurationOverrides": { 
      "applicationConfiguration": [ 
         { 
            "classification": "string",
            "configurations": [ 
               "Configuration"
            ],
            "properties": { 
               "string" : "string" 
            }
         }
      ],
      "monitoringConfiguration": { 
         "cloudWatchLoggingConfiguration": { 
            "enabled": boolean,
            "encryptionKeyArn": "string",
            "logGroupName": "string",
            "logStreamNamePrefix": "string",
            "logTypes": { 
               "string" : [ "string" ]
            }
         },
         "managedPersistenceMonitoringConfiguration": { 
            "enabled": boolean,
            "encryptionKeyArn": "string"
         },
         "prometheusMonitoringConfiguration": { 
            "remoteWriteUrl": "string"
         },
         "s3MonitoringConfiguration": { 
            "encryptionKeyArn": "string",
            "logUri": "string"
         }
      }
   },
   "executionIamPolicy": { 
      "policy": "string",
      "policyArns": [ "string" ]
   },
   "executionRoleArn": "string",
   "executionTimeoutMinutes": number,
   "jobDriver": { ... },
   "mode": "string",
   "name": "string",
   "retryPolicy": { 
      "maxAttempts": number,
      "maxFailedAttemptsPerHour": number
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

The ID of the application on which to run the job.

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 to start. Its value must be unique for each request.

Type: String

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

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

Required: Yes

configurationOverrides

The configuration overrides for the job run.

Type: ConfigurationOverrides object

Required: No

executionIamPolicy

You can pass an optional IAM policy. The resulting job IAM role permissions will be an intersection of this policy and the policy associated with your job execution role.

Type: JobRunExecutionIamPolicy 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::([0-9]{12}):(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)

Required: Yes

executionTimeoutMinutes

The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000.

Required: No

jobDriver

The job driver for the job run.

Type: JobDriver object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

mode

The mode of the job run when it starts.

Type: String

Valid Values: BATCH | STREAMING

Required: No

name

The optional job run name. This doesn't have to be unique.

Type: String

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

Pattern: .*\S.*

Required: No

retryPolicy

The retry policy when job run starts.

Type: RetryPolicy object

Required: No

tags

The tags assigned to the job run.

Type: String to string map

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

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

Key Pattern: [A-Za-z0-9 /_.:=+@-]+

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

Value Pattern: [A-Za-z0-9 /_.:=+@-]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "arn": "string",
   "jobRunId": "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.

applicationId

This output displays the application ID on which the job run was submitted.

Type: String

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

Pattern: [0-9a-z]+

arn

This output displays the ARN of the job run..

Type: String

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

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

jobRunId

The output contains the ID of the started job run.

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.

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400