AWS Glue
Web API Reference (API Version 2017-03-31)

CreateJob

Creates a new job definition.

Request Syntax

{ "AllocatedCapacity": number, "Command": { "Name": "string", "ScriptLocation": "string" }, "Connections": { "Connections": [ "string" ] }, "DefaultArguments": { "string" : "string" }, "Description": "string", "ExecutionProperty": { "MaxConcurrentRuns": number }, "LogUri": "string", "MaxRetries": number, "Name": "string", "NotificationProperty": { "NotifyDelayAfter": number }, "Role": "string", "SecurityConfiguration": "string", "Timeout": number }

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.

AllocatedCapacity

The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Type: Integer

Required: No

Command

The JobCommand that executes this job.

Type: JobCommand object

Required: Yes

Connections

The connections used for this job.

Type: ConnectionsList object

Required: No

DefaultArguments

The default arguments for this job.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Type: String to string map

Required: No

Description

Description of the job being defined.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

ExecutionProperty

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

Type: ExecutionProperty object

Required: No

LogUri

This field is reserved for future use.

Type: String

Required: No

MaxRetries

The maximum number of times to retry this job if it fails.

Type: Integer

Required: No

Name

The name you assign to this job definition. It must be unique in your account.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

NotificationProperty

Specifies configuration properties of a job notification.

Type: NotificationProperty object

Required: No

Role

The name or ARN of the IAM role associated with this job.

Type: String

Required: Yes

SecurityConfiguration

The name of the SecurityConfiguration structure to be used with this job.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

Timeout

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Response Syntax

{ "Name": "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.

Name

The unique name that was provided for this job definition.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Errors

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

AlreadyExistsException

A resource to be created or added already exists.

HTTP Status Code: 400

ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

HTTP Status Code: 400

IdempotentParameterMismatchException

The same unique identifier was associated with two different records.

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

ResourceNumberLimitExceededException

A resource numerical limit was exceeded.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: