RegisterJobDefinition
Registers an AWS Batch job definition.
Request Syntax
POST /v1/registerjobdefinition HTTP/1.1
Content-type: application/json
{
"containerProperties": {
"command": [ "string" ],
"environment": [
{
"name": "string",
"value": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"fargatePlatformConfiguration": {
"platformVersion": "string"
},
"image": "string",
"instanceType": "string",
"jobRoleArn": "string",
"linuxParameters": {
"devices": [
{
"containerPath": "string",
"hostPath": "string",
"permissions": [ "string" ]
}
],
"initProcessEnabled": boolean,
"maxSwap": number,
"sharedMemorySize": number,
"swappiness": number,
"tmpfs": [
{
"containerPath": "string",
"mountOptions": [ "string" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"memory": number,
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"networkConfiguration": {
"assignPublicIp": "string"
},
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string",
"vcpus": number,
"volumes": [
{
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string",
"iam": "string"
},
"fileSystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": number
},
"host": {
"sourcePath": "string"
},
"name": "string"
}
]
},
"ecsProperties": {
"taskProperties": [
{
"containers": [
{
"command": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],
"environment": [
{
"name": "string",
"value": "string"
}
],
"essential": boolean,
"image": "string",
"linuxParameters": {
"devices": [
{
"containerPath": "string",
"hostPath": "string",
"permissions": [ "string" ]
}
],
"initProcessEnabled": boolean,
"maxSwap": number,
"sharedMemorySize": number,
"swappiness": number,
"tmpfs": [
{
"containerPath": "string",
"mountOptions": [ "string" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"name": "string",
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"ipcMode": "string",
"networkConfiguration": {
"assignPublicIp": "string"
},
"pidMode": "string",
"platformVersion": "string",
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"taskRoleArn": "string",
"volumes": [
{
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string",
"iam": "string"
},
"fileSystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": number
},
"host": {
"sourcePath": "string"
},
"name": "string"
}
]
}
]
},
"eksProperties": {
"podProperties": {
"containers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"dnsPolicy": "string",
"hostNetwork": boolean,
"imagePullSecrets": [
{
"name": "string"
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"metadata": {
"labels": {
"string" : "string"
}
},
"serviceAccountName": "string",
"shareProcessNamespace": boolean,
"volumes": [
{
"emptyDir": {
"medium": "string",
"sizeLimit": "string"
},
"hostPath": {
"path": "string"
},
"name": "string",
"secret": {
"optional": boolean,
"secretName": "string"
}
}
]
}
},
"jobDefinitionName": "string",
"nodeProperties": {
"mainNode": number,
"nodeRangeProperties": [
{
"container": {
"command": [ "string" ],
"environment": [
{
"name": "string",
"value": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"fargatePlatformConfiguration": {
"platformVersion": "string"
},
"image": "string",
"instanceType": "string",
"jobRoleArn": "string",
"linuxParameters": {
"devices": [
{
"containerPath": "string",
"hostPath": "string",
"permissions": [ "string" ]
}
],
"initProcessEnabled": boolean,
"maxSwap": number,
"sharedMemorySize": number,
"swappiness": number,
"tmpfs": [
{
"containerPath": "string",
"mountOptions": [ "string" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"memory": number,
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"networkConfiguration": {
"assignPublicIp": "string"
},
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string",
"vcpus": number,
"volumes": [
{
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string",
"iam": "string"
},
"fileSystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": number
},
"host": {
"sourcePath": "string"
},
"name": "string"
}
]
},
"ecsProperties": {
"taskProperties": [
{
"containers": [
{
"command": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],
"environment": [
{
"name": "string",
"value": "string"
}
],
"essential": boolean,
"image": "string",
"linuxParameters": {
"devices": [
{
"containerPath": "string",
"hostPath": "string",
"permissions": [ "string" ]
}
],
"initProcessEnabled": boolean,
"maxSwap": number,
"sharedMemorySize": number,
"swappiness": number,
"tmpfs": [
{
"containerPath": "string",
"mountOptions": [ "string" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"name": "string",
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"ipcMode": "string",
"networkConfiguration": {
"assignPublicIp": "string"
},
"pidMode": "string",
"platformVersion": "string",
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"taskRoleArn": "string",
"volumes": [
{
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string",
"iam": "string"
},
"fileSystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": number
},
"host": {
"sourcePath": "string"
},
"name": "string"
}
]
}
]
},
"eksProperties": {
"podProperties": {
"containers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"dnsPolicy": "string",
"hostNetwork": boolean,
"imagePullSecrets": [
{
"name": "string"
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"metadata": {
"labels": {
"string" : "string"
}
},
"serviceAccountName": "string",
"shareProcessNamespace": boolean,
"volumes": [
{
"emptyDir": {
"medium": "string",
"sizeLimit": "string"
},
"hostPath": {
"path": "string"
},
"name": "string",
"secret": {
"optional": boolean,
"secretName": "string"
}
}
]
}
},
"instanceTypes": [ "string" ],
"targetNodes": "string"
}
],
"numNodes": number
},
"parameters": {
"string" : "string"
},
"platformCapabilities": [ "string" ],
"propagateTags": boolean,
"retryStrategy": {
"attempts": number,
"evaluateOnExit": [
{
"action": "string",
"onExitCode": "string",
"onReason": "string",
"onStatusReason": "string"
}
]
},
"schedulingPriority": number,
"tags": {
"string" : "string"
},
"timeout": {
"attemptDurationSeconds": number
},
"type": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- containerProperties
-
An object with properties specific to Amazon ECS-based single-node container-based jobs. If the job definition's
typeparameter iscontainer, then you must specify eithercontainerPropertiesornodeProperties. This must not be specified for Amazon EKS-based job definitions.Note
If the job runs on Fargate resources, then you must not specify
nodeProperties; use onlycontainerProperties.Type: ContainerProperties object
Required: No
- ecsProperties
-
An object with properties that are specific to Amazon ECS-based jobs. This must not be specified for Amazon EKS-based job definitions.
Type: EcsProperties object
Required: No
- eksProperties
-
An object with properties that are specific to Amazon EKS-based jobs. This must not be specified for Amazon ECS based job definitions.
Type: EksProperties object
Required: No
- jobDefinitionName
-
The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Type: String
Required: Yes
- nodeProperties
-
An object with properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide.
Note
If the job runs on Fargate resources, then you must not specify
nodeProperties; usecontainerPropertiesinstead.Note
If the job runs on Amazon EKS resources, then you must not specify
nodeProperties.Type: NodeProperties object
Required: No
- parameters
-
Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a
SubmitJobrequest override any corresponding parameter defaults from the job definition.Type: String to string map
Required: No
- platformCapabilities
-
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specifyFARGATE.Note
If the job runs on Amazon EKS resources, then you must not specify
platformCapabilities.Type: Array of strings
Valid Values:
EC2 | FARGATERequired: No
- propagateTags
-
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the
FAILEDstate.Note
If the job runs on Amazon EKS resources, then you must not specify
propagateTags.Type: Boolean
Required: No
- retryStrategy
-
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
Type: RetryStrategy object
Required: No
- schedulingPriority
-
The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
The minimum supported value is 0 and the maximum supported value is 9999.
Type: Integer
Required: No
-
The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
Required: No
- timeout
-
The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.
Type: JobTimeout object
Required: No
- type
-
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.
-
If the value is
container, then one of the following is required:containerProperties,ecsProperties, oreksProperties. -
If the value is
multinode, thennodePropertiesis required.
Note
If the job is run on Fargate resources, then
multinodeisn't supported.Type: String
Valid Values:
container | multinodeRequired: Yes
-
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"jobDefinitionArn": "string",
"jobDefinitionName": "string",
"revision": number
}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.
- jobDefinitionArn
-
The Amazon Resource Name (ARN) of the job definition.
Type: String
- jobDefinitionName
-
The name of the job definition.
Type: String
- revision
-
The revision of the job definition.
Type: Integer
Errors
- ClientException
-
These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
Examples
In the following example or examples, the Authorization header contents
(
[authorization-params]
) must be replaced with an AWS Signature Version 4
signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the
AWS
General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI)
Example
This example registers a job definition for a simple container job.
Sample Request
POST /v1/registerjobdefinition HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20201128T215526Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78
{
"containerProperties": {
"image": "busybox",
"command": [
"sleep",
"10"
],
"resourceRequirements": [
{
"type": "MEMORY",
"value": "128"
},
{
"type": "VCPU",
"value": "1"
}
]
},
"type": "container",
"jobDefinitionName": "sleep10"
}Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Mon, 28 Nov 2020 21:55:27 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 7a06af51e583997d8673ab89482dd45a.cloudfront.net (CloudFront)
X-Amz-Cf-Id: Y14HPNWWcKgm1U0wJPfLBzLDvrMSdyuHo4GMi0oQwI0ukruLpi0nFw==
{
"jobDefinitionName": "sleep10",
"jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep10:1",
"revision": 1
}Example
This example registers a job definition for a simple container job with retries.
Sample Request
POST /v1/registerjobdefinition HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20170327T145208Z
User-Agent: aws-cli/1.11.66 Python/2.7.10 Darwin/16.4.0 botocore/1.5.29
{
"containerProperties": {
"mountPoints": [],
"image": "amazonlinux",
"environment": [],
"command": [
"/bin/bash",
"-c",
"exit $AWS_BATCH_JOB_ATTEMPT"
],
"volumes": [],
"resourceRequirements": [
{
"type": "MEMORY",
"value": "8"
},
{
"type": "VCPU",
"value": "1"
}
],
"ulimits": []
},
"retryStrategy": {
"attempts": 3
},
"jobDefinitionName": "EchoAttemptNumber",
"parameters": {},
"type": "container"
}Sample Response
HTTP/1.1 200 OK
Date: Mon, 27 Mar 2017 14:51:58 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 861b49a34b383ce3ac4ea8b7117b8953.cloudfront.net (CloudFront)
X-Amz-Cf-Id: l3zCxHtlIx4c1-RN2vkqIlpSbU9tsZNxfMSg6oIf700wg1BX0V5f_A==
{
"jobDefinitionName": "EchoAttemptNumber",
"jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/EchoAttemptNumber:1",
"revision": 1
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
