Registers an AWS Batch job definition.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
register-job-definition
--job-definition-name <value>
--type <value>
[--parameters <value>]
[--container-properties <value>]
[--node-properties <value>]
[--retry-strategy <value>]
[--propagate-tags | --no-propagate-tags]
[--timeout <value>]
[--tags <value>]
[--platform-capabilities <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--job-definition-name
(string)
The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
--type
(string)
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 .
Note
If the job is run on Fargate resources, then
multinode
isn’t supported.Possible values:
container
multinode
--parameters
(map)
Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a
SubmitJob
request override any corresponding parameter defaults from the job definition.key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--container-properties
(structure)
An object with various properties specific to single-node container-based jobs. If the job definition’s
type
parameter iscontainer
, then you must specify eithercontainerProperties
ornodeProperties
.Note
If the job runs on Fargate resources, then you must not specify
nodeProperties
; use onlycontainerProperties
.image -> (string)
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `` repository-url /image :tag `` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to
Image
in the Create a container section of the Docker Remote API and theIMAGE
parameter of docker run .Note
Docker image architecture must match the processor architecture of the compute resources that they’re scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
Images in Amazon ECR repositories use the full registry and repository URI (for example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>
).Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
).Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
).Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).vcpus -> (integer)
This parameter is deprecated and not supported for jobs run on Fargate resources, see
resourceRequirement
. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job usingresourceRequirements
but the vCPU requirements can’t be specified both here and in theresourceRequirement
structure. This parameter maps toCpuShares
in the Create a container section of the Docker Remote API and the--cpu-shares
option to docker run . Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided. Jobs running on Fargate resources must specify the vCPU requirement for the job using
resourceRequirements
.memory -> (integer)
This parameter is deprecated and not supported for jobs run on Fargate resources, use
ResourceRequirement
. For jobs run on EC2 resources can specify the memory requirement using theResourceRequirement
structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps toMemory
in the Create a container section of the Docker Remote API and the--memory
option to docker run . You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.Note
If you’re trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide .
command -> (list)
The command that’s passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and theCOMMAND
parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd .(string)
jobRoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .
executionRoleArn -> (string)
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide .
volumes -> (list)
A list of data volumes used in a job.
(structure)
A data volume used in a job’s container properties.
host -> (structure)
The contents of the
host
parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn’t guaranteed to persist after the containers associated with it stop running.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
sourcePath -> (string)
The path on the host container instance that’s presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
name -> (string)
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the
sourceVolume
parameter of container definitionmountPoints
.environment -> (list)
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the--env
option to docker run .Warning
We don’t recommend using plaintext environment variables for sensitive information, such as credential data.
Note
Environment variables must not start with
AWS_BATCH
; this naming convention is reserved for variables that are set by the AWS Batch service.(structure)
A key-value pair object.
name -> (string)
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value -> (string)
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints -> (list)
The mount points for data volumes in your container. This parameter maps to
Volumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run .(structure)
Details on a Docker volume mount point that’s used in a job’s container properties. This parameter maps to
Volumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run.containerPath -> (string)
The path on the container where the host volume is mounted.
readOnly -> (boolean)
If this value is
true
, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value isfalse
.sourceVolume -> (string)
The name of the volume to mount.
readonlyRootFilesystem -> (boolean)
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the--read-only
option todocker run
.privileged -> (boolean)
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the
root
user). This parameter maps toPrivileged
in the Create a container section of the Docker Remote API and the--privileged
option to docker run . The default value is false.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided, or specified as false.
ulimits -> (list)
A list of
ulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run .Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
(structure)
The
ulimit
settings to pass to the container.Note
This object isn’t applicable to jobs running on Fargate resources.
hardLimit -> (integer)
The hard limit for the
ulimit
type.name -> (string)
The
type
of theulimit
.softLimit -> (integer)
The soft limit for the
ulimit
type.user -> (string)
The user name to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the--user
option to docker run .instanceType -> (string)
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
Note
This parameter isn’t applicable to single-node container jobs or for jobs running on Fargate resources and shouldn’t be provided.
resourceRequirements -> (list)
The type and amount of resources to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.(structure)
The type and amount of a resource to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.value -> (string)
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. The number of GPUs reserved for all containers in a job shouldn’t exceed the number of available GPUs on the compute resource that the job is launched on.
Note
GPUs are not available for jobs running on Fargate resources.
type=”MEMORY”
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to
Memory
in the Create a container section of the Docker Remote API and the--memory
option to docker run . You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps toMemory
in the Create a container section of the Docker Remote API and the--memory
option to docker run .Note
If you’re trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide .
For jobs running on Fargate resources, then
value
is the hard limit (in MiB), and must match one of the supported values and theVCPU
values must be one of the values supported for that memory value.value = 512
VCPU
= 0.25value = 1024
VCPU
= 0.25 or 0.5value = 2048
VCPU
= 0.25, 0.5, or 1value = 3072
VCPU
= 0.5, or 1value = 4096
VCPU
= 0.5, 1, or 2value = 5120, 6144, or 7168
VCPU
= 1 or 2value = 8192
VCPU
= 1, 2, or 4value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
VCPU
= 2 or 4value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
VCPU
= 4type=”VCPU”
The number of vCPUs reserved for the container. This parameter maps to
CpuShares
in the Create a container section of the Docker Remote API and the--cpu-shares
option to docker run . Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.For jobs running on Fargate resources, then
value
must match one of the supported values and theMEMORY
values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4value = 0.25
MEMORY
= 512, 1024, or 2048value = 0.5
MEMORY
= 1024, 2048, 3072, or 4096value = 1
MEMORY
= 2048, 3072, 4096, 5120, 6144, 7168, or 8192value = 2
MEMORY
= 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384value = 4
MEMORY
= 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720type -> (string)
The type of resource to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.linuxParameters -> (structure)
Linux-specific modifications that are applied to the container, such as details for device mappings.
devices -> (list)
Any host devices to expose to the container. This parameter maps to
Devices
in the Create a container section of the Docker Remote API and the--device
option to docker run .Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
(structure)
An object representing a container instance host device.
Note
This object isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
hostPath -> (string)
The path for the device on the host container instance.
containerPath -> (string)
The path inside the container used to expose the host device. By default the
hostPath
value is used.permissions -> (list)
The explicit permissions to provide to the container for the device. By default, the container has permissions for
read
,write
, andmknod
for the device.(string)
initProcessEnabled -> (boolean)
If true, run an
init
process inside the container that forwards signals and reaps processes. This parameter maps to the--init
option to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:sudo docker version | grep "Server API version"
sharedMemorySize -> (integer)
The value for the size (in MiB) of the
/dev/shm
volume. This parameter maps to the--shm-size
option to docker run .Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
tmpfs -> (list)
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs
option to docker run .Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
(structure)
The container path, mount options, and size of the tmpfs mount.
Note
This object isn’t applicable to jobs running on Fargate resources.
containerPath -> (string)
The absolute file path in the container where the tmpfs volume is mounted.
size -> (integer)
The size (in MiB) of the tmpfs volume.
mountOptions -> (list)
The list of tmpfs volume mount options.
Valid values: “
defaults
” | “ro
” | “rw
” | “suid
” | “nosuid
” | “dev
” | “nodev
” | “exec
” | “noexec
” | “sync
” | “async
” | “dirsync
” | “remount
” | “mand
” | “nomand
” | “atime
” | “noatime
” | “diratime
” | “nodiratime
” | “bind
” | “rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime
” | “norelatime
” | “strictatime
” | “nostrictatime
” | “mode
” | “uid
” | “gid
” | “nr_inodes
” | “nr_blocks
” | “mpol
“(string)
maxSwap -> (integer)
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the
--memory-swap
option to docker run where the value is the sum of the container memory plus themaxSwap
value. For more information, see `--memory-swap
details <https://docs.docker.com/config/containers/resource_constraints/#–memory-swap-details>`__ in the Docker documentation.If a
maxSwap
value of0
is specified, the container doesn’t use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container doesn’t use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
parameter to be used.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
swappiness -> (integer)
This allows you to tune a container’s memory swappiness behavior. A
swappiness
value of0
causes swapping not to happen unless absolutely necessary. Aswappiness
value of100
causes pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter isn’t specified, a default value of60
is used. If a value isn’t specified formaxSwap
then this parameter is ignored. IfmaxSwap
is set to 0, the container doesn’t use swap. This parameter maps to the--memory-swappiness
option to docker run .Consider the following when you use a per-container swap configuration.
Swap space must be enabled and allocated on the container instance for the containers to use.
Note
The Amazon ECS optimized AMIs don’t have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
The swap space parameters are only supported for job definitions using EC2 resources.
If the
maxSwap
andswappiness
parameters are omitted from a job definition, each container will have a defaultswappiness
value of 60 and the total swap usage will be limited to two times the memory reservation of the container.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
logConfiguration -> (structure)
The log configuration specification for the container.
This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to docker run . By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.Note
AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:
sudo docker version | grep "Server API version"
Note
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .logDriver -> (string)
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
, andsplunk
.Note
Jobs running on Fargate resources are restricted to the
awslogs
andsplunk
log drivers.awslogs
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
Note
If you have a custom driver that’sn’t listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that’s available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn’t currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:
sudo docker version | grep "Server API version"
options -> (map)
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:
sudo docker version | grep "Server API version"
key -> (string)
value -> (string)
secretOptions -> (list)
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide .
(structure)
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the
secrets
container definition parameter.To reference sensitive information in the log configuration of a container, use the
secretOptions
container definition parameter.For more information, see Specifying sensitive data in the AWS Batch User Guide .
name -> (string)
The name of the secret.
valueFrom -> (string)
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
secrets -> (list)
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide .
(structure)
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the
secrets
container definition parameter.To reference sensitive information in the log configuration of a container, use the
secretOptions
container definition parameter.For more information, see Specifying sensitive data in the AWS Batch User Guide .
name -> (string)
The name of the secret.
valueFrom -> (string)
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
networkConfiguration -> (structure)
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
assignPublicIp -> (string)
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking . The default value is “DISABLED”.
fargatePlatformConfiguration -> (structure)
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
platformVersion -> (string)
The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn’t specified, the
LATEST
platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide .
JSON Syntax:
{
"image": "string",
"vcpus": integer,
"memory": integer,
"command": ["string", ...],
"jobRoleArn": "string",
"executionRoleArn": "string",
"volumes": [
{
"host": {
"sourcePath": "string"
},
"name": "string"
}
...
],
"environment": [
{
"name": "string",
"value": "string"
}
...
],
"mountPoints": [
{
"containerPath": "string",
"readOnly": true|false,
"sourceVolume": "string"
}
...
],
"readonlyRootFilesystem": true|false,
"privileged": true|false,
"ulimits": [
{
"hardLimit": integer,
"name": "string",
"softLimit": integer
}
...
],
"user": "string",
"instanceType": "string",
"resourceRequirements": [
{
"value": "string",
"type": "GPU"|"VCPU"|"MEMORY"
}
...
],
"linuxParameters": {
"devices": [
{
"hostPath": "string",
"containerPath": "string",
"permissions": ["READ"|"WRITE"|"MKNOD", ...]
}
...
],
"initProcessEnabled": true|false,
"sharedMemorySize": integer,
"tmpfs": [
{
"containerPath": "string",
"size": integer,
"mountOptions": ["string", ...]
}
...
],
"maxSwap": integer,
"swappiness": integer
},
"logConfiguration": {
"logDriver": "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk",
"options": {"string": "string"
...},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
...
]
},
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
...
],
"networkConfiguration": {
"assignPublicIp": "ENABLED"|"DISABLED"
},
"fargatePlatformConfiguration": {
"platformVersion": "string"
}
}
--node-properties
(structure)
An object with various 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 . If the job definition’s
type
parameter iscontainer
, then you must specify eithercontainerProperties
ornodeProperties
.Note
If the job runs on Fargate resources, then you must not specify
nodeProperties
; usecontainerProperties
instead.numNodes -> (integer)
The number of nodes associated with a multi-node parallel job.
mainNode -> (integer)
Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.
nodeRangeProperties -> (list)
A list of node ranges and their properties associated with a multi-node parallel job.
(structure)
An object representing the properties of the node range for a multi-node parallel job.
targetNodes -> (string)
The range of nodes, using node index values. A range of
0:3
indicates nodes with index values of0
through3
. If the starting range value is omitted (:n
), then0
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. Your accumulative node ranges must account for all nodes (0:n
). You can nest node ranges, for example0:10
and4:5
, in which case the4:5
range properties override the0:10
properties.container -> (structure)
The container details for the node range.
image -> (string)
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `` repository-url /image :tag `` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to
Image
in the Create a container section of the Docker Remote API and theIMAGE
parameter of docker run .Note
Docker image architecture must match the processor architecture of the compute resources that they’re scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
Images in Amazon ECR repositories use the full registry and repository URI (for example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>
).Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
).Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
).Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).vcpus -> (integer)
This parameter is deprecated and not supported for jobs run on Fargate resources, see
resourceRequirement
. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job usingresourceRequirements
but the vCPU requirements can’t be specified both here and in theresourceRequirement
structure. This parameter maps toCpuShares
in the Create a container section of the Docker Remote API and the--cpu-shares
option to docker run . Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided. Jobs running on Fargate resources must specify the vCPU requirement for the job using
resourceRequirements
.memory -> (integer)
This parameter is deprecated and not supported for jobs run on Fargate resources, use
ResourceRequirement
. For jobs run on EC2 resources can specify the memory requirement using theResourceRequirement
structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps toMemory
in the Create a container section of the Docker Remote API and the--memory
option to docker run . You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.Note
If you’re trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide .
command -> (list)
The command that’s passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and theCOMMAND
parameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd .(string)
jobRoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide .
executionRoleArn -> (string)
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide .
volumes -> (list)
A list of data volumes used in a job.
(structure)
A data volume used in a job’s container properties.
host -> (structure)
The contents of the
host
parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn’t guaranteed to persist after the containers associated with it stop running.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
sourcePath -> (string)
The path on the host container instance that’s presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
name -> (string)
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the
sourceVolume
parameter of container definitionmountPoints
.environment -> (list)
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the--env
option to docker run .Warning
We don’t recommend using plaintext environment variables for sensitive information, such as credential data.
Note
Environment variables must not start with
AWS_BATCH
; this naming convention is reserved for variables that are set by the AWS Batch service.(structure)
A key-value pair object.
name -> (string)
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value -> (string)
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints -> (list)
The mount points for data volumes in your container. This parameter maps to
Volumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run .(structure)
Details on a Docker volume mount point that’s used in a job’s container properties. This parameter maps to
Volumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run.containerPath -> (string)
The path on the container where the host volume is mounted.
readOnly -> (boolean)
If this value is
true
, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value isfalse
.sourceVolume -> (string)
The name of the volume to mount.
readonlyRootFilesystem -> (boolean)
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the--read-only
option todocker run
.privileged -> (boolean)
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the
root
user). This parameter maps toPrivileged
in the Create a container section of the Docker Remote API and the--privileged
option to docker run . The default value is false.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided, or specified as false.
ulimits -> (list)
A list of
ulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run .Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
(structure)
The
ulimit
settings to pass to the container.Note
This object isn’t applicable to jobs running on Fargate resources.
hardLimit -> (integer)
The hard limit for the
ulimit
type.name -> (string)
The
type
of theulimit
.softLimit -> (integer)
The soft limit for the
ulimit
type.user -> (string)
The user name to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the--user
option to docker run .instanceType -> (string)
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
Note
This parameter isn’t applicable to single-node container jobs or for jobs running on Fargate resources and shouldn’t be provided.
resourceRequirements -> (list)
The type and amount of resources to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.(structure)
The type and amount of a resource to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.value -> (string)
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. The number of GPUs reserved for all containers in a job shouldn’t exceed the number of available GPUs on the compute resource that the job is launched on.
Note
GPUs are not available for jobs running on Fargate resources.
type=”MEMORY”
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to
Memory
in the Create a container section of the Docker Remote API and the--memory
option to docker run . You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps toMemory
in the Create a container section of the Docker Remote API and the--memory
option to docker run .Note
If you’re trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide .
For jobs running on Fargate resources, then
value
is the hard limit (in MiB), and must match one of the supported values and theVCPU
values must be one of the values supported for that memory value.value = 512
VCPU
= 0.25value = 1024
VCPU
= 0.25 or 0.5value = 2048
VCPU
= 0.25, 0.5, or 1value = 3072
VCPU
= 0.5, or 1value = 4096
VCPU
= 0.5, 1, or 2value = 5120, 6144, or 7168
VCPU
= 1 or 2value = 8192
VCPU
= 1, 2, or 4value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
VCPU
= 2 or 4value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
VCPU
= 4type=”VCPU”
The number of vCPUs reserved for the container. This parameter maps to
CpuShares
in the Create a container section of the Docker Remote API and the--cpu-shares
option to docker run . Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.For jobs running on Fargate resources, then
value
must match one of the supported values and theMEMORY
values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4value = 0.25
MEMORY
= 512, 1024, or 2048value = 0.5
MEMORY
= 1024, 2048, 3072, or 4096value = 1
MEMORY
= 2048, 3072, 4096, 5120, 6144, 7168, or 8192value = 2
MEMORY
= 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384value = 4
MEMORY
= 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720type -> (string)
The type of resource to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.linuxParameters -> (structure)
Linux-specific modifications that are applied to the container, such as details for device mappings.
devices -> (list)
Any host devices to expose to the container. This parameter maps to
Devices
in the Create a container section of the Docker Remote API and the--device
option to docker run .Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
(structure)
An object representing a container instance host device.
Note
This object isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
hostPath -> (string)
The path for the device on the host container instance.
containerPath -> (string)
The path inside the container used to expose the host device. By default the
hostPath
value is used.permissions -> (list)
The explicit permissions to provide to the container for the device. By default, the container has permissions for
read
,write
, andmknod
for the device.(string)
initProcessEnabled -> (boolean)
If true, run an
init
process inside the container that forwards signals and reaps processes. This parameter maps to the--init
option to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:sudo docker version | grep "Server API version"
sharedMemorySize -> (integer)
The value for the size (in MiB) of the
/dev/shm
volume. This parameter maps to the--shm-size
option to docker run .Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
tmpfs -> (list)
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs
option to docker run .Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
(structure)
The container path, mount options, and size of the tmpfs mount.
Note
This object isn’t applicable to jobs running on Fargate resources.
containerPath -> (string)
The absolute file path in the container where the tmpfs volume is mounted.
size -> (integer)
The size (in MiB) of the tmpfs volume.
mountOptions -> (list)
The list of tmpfs volume mount options.
Valid values: “
defaults
” | “ro
” | “rw
” | “suid
” | “nosuid
” | “dev
” | “nodev
” | “exec
” | “noexec
” | “sync
” | “async
” | “dirsync
” | “remount
” | “mand
” | “nomand
” | “atime
” | “noatime
” | “diratime
” | “nodiratime
” | “bind
” | “rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime
” | “norelatime
” | “strictatime
” | “nostrictatime
” | “mode
” | “uid
” | “gid
” | “nr_inodes
” | “nr_blocks
” | “mpol
“(string)
maxSwap -> (integer)
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the
--memory-swap
option to docker run where the value is the sum of the container memory plus themaxSwap
value. For more information, see `--memory-swap
details <https://docs.docker.com/config/containers/resource_constraints/#–memory-swap-details>`__ in the Docker documentation.If a
maxSwap
value of0
is specified, the container doesn’t use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container doesn’t use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
parameter to be used.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
swappiness -> (integer)
This allows you to tune a container’s memory swappiness behavior. A
swappiness
value of0
causes swapping not to happen unless absolutely necessary. Aswappiness
value of100
causes pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter isn’t specified, a default value of60
is used. If a value isn’t specified formaxSwap
then this parameter is ignored. IfmaxSwap
is set to 0, the container doesn’t use swap. This parameter maps to the--memory-swappiness
option to docker run .Consider the following when you use a per-container swap configuration.
Swap space must be enabled and allocated on the container instance for the containers to use.
Note
The Amazon ECS optimized AMIs don’t have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
The swap space parameters are only supported for job definitions using EC2 resources.
If the
maxSwap
andswappiness
parameters are omitted from a job definition, each container will have a defaultswappiness
value of 60 and the total swap usage will be limited to two times the memory reservation of the container.Note
This parameter isn’t applicable to jobs running on Fargate resources and shouldn’t be provided.
logConfiguration -> (structure)
The log configuration specification for the container.
This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to docker run . By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.Note
AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:
sudo docker version | grep "Server API version"
Note
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide .logDriver -> (string)
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
, andsplunk
.Note
Jobs running on Fargate resources are restricted to the
awslogs
andsplunk
log drivers.awslogs
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
Note
If you have a custom driver that’sn’t listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that’s available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn’t currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:
sudo docker version | grep "Server API version"
options -> (map)
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command:
sudo docker version | grep "Server API version"
key -> (string)
value -> (string)
secretOptions -> (list)
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide .
(structure)
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the
secrets
container definition parameter.To reference sensitive information in the log configuration of a container, use the
secretOptions
container definition parameter.For more information, see Specifying sensitive data in the AWS Batch User Guide .
name -> (string)
The name of the secret.
valueFrom -> (string)
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
secrets -> (list)
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide .
(structure)
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the
secrets
container definition parameter.To reference sensitive information in the log configuration of a container, use the
secretOptions
container definition parameter.For more information, see Specifying sensitive data in the AWS Batch User Guide .
name -> (string)
The name of the secret.
valueFrom -> (string)
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
networkConfiguration -> (structure)
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
assignPublicIp -> (string)
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking . The default value is “DISABLED”.
fargatePlatformConfiguration -> (structure)
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
platformVersion -> (string)
The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn’t specified, the
LATEST
platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide .
JSON Syntax:
{
"numNodes": integer,
"mainNode": integer,
"nodeRangeProperties": [
{
"targetNodes": "string",
"container": {
"image": "string",
"vcpus": integer,
"memory": integer,
"command": ["string", ...],
"jobRoleArn": "string",
"executionRoleArn": "string",
"volumes": [
{
"host": {
"sourcePath": "string"
},
"name": "string"
}
...
],
"environment": [
{
"name": "string",
"value": "string"
}
...
],
"mountPoints": [
{
"containerPath": "string",
"readOnly": true|false,
"sourceVolume": "string"
}
...
],
"readonlyRootFilesystem": true|false,
"privileged": true|false,
"ulimits": [
{
"hardLimit": integer,
"name": "string",
"softLimit": integer
}
...
],
"user": "string",
"instanceType": "string",
"resourceRequirements": [
{
"value": "string",
"type": "GPU"|"VCPU"|"MEMORY"
}
...
],
"linuxParameters": {
"devices": [
{
"hostPath": "string",
"containerPath": "string",
"permissions": ["READ"|"WRITE"|"MKNOD", ...]
}
...
],
"initProcessEnabled": true|false,
"sharedMemorySize": integer,
"tmpfs": [
{
"containerPath": "string",
"size": integer,
"mountOptions": ["string", ...]
}
...
],
"maxSwap": integer,
"swappiness": integer
},
"logConfiguration": {
"logDriver": "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk",
"options": {"string": "string"
...},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
...
]
},
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
...
],
"networkConfiguration": {
"assignPublicIp": "ENABLED"|"DISABLED"
},
"fargatePlatformConfiguration": {
"platformVersion": "string"
}
}
}
...
]
}
--retry-strategy
(structure)
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.
attempts -> (integer)
The number of times to move a job to the
RUNNABLE
status. You can specify between 1 and 10 attempts. If the value ofattempts
is greater than one, the job is retried on failure the same number of attempts as the value.evaluateOnExit -> (list)
Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the
attempts
parameter must also be specified.(structure)
Specifies a set of conditions to be met, and an action to take (
RETRY
orEXIT
) if all conditions are met.onStatusReason -> (string)
Contains a glob pattern to match against the
StatusReason
returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs). and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.onReason -> (string)
Contains a glob pattern to match against the
Reason
returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs), and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.onExitCode -> (string)
Contains a glob pattern to match against the decimal representation of the
ExitCode
returned for a job. The patten can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.action -> (string)
Specifies the action to take if all of the specified conditions (
onStatusReason
,onReason
, andonExitCode
) are met. The values are not case sensitive.
Shorthand Syntax:
attempts=integer,evaluateOnExit=[{onStatusReason=string,onReason=string,onExitCode=string,action=string},{onStatusReason=string,onReason=string,onExitCode=string,action=string}]
JSON Syntax:
{
"attempts": integer,
"evaluateOnExit": [
{
"onStatusReason": "string",
"onReason": "string",
"onExitCode": "string",
"action": "RETRY"|"EXIT"
}
...
]
}
--propagate-tags
| --no-propagate-tags
(boolean)
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
FAILED
state.
--timeout
(structure)
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 .
attemptDurationSeconds -> (integer)
The time duration in seconds (measured from the job attempt’s
startedAt
timestamp) after which AWS Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.
Shorthand Syntax:
attemptDurationSeconds=integer
JSON Syntax:
{
"attemptDurationSeconds": integer
}
--tags
(map)
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 .
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--platform-capabilities
(list)
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
.(string)
Syntax:
"string" "string" ...
Where valid values are:
EC2
FARGATE
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To register a job definition
This example registers a job definition for a simple container job.
Command:
aws batch register-job-definition --job-definition-name sleep30 --type container --container-properties '{ "image": "busybox", "vcpus": 1, "memory": 128, "command": [ "sleep", "30"]}'
Output:
{
"jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1",
"jobDefinitionName": "sleep30",
"revision": 1
}
jobDefinitionName -> (string)
The name of the job definition.
jobDefinitionArn -> (string)
The Amazon Resource Name (ARN) of the job definition.
revision -> (integer)
The revision of the job definition.