2020/09/25 - AWS Batch - 3 updated api methods
Changes Update batch client to latest version
{'jobDefinitions': {'containerProperties': {'executionRoleArn': 'string',
'linuxParameters': {'initProcessEnabled': 'boolean',
'maxSwap': 'integer',
'sharedMemorySize': 'integer',
'swappiness': 'integer',
'tmpfs': [{'containerPath': 'string',
'mountOptions': ['string'],
'size': 'integer'}]},
'logConfiguration': {'logDriver': 'json-file '
'| '
'syslog '
'| '
'journald '
'| '
'gelf '
'| '
'fluentd '
'| '
'awslogs '
'| '
'splunk',
'options': {'string': 'string'},
'secretOptions': [{'name': 'string',
'valueFrom': 'string'}]},
'secrets': [{'name': 'string',
'valueFrom': 'string'}]},
'nodeProperties': {'nodeRangeProperties': {'container': {'executionRoleArn': 'string',
'linuxParameters': {'initProcessEnabled': 'boolean',
'maxSwap': 'integer',
'sharedMemorySize': 'integer',
'swappiness': 'integer',
'tmpfs': [{'containerPath': 'string',
'mountOptions': ['string'],
'size': 'integer'}]},
'logConfiguration': {'logDriver': 'json-file '
'| '
'syslog '
'| '
'journald '
'| '
'gelf '
'| '
'fluentd '
'| '
'awslogs '
'| '
'splunk',
'options': {'string': 'string'},
'secretOptions': [{'name': 'string',
'valueFrom': 'string'}]},
'secrets': [{'name': 'string',
'valueFrom': 'string'}]}}}}}
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.
See also: AWS API Documentation
Request Syntax
client.describe_job_definitions(
jobDefinitions=[
'string',
],
maxResults=123,
jobDefinitionName='string',
status='string',
nextToken='string'
)
list
A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
(string) --
integer
The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.
string
The name of the job definition to describe.
string
The status with which to filter job definitions.
string
The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
dict
Response Syntax
{
'jobDefinitions': [
{
'jobDefinitionName': 'string',
'jobDefinitionArn': 'string',
'revision': 123,
'status': 'string',
'type': 'string',
'parameters': {
'string': 'string'
},
'retryStrategy': {
'attempts': 123
},
'containerProperties': {
'image': 'string',
'vcpus': 123,
'memory': 123,
'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': 123,
'name': 'string',
'softLimit': 123
},
],
'user': 'string',
'instanceType': 'string',
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
],
'linuxParameters': {
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'READ'|'WRITE'|'MKNOD',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
],
'maxSwap': 123,
'swappiness': 123
},
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
},
'secretOptions': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
'timeout': {
'attemptDurationSeconds': 123
},
'nodeProperties': {
'numNodes': 123,
'mainNode': 123,
'nodeRangeProperties': [
{
'targetNodes': 'string',
'container': {
'image': 'string',
'vcpus': 123,
'memory': 123,
'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': 123,
'name': 'string',
'softLimit': 123
},
],
'user': 'string',
'instanceType': 'string',
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
],
'linuxParameters': {
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'READ'|'WRITE'|'MKNOD',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
],
'maxSwap': 123,
'swappiness': 123
},
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
},
'secretOptions': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
]
}
},
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobDefinitions (list) --
The list of job definitions.
(dict) --
An object representing an AWS Batch job definition.
jobDefinitionName (string) --
The name of the job definition.
jobDefinitionArn (string) --
The Amazon Resource Name (ARN) for the job definition.
revision (integer) --
The revision of the job definition.
status (string) --
The status of the job definition.
type (string) --
The type of job definition.
parameters (dict) --
Default parameters or parameter substitution placeholders that are 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. For more information about specifying parameters, see Job Definition Parameters in the AWS Batch User Guide.
(string) --
(string) --
retryStrategy (dict) --
The retry strategy to use for failed jobs that are submitted with this job definition.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may 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.
containerProperties (dict) --
An object with various properties specific to container-based jobs.
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 the IMAGE parameter of docker run.
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 or mongo).
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) --
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. You must specify at least one vCPU. 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.
memory (integer) --
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.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND 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.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see Amazon ECS task execution IAM role.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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 is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is 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.
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 definition mountPoints.
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.
(dict) --
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.
(dict) --
Details on a Docker volume mount point that is 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 at which to mount the host volume.
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 is false.
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 to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
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. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
resourceRequirements (list) --
The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
(dict) --
The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.
value (string) --
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
type (string) --
The type of resource to assign to a container. Currently, the only supported resource type is GPU.
linuxParameters (dict) --
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.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container at which 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, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
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.
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.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path where the tmpfs volume is to be 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 will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
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 may 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.
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"
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, and splunk.
For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
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 (dict) --
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"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer 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.
secrets (list) --
The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer 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.
timeout (dict) --
The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.
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.
nodeProperties (dict) --
An object with various properties specific to multi-node parallel jobs.
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.
(dict) --
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 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. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.
container (dict) --
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 the IMAGE parameter of docker run.
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 or mongo).
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) --
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. You must specify at least one vCPU. 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.
memory (integer) --
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.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND 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.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see Amazon ECS task execution IAM role.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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 is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is 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.
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 definition mountPoints.
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.
(dict) --
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.
(dict) --
Details on a Docker volume mount point that is 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 at which to mount the host volume.
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 is false.
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 to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
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. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
resourceRequirements (list) --
The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
(dict) --
The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.
value (string) --
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
type (string) --
The type of resource to assign to a container. Currently, the only supported resource type is GPU.
linuxParameters (dict) --
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.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container at which 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, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
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.
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.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path where the tmpfs volume is to be 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 will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
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 may 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.
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"
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, and splunk.
For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
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 (dict) --
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"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer 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.
secrets (list) --
The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer 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.
nextToken (string) --
The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
{'jobs': {'container': {'executionRoleArn': 'string',
'linuxParameters': {'initProcessEnabled': 'boolean',
'maxSwap': 'integer',
'sharedMemorySize': 'integer',
'swappiness': 'integer',
'tmpfs': [{'containerPath': 'string',
'mountOptions': ['string'],
'size': 'integer'}]},
'logConfiguration': {'logDriver': 'json-file | syslog '
'| journald | gelf | '
'fluentd | awslogs | '
'splunk',
'options': {'string': 'string'},
'secretOptions': [{'name': 'string',
'valueFrom': 'string'}]},
'secrets': [{'name': 'string', 'valueFrom': 'string'}]},
'nodeProperties': {'nodeRangeProperties': {'container': {'executionRoleArn': 'string',
'linuxParameters': {'initProcessEnabled': 'boolean',
'maxSwap': 'integer',
'sharedMemorySize': 'integer',
'swappiness': 'integer',
'tmpfs': [{'containerPath': 'string',
'mountOptions': ['string'],
'size': 'integer'}]},
'logConfiguration': {'logDriver': 'json-file '
'| '
'syslog '
'| '
'journald '
'| '
'gelf '
'| '
'fluentd '
'| '
'awslogs '
'| '
'splunk',
'options': {'string': 'string'},
'secretOptions': [{'name': 'string',
'valueFrom': 'string'}]},
'secrets': [{'name': 'string',
'valueFrom': 'string'}]}}}}}
Describes a list of AWS Batch jobs.
See also: AWS API Documentation
Request Syntax
client.describe_jobs(
jobs=[
'string',
]
)
list
[REQUIRED]
A list of up to 100 job IDs.
(string) --
dict
Response Syntax
{
'jobs': [
{
'jobName': 'string',
'jobId': 'string',
'jobQueue': 'string',
'status': 'SUBMITTED'|'PENDING'|'RUNNABLE'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
'attempts': [
{
'container': {
'containerInstanceArn': 'string',
'taskArn': 'string',
'exitCode': 123,
'reason': 'string',
'logStreamName': 'string',
'networkInterfaces': [
{
'attachmentId': 'string',
'ipv6Address': 'string',
'privateIpv4Address': 'string'
},
]
},
'startedAt': 123,
'stoppedAt': 123,
'statusReason': 'string'
},
],
'statusReason': 'string',
'createdAt': 123,
'retryStrategy': {
'attempts': 123
},
'startedAt': 123,
'stoppedAt': 123,
'dependsOn': [
{
'jobId': 'string',
'type': 'N_TO_N'|'SEQUENTIAL'
},
],
'jobDefinition': 'string',
'parameters': {
'string': 'string'
},
'container': {
'image': 'string',
'vcpus': 123,
'memory': 123,
'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,
'ulimits': [
{
'hardLimit': 123,
'name': 'string',
'softLimit': 123
},
],
'privileged': True|False,
'user': 'string',
'exitCode': 123,
'reason': 'string',
'containerInstanceArn': 'string',
'taskArn': 'string',
'logStreamName': 'string',
'instanceType': 'string',
'networkInterfaces': [
{
'attachmentId': 'string',
'ipv6Address': 'string',
'privateIpv4Address': 'string'
},
],
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
],
'linuxParameters': {
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'READ'|'WRITE'|'MKNOD',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
],
'maxSwap': 123,
'swappiness': 123
},
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
},
'secretOptions': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
'nodeDetails': {
'nodeIndex': 123,
'isMainNode': True|False
},
'nodeProperties': {
'numNodes': 123,
'mainNode': 123,
'nodeRangeProperties': [
{
'targetNodes': 'string',
'container': {
'image': 'string',
'vcpus': 123,
'memory': 123,
'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': 123,
'name': 'string',
'softLimit': 123
},
],
'user': 'string',
'instanceType': 'string',
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
],
'linuxParameters': {
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'READ'|'WRITE'|'MKNOD',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
],
'maxSwap': 123,
'swappiness': 123
},
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
},
'secretOptions': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
]
}
},
]
},
'arrayProperties': {
'statusSummary': {
'string': 123
},
'size': 123,
'index': 123
},
'timeout': {
'attemptDurationSeconds': 123
}
},
]
}
Response Structure
(dict) --
jobs (list) --
The list of jobs.
(dict) --
An object representing an AWS Batch job.
jobName (string) --
The name of the job.
jobId (string) --
The ID for the job.
jobQueue (string) --
The Amazon Resource Name (ARN) of the job queue with which the job is associated.
status (string) --
The current status for the job.
attempts (list) --
A list of job attempts associated with this job.
(dict) --
An object representing a job attempt.
container (dict) --
Details about the container in this job attempt.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
taskArn (string) --
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.
exitCode (integer) --
The exit code for the job attempt. A non-zero exit code is considered a failure.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
logStreamName (string) --
The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
networkInterfaces (list) --
The network interfaces associated with the job attempt.
(dict) --
An object representing the elastic network interface for a multi-node parallel job node.
attachmentId (string) --
The attachment ID for the network interface.
ipv6Address (string) --
The private IPv6 address for the network interface.
privateIpv4Address (string) --
The private IPv4 address for the network interface.
startedAt (integer) --
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).
stoppedAt (integer) --
The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
statusReason (string) --
A short, human-readable string to provide additional details about the current status of the job attempt.
statusReason (string) --
A short, human-readable string to provide additional details about the current status of the job.
createdAt (integer) --
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.
retryStrategy (dict) --
The retry strategy to use for this job if an attempt fails.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may 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.
startedAt (integer) --
The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter is not provided for child jobs of array jobs or multi-node parallel jobs.
stoppedAt (integer) --
The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
dependsOn (list) --
A list of job IDs on which this job depends.
(dict) --
An object representing an AWS Batch job dependency.
jobId (string) --
The job ID of the AWS Batch job associated with this dependency.
type (string) --
The type of the job dependency.
jobDefinition (string) --
The job definition that is used by this job.
parameters (dict) --
Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
(string) --
(string) --
container (dict) --
An object representing the details of the container that is associated with the job.
image (string) --
The image used to start the container.
vcpus (integer) --
The number of VCPUs allocated for the job.
memory (integer) --
The number of MiB of memory reserved for the job.
command (list) --
The command that is passed to the container.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) associated with the job upon execution.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see Amazon ECS task execution IAM role.
volumes (list) --
A list of volumes associated with the job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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 is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is 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.
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 definition mountPoints.
environment (list) --
The environment variables to pass to a container.
(dict) --
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.
(dict) --
Details on a Docker volume mount point that is 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 at which to mount the host volume.
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 is false.
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.
ulimits (list) --
A list of ulimit values to set in the container.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
softLimit (integer) --
The soft limit for the ulimit type.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
user (string) --
The user name to use inside the container.
exitCode (integer) --
The exit code to return upon completion.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance on which the container is running.
taskArn (string) --
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.
logStreamName (string) --
The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
instanceType (string) --
The instance type of the underlying host infrastructure of a multi-node parallel job.
networkInterfaces (list) --
The network interfaces associated with the job.
(dict) --
An object representing the elastic network interface for a multi-node parallel job node.
attachmentId (string) --
The attachment ID for the network interface.
ipv6Address (string) --
The private IPv6 address for the network interface.
privateIpv4Address (string) --
The private IPv4 address for the network interface.
resourceRequirements (list) --
The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
(dict) --
The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.
value (string) --
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
type (string) --
The type of resource to assign to a container. Currently, the only supported resource type is GPU.
linuxParameters (dict) --
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.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container at which 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, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
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.
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.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path where the tmpfs volume is to be 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 will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
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 may 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.
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"
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, and splunk.
For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
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 (dict) --
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"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer 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.
secrets (list) --
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer 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.
nodeDetails (dict) --
An object representing the details of a node that is associated with a multi-node parallel job.
nodeIndex (integer) --
The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
isMainNode (boolean) --
Specifies whether the current node is the main node for a multi-node parallel job.
nodeProperties (dict) --
An object representing the node properties of a multi-node parallel job.
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.
(dict) --
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 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. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.
container (dict) --
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 the IMAGE parameter of docker run.
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 or mongo).
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) --
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. You must specify at least one vCPU. 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.
memory (integer) --
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.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND 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.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see Amazon ECS task execution IAM role.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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 is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is 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.
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 definition mountPoints.
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.
(dict) --
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.
(dict) --
Details on a Docker volume mount point that is 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 at which to mount the host volume.
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 is false.
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 to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
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. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
resourceRequirements (list) --
The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
(dict) --
The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.
value (string) --
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
type (string) --
The type of resource to assign to a container. Currently, the only supported resource type is GPU.
linuxParameters (dict) --
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.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container at which 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, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
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.
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.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path where the tmpfs volume is to be 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 will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
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 may 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.
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"
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, and splunk.
For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
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 (dict) --
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"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer 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.
secrets (list) --
The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer 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.
arrayProperties (dict) --
The array properties of the job, if it is an array job.
statusSummary (dict) --
A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.
(string) --
(integer) --
size (integer) --
The size of the array job. This parameter is returned for parent array jobs.
index (integer) --
The job index within the array that is associated with this job. This parameter is returned for array job children.
timeout (dict) --
The timeout configuration for the job.
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.
{'containerProperties': {'executionRoleArn': 'string',
'linuxParameters': {'initProcessEnabled': 'boolean',
'maxSwap': 'integer',
'sharedMemorySize': 'integer',
'swappiness': 'integer',
'tmpfs': [{'containerPath': 'string',
'mountOptions': ['string'],
'size': 'integer'}]},
'logConfiguration': {'logDriver': 'json-file | syslog '
'| journald | gelf '
'| fluentd | '
'awslogs | splunk',
'options': {'string': 'string'},
'secretOptions': [{'name': 'string',
'valueFrom': 'string'}]},
'secrets': [{'name': 'string',
'valueFrom': 'string'}]},
'nodeProperties': {'nodeRangeProperties': {'container': {'executionRoleArn': 'string',
'linuxParameters': {'initProcessEnabled': 'boolean',
'maxSwap': 'integer',
'sharedMemorySize': 'integer',
'swappiness': 'integer',
'tmpfs': [{'containerPath': 'string',
'mountOptions': ['string'],
'size': 'integer'}]},
'logConfiguration': {'logDriver': 'json-file '
'| '
'syslog '
'| '
'journald '
'| '
'gelf '
'| '
'fluentd '
'| '
'awslogs '
'| '
'splunk',
'options': {'string': 'string'},
'secretOptions': [{'name': 'string',
'valueFrom': 'string'}]},
'secrets': [{'name': 'string',
'valueFrom': 'string'}]}}}}
Registers an AWS Batch job definition.
See also: AWS API Documentation
Request Syntax
client.register_job_definition(
jobDefinitionName='string',
type='container'|'multinode',
parameters={
'string': 'string'
},
containerProperties={
'image': 'string',
'vcpus': 123,
'memory': 123,
'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': 123,
'name': 'string',
'softLimit': 123
},
],
'user': 'string',
'instanceType': 'string',
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
],
'linuxParameters': {
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'READ'|'WRITE'|'MKNOD',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
],
'maxSwap': 123,
'swappiness': 123
},
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
},
'secretOptions': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
nodeProperties={
'numNodes': 123,
'mainNode': 123,
'nodeRangeProperties': [
{
'targetNodes': 'string',
'container': {
'image': 'string',
'vcpus': 123,
'memory': 123,
'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': 123,
'name': 'string',
'softLimit': 123
},
],
'user': 'string',
'instanceType': 'string',
'resourceRequirements': [
{
'value': 'string',
'type': 'GPU'
},
],
'linuxParameters': {
'devices': [
{
'hostPath': 'string',
'containerPath': 'string',
'permissions': [
'READ'|'WRITE'|'MKNOD',
]
},
],
'initProcessEnabled': True|False,
'sharedMemorySize': 123,
'tmpfs': [
{
'containerPath': 'string',
'size': 123,
'mountOptions': [
'string',
]
},
],
'maxSwap': 123,
'swappiness': 123
},
'logConfiguration': {
'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk',
'options': {
'string': 'string'
},
'secretOptions': [
{
'name': 'string',
'valueFrom': 'string'
},
]
},
'secrets': [
{
'name': 'string',
'valueFrom': 'string'
},
]
}
},
]
},
retryStrategy={
'attempts': 123
},
timeout={
'attemptDurationSeconds': 123
}
)
string
[REQUIRED]
The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
string
[REQUIRED]
The type of job definition.
dict
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.
(string) --
(string) --
dict
An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
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 the IMAGE parameter of docker run.
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 or mongo).
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) --
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. You must specify at least one vCPU. 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.
memory (integer) --
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.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND 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.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see Amazon ECS task execution IAM role.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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 is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is 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.
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 definition mountPoints.
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.
(dict) --
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.
(dict) --
Details on a Docker volume mount point that is 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 at which to mount the host volume.
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 is false.
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 to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) -- [REQUIRED]
The hard limit for the ulimit type.
name (string) -- [REQUIRED]
The type of the ulimit.
softLimit (integer) -- [REQUIRED]
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. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
resourceRequirements (list) --
The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
(dict) --
The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.
value (string) -- [REQUIRED]
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
type (string) -- [REQUIRED]
The type of resource to assign to a container. Currently, the only supported resource type is GPU.
linuxParameters (dict) --
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.
(dict) --
An object representing a container instance host device.
hostPath (string) -- [REQUIRED]
The path for the device on the host container instance.
containerPath (string) --
The path inside the container at which 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, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
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.
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.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) -- [REQUIRED]
The absolute file path where the tmpfs volume is to be mounted.
size (integer) -- [REQUIRED]
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 will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
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 may 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.
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"
logDriver (string) -- [REQUIRED]
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, and splunk.
For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
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 (dict) --
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"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer Guide.
name (string) -- [REQUIRED]
The name of the secret.
valueFrom (string) -- [REQUIRED]
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.
secrets (list) --
The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer Guide.
name (string) -- [REQUIRED]
The name of the secret.
valueFrom (string) -- [REQUIRED]
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.
dict
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 is container, then you must specify either containerProperties or nodeProperties.
numNodes (integer) -- [REQUIRED]
The number of nodes associated with a multi-node parallel job.
mainNode (integer) -- [REQUIRED]
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) -- [REQUIRED]
A list of node ranges and their properties associated with a multi-node parallel job.
(dict) --
An object representing the properties of the node range for a multi-node parallel job.
targetNodes (string) -- [REQUIRED]
The range of nodes, using node index values. 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. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.
container (dict) --
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 the IMAGE parameter of docker run.
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 or mongo).
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) --
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. You must specify at least one vCPU. 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.
memory (integer) --
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.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND 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.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see Amazon ECS task execution IAM role.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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 is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is 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.
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 definition mountPoints.
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.
(dict) --
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.
(dict) --
Details on a Docker volume mount point that is 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 at which to mount the host volume.
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 is false.
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 to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) -- [REQUIRED]
The hard limit for the ulimit type.
name (string) -- [REQUIRED]
The type of the ulimit.
softLimit (integer) -- [REQUIRED]
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. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
resourceRequirements (list) --
The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
(dict) --
The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.
value (string) -- [REQUIRED]
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
type (string) -- [REQUIRED]
The type of resource to assign to a container. Currently, the only supported resource type is GPU.
linuxParameters (dict) --
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.
(dict) --
An object representing a container instance host device.
hostPath (string) -- [REQUIRED]
The path for the device on the host container instance.
containerPath (string) --
The path inside the container at which 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, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
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.
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.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) -- [REQUIRED]
The absolute file path where the tmpfs volume is to be mounted.
size (integer) -- [REQUIRED]
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 will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
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 may 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.
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"
logDriver (string) -- [REQUIRED]
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, and splunk.
For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
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 (dict) --
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"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer Guide.
name (string) -- [REQUIRED]
The name of the secret.
valueFrom (string) -- [REQUIRED]
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.
secrets (list) --
The secrets for the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
(dict) --
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 Amazon Elastic Container Service Developer Guide.
name (string) -- [REQUIRED]
The name of the secret.
valueFrom (string) -- [REQUIRED]
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.
dict
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may 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.
dict
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 is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer 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.
dict
Response Syntax
{
'jobDefinitionName': 'string',
'jobDefinitionArn': 'string',
'revision': 123
}
Response Structure
(dict) --
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.