{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aws-batch/json-schema/aws-batch-submit-job-request-schema.json",
  "title": "SubmitJobRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aws-batch-jobs-api-openapi.yml#/components/schemas/SubmitJobRequest",
  "type": "object",
  "properties": {
    "jobName": {
      "type": "string",
      "description": "The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)."
    },
    "jobQueue": {
      "type": "string",
      "description": "The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue."
    },
    "shareIdentifier": {
      "type": "string",
      "description": "The share identifier for the job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified. This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*)."
    },
    "schedulingPriorityOverride": {
      "type": "integer",
      "description": "The scheduling priority for the job. 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. This overrides any scheduling priority in the job definition and works only within a single share identifier. The minimum supported value is 0 and the maximum supported value is 9999."
    },
    "arrayProperties": {
      "$ref": "#/$defs/ArrayProperties"
    },
    "dependsOn": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/JobDependency"
      },
      "description": "A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin."
    },
    "jobDefinition": {
      "type": "string",
      "description": "The job definition used by this job. This value can be one of definition-name, definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or without the revision (arn:aws:batch:region:account:job-definition/definition-name:revision , or arn:aws:batch:region:account:job-definition/definition-name ). If the revision is not specified, then the latest active revision is used."
    },
    "parameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition."
    },
    "containerOverrides": {
      "$ref": "#/$defs/ContainerOverrides"
    },
    "nodeOverrides": {
      "$ref": "#/$defs/NodeOverrides"
    },
    "retryStrategy": {
      "$ref": "#/$defs/RetryStrategy"
    },
    "propagateTags": {
      "type": "boolean",
      "description": "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 aren't 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 FAILED state. When specified, this overrides the tag propagation setting in the job definition."
    },
    "timeout": {
      "$ref": "#/$defs/JobTimeout"
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference."
    },
    "eksPropertiesOverride": {
      "$ref": "#/$defs/EksPropertiesOverride"
    },
    "ecsPropertiesOverride": {
      "$ref": "#/$defs/EcsPropertiesOverride"
    },
    "consumableResourcePropertiesOverride": {
      "$ref": "#/$defs/ConsumableResourceProperties"
    }
  },
  "required": [
    "jobName",
    "jobQueue",
    "jobDefinition"
  ],
  "$defs": {
    "ArrayProperties": {
      "type": "object",
      "properties": {
        "size": {
          "type": "integer",
          "description": "The size of the array job."
        }
      }
    },
    "ConsumableResourceProperties": {
      "type": "object",
      "properties": {
        "consumableResourceList": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ConsumableResourceRequirement"
          },
          "description": "The list of consumable resources required by a job."
        }
      }
    },
    "ConsumableResourceRequirement": {
      "type": "object",
      "properties": {
        "consumableResource": {
          "type": "string",
          "description": "The name or ARN of the consumable resource."
        },
        "quantity": {
          "type": "integer",
          "description": "The quantity of the consumable resource that is needed."
        }
      }
    },
    "ContainerOverrides": {
      "type": "object",
      "properties": {
        "vcpus": {
          "type": "integer",
          "description": "This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and valu"
        },
        "memory": {
          "type": "integer",
          "description": "This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set t"
        },
        "command": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The command to send to the container that overrides the default command from the Docker image or the job definition. This parameter can't contain an empty string."
        },
        "instanceType": {
          "type": "string",
          "description": "The instance type to use for a multi-node parallel job. This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided."
        },
        "environment": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/KeyValuePair"
          },
          "description": "The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition. Environment variables cannot start with \"AWS_BATCH\". This naming convention is reserved for variables that Batch sets."
        },
        "resourceRequirements": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ResourceRequirement"
          },
          "description": "The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU."
        }
      }
    },
    "EcsPropertiesOverride": {
      "type": "object",
      "properties": {
        "taskProperties": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaskPropertiesOverride"
          },
          "description": "The overrides for the Amazon ECS task definition of a job. This object is currently limited to one element."
        }
      }
    },
    "EksContainerEnvironmentVariable": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the environment variable."
        },
        "value": {
          "type": "string",
          "description": "The value of the environment variable."
        }
      },
      "required": [
        "name"
      ]
    },
    "EksContainerOverride": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "A pointer to the container that you want to override. The name must match a unique container name that you wish to override."
        },
        "image": {
          "type": "string",
          "description": "The override of the Docker image that's used to start the container."
        },
        "command": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The command to send to the container that overrides the default command from the Docker image or the job definition."
        },
        "args": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see Dockerfile reference: CMD and Define a command an arguments for a pod in the Kubernetes documentation."
        },
        "env": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/EksContainerEnvironmentVariable"
          },
          "description": "The environment variables to send to the container. You can add new environment variables, which are added to the container at launch. Or, you can override the existing environment variables from the Docker image or the job definition. Environment variables cannot start with \"AWS_BATCH\". This naming convention is reserved for variables that Batch sets."
        },
        "resources": {
          "$ref": "#/$defs/EksContainerResourceRequirements"
        }
      }
    },
    "EksContainerResourceRequirements": {
      "type": "object",
      "properties": {
        "limits": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "The type and quantity of the resources to reserve for the container. The values vary based on the name that's specified. Resources can be requested using either the limits or the requests objects. memory The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value t"
        },
        "requests": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "The type and quantity of the resources to request for the container. The values vary based on the name that's specified. Resources can be requested by using either the limits or the requests objects. memory The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both, then the value that's specified in limits must be equal to the value that'"
        }
      }
    },
    "EksMetadata": {
      "type": "object",
      "properties": {
        "labels": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63 uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be added or modified at any time. Each resource can have multiple labels, but each key must be unique for a given object."
        },
        "annotations": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Key-value pairs used to attach arbitrary, non-identifying metadata to Kubernetes objects. Valid annotation keys have two segments: an optional prefix and a name, separated by a slash (/). The prefix is optional and must be 253 characters or less. If specified, the prefix must be a DNS subdomain− a series of DNS labels separated by dots (.), and it must end with a slash (/). The name segment is required and must be 63 characters or less. It can include alphanumeric characters ([a-z0-9A-Z]), dashes (-), underscores (_), and dots (.), but must begin and end with an alphanumeric character. Annotat"
        },
        "namespace": {
          "type": "string",
          "description": "The namespace of the Amazon EKS cluster. In Kubernetes, namespaces provide a mechanism for isolating groups of resources within a single cluster. Names of resources need to be unique within a namespace, but not across namespaces. Batch places Batch Job pods in this namespace. If this field is provided, the value can't be empty or null. It must meet the following requirements: 1-63 characters long Can't be set to default Can't start with kube Must match the following regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ For more information, see Namespaces in the Kubernetes documentation. This na"
        }
      }
    },
    "EksPodPropertiesOverride": {
      "type": "object",
      "properties": {
        "containers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/EksContainerOverride"
          },
          "description": "The overrides for the container that's used on the Amazon EKS pod."
        },
        "initContainers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/EksContainerOverride"
          },
          "description": "The overrides for the initContainers defined in the Amazon EKS pod. These containers run before application containers, always run to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init Containers in the Kubernetes documentation."
        },
        "metadata": {
          "$ref": "#/$defs/EksMetadata"
        }
      }
    },
    "EksPropertiesOverride": {
      "type": "object",
      "properties": {
        "podProperties": {
          "$ref": "#/$defs/EksPodPropertiesOverride"
        }
      }
    },
    "EvaluateOnExit": {
      "type": "object",
      "properties": {
        "onStatusReason": {
          "type": "string",
          "description": "Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match."
        },
        "onReason": {
          "type": "string",
          "description": "Contains a glob pattern to match against the Reason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match."
        },
        "onExitCode": {
          "type": "string",
          "description": "Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match. The string can contain up to 512 characters."
        },
        "action": {
          "type": "string",
          "enum": [
            "RETRY",
            "EXIT"
          ],
          "description": "Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive."
        }
      },
      "required": [
        "action"
      ]
    },
    "JobDependency": {
      "type": "object",
      "properties": {
        "jobId": {
          "type": "string",
          "description": "The job ID of the Batch job that's associated with this dependency."
        },
        "type": {
          "type": "string",
          "enum": [
            "N_TO_N",
            "SEQUENTIAL"
          ],
          "description": "The type of the job dependency."
        }
      }
    },
    "JobTimeout": {
      "type": "object",
      "properties": {
        "attemptDurationSeconds": {
          "type": "integer",
          "description": "The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60 seconds. For array jobs, the timeout applies to the child jobs, not to the parent array job. For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes."
        }
      }
    },
    "KeyValuePair": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable."
        },
        "value": {
          "type": "string",
          "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable."
        }
      }
    },
    "NodeOverrides": {
      "type": "object",
      "properties": {
        "numNodes": {
          "type": "integer",
          "description": "The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions: There must be at least one node range in your job definition that has an open upper boundary, such as : or n:. The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override. The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override."
        },
        "nodePropertyOverrides": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/NodePropertyOverride"
          },
          "description": "The node property overrides for the job."
        }
      }
    },
    "NodePropertyOverride": {
      "type": "object",
      "properties": {
        "targetNodes": {
          "type": "string",
          "description": "The range of nodes, using node index values, that's used to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range."
        },
        "containerOverrides": {
          "$ref": "#/$defs/ContainerOverrides"
        },
        "ecsPropertiesOverride": {
          "$ref": "#/$defs/EcsPropertiesOverride"
        },
        "instanceTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "An object that contains the instance types that you want to replace for the existing resources of a job."
        },
        "eksPropertiesOverride": {
          "$ref": "#/$defs/EksPropertiesOverride"
        },
        "consumableResourcePropertiesOverride": {
          "$ref": "#/$defs/ConsumableResourceProperties"
        }
      },
      "required": [
        "targetNodes"
      ]
    },
    "ResourceRequirement": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "description": "The quantity of the specified resource to reserve for the container. The values vary based on the type specified. type=\"GPU\" The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on. GPUs aren't available for jobs that are running on Fargate resources. type=\"MEMORY\" The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on Amazon EC2 resources. If your container attempts to"
        },
        "type": {
          "type": "string",
          "enum": [
            "GPU",
            "VCPU",
            "MEMORY"
          ],
          "description": "The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU."
        }
      },
      "required": [
        "value",
        "type"
      ]
    },
    "RetryStrategy": {
      "type": "object",
      "properties": {
        "attempts": {
          "type": "integer",
          "description": "The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value."
        },
        "evaluateOnExit": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/EvaluateOnExit"
          },
          "description": "Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is specified, then the attempts parameter must also be specified. If none of the listed conditions match, then the job is retried."
        }
      }
    },
    "TaskContainerOverrides": {
      "type": "object",
      "properties": {
        "command": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The command to send to the container that overrides the default command from the Docker image or the job definition. This parameter can't contain an empty string."
        },
        "environment": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/KeyValuePair"
          },
          "description": "The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition. Environment variables cannot start with AWS_BATCH. This naming convention is reserved for variables that Batch sets."
        },
        "name": {
          "type": "string",
          "description": "A pointer to the container that you want to override. The container's name provides a unique identifier for the container being used."
        },
        "resourceRequirements": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ResourceRequirement"
          },
          "description": "The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU."
        }
      }
    },
    "TaskPropertiesOverride": {
      "type": "object",
      "properties": {
        "containers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaskContainerOverrides"
          },
          "description": "The overrides for the container definition of a job."
        }
      }
    }
  }
}