POST

/v1/registerjobdefinition

http://batch.{region}.amazonaws.com/v1/registerjobdefinition

Registers an Batch job definition.

Access Token Required: API Key

Body Params

tagsobject

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 <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging Amazon Web Services Resources</a> in Batch User Guide.

typestringrequired

The type of job definition. For more information about multi-node parallel jobs, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html">Creating a multi-node parallel job definition</a> in the Batch User Guide. <note> If the job is run on Fargate resources, then <code>multinode</code> isn't supported. </note>

timeoutobject

An object that represents a job timeout configuration.

parametersobject

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition.

eksPropertiesobject

An object that contains the properties for the Kubernetes resources of a job.

propagateTagsboolean

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 <code>FAILED</code> state. <note> If the job runs on Amazon EKS resources, then you must not specify <code>propagateTags</code>. </note>

retryStrategyobject

The retry strategy that's associated with a job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html">Automated job retries</a> in the Batch User Guide.

nodePropertiesobject

An object that represents the node properties of a multi-node parallel job. <note> Node properties can't be specified for Amazon EKS based job definitions. </note>

jobDefinitionNamestringrequired

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 (_).

schedulingPriorityinteger

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.

containerPropertiesobject

Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.

platformCapabilitiesarray

The platform capabilities required by the job definition. If no value is specified, it defaults to <code>EC2</code>. To run the job on Fargate resources, specify <code>FARGATE</code>. <note> If the job runs on Amazon EKS resources, then you must not specify <code>platformCapabilities</code>. </note>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://batch.{region}.amazonaws.com/v1/registerjobdefinition' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}