Integer size
The size of the array job.
Map<K,V> statusSummary
A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.
Integer size
The size of the array job. This parameter is returned for parent array jobs.
Integer index
The job index within the array that's associated with this job. This parameter is returned for array job children.
String containerInstanceArn
The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
String taskArn
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container
attempt receives a task ARN when they reach the STARTING status.
Integer exitCode
The exit code for the job attempt. A non-zero exit code is considered a failure.
String reason
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
String logStreamName
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.
List<E> networkInterfaces
The network interfaces associated with the job attempt.
AttemptContainerDetail container
Details about the container in this job attempt.
Long startedAt
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the
STARTING state to the RUNNING state).
Long stoppedAt
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).
String statusReason
A short, human-readable string to provide additional details about the current status of the job attempt.
String jobId
The AWS Batch job ID of the job to cancel.
String reason
A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.
String computeEnvironmentName
The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
String computeEnvironmentArn
The Amazon Resource Name (ARN) of the compute environment.
String ecsClusterArn
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
Map<K,V> tags
The tags applied to the compute environment.
String type
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in
the AWS Batch User Guide.
String state
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated
job queue on the compute resources within the environment. If the compute environment is managed, then it can
scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
String status
The current status of the compute environment (for example, CREATING or VALID).
String statusReason
A short, human-readable string to provide additional details about the current status of the compute environment.
ComputeResource computeResources
The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
String serviceRole
The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
Integer order
The order of the compute environment. Compute environments are tried in ascending order. For example, if two
compute environments are associated with a job queue, the compute environment with a lower order
integer value is tried for job placement first.
String computeEnvironment
The Amazon Resource Name (ARN) of the compute environment.
String type
The type of compute environment: EC2, SPOT, FARGATE, or
FARGATE_SPOT. For more information, see Compute Environments in
the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role
in the AWS Batch User Guide.
String allocationStrategy
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost
instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the
additional instances to be available. If there aren't enough instances available, or if the user is hitting Amazon EC2 service limits
then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps
costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet
IAM Role must be specified.
AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might
need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds
maxvCpus by more than a single instance.
Integer minvCpus
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
DISABLED).
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Integer maxvCpus
The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS
Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance. For example, no more than a single instance
from among those specified in your compute environment is allocated.
Integer desiredvCpus
The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
List<E> instanceTypes
The instances types that can be launched. You can specify instance families to launch any instance type within
those families (for example, c5 or p3), or you can specify specific sizes within a
family (such as c5.8xlarge). You can also choose optimal to select instance types (from
the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that
don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families
are used.
String imageId
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is
overridden by the imageIdOverride member of the Ec2Configuration structure.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
List<E> subnets
The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
List<E> securityGroupIds
The Amazon EC2 security groups associated with instances launched in the compute environment. One or more
security groups must be specified, either in securityGroupIds or using a launch template referenced
in launchTemplate. This parameter is required for jobs running on Fargate resources and must contain
at least one security group. Fargate doesn't support launch templates. If security groups are specified using
both securityGroupIds and launchTemplate, the values in securityGroupIds
is used.
String ec2KeyPair
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
String instanceRole
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the
short name or full Amazon Resource Name (ARN) of an instance profile. For example,
ecsInstanceRole or
arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more
information, see Amazon ECS
Instance Role in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Map<K,V> tags
Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch,
these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value−for
example, { "Name": "AWS Batch Instance - C4OnDemand" }. This is helpful for recognizing your AWS Batch instances
in the Amazon EC2 console. These tags can't be updated or removed after the compute environment has been created;
any changes require creating a new compute environment and removing the old compute environment. These tags
aren't seen when using the AWS Batch ListTagsForResource API operation.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
String placementGroup
The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Integer bidPercentage
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
String spotIamFleetRole
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute
environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation
strategy isn't specified. For more information, see Amazon EC2 Spot Fleet Role
in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
LaunchTemplateSpecification launchTemplate
The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
List<E> ec2Configuration
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If
Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Integer minvCpus
The minimum number of Amazon EC2 vCPUs that an environment should maintain.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Integer maxvCpus
The maximum number of Amazon EC2 vCPUs that an environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS
Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from
among those specified in your compute environment.
Integer desiredvCpus
The desired number of Amazon EC2 vCPUS in the compute environment.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
List<E> subnets
The VPC subnets that the compute resources are launched into. Fargate compute resources can contain up to 16 subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
List<E> securityGroupIds
The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is made.
String image
The image used to start the container.
Integer vcpus
The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU
requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in
both the vcpus and resourceRequirement object. 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. It must be specified for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources,
you must specify the vCPU requirement for the job using resourceRequirements.
Integer memory
For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the
number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see
resourceRequirements.
List<E> command
The command that's passed to the container.
String jobRoleArn
The Amazon Resource Name (ARN) associated with the job upon execution.
String executionRoleArn
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
List<E> volumes
A list of volumes associated with the job.
List<E> environment
The environment variables to pass to a container.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for
variables that are set by the AWS Batch service.
List<E> mountPoints
The mount points for data volumes in your container.
Boolean readonlyRootFilesystem
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 .
List<E> ulimits
A list of ulimit values 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.
This parameter isn't applicable to jobs running on Fargate resources.
Boolean privileged
When this parameter is true, the container is given elevated permissions on the host container instance (similar
to the root user). The default value is false.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided, or specified as false.
String user
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.
Integer exitCode
The exit code to return upon completion.
String reason
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
String containerInstanceArn
The Amazon Resource Name (ARN) of the container instance that the container is running on.
String taskArn
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container
attempt receives a task ARN when they reach the STARTING status.
String logStreamName
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.
String instanceType
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs running on Fargate resources.
List<E> networkInterfaces
The network interfaces associated with the job.
List<E> resourceRequirements
The type and amount of resources to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
LinuxParameters linuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
LogConfiguration logConfiguration
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option
to docker run. By default, containers use the same
logging driver that the Docker daemon uses. However, the container might use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the container definition. To use a different
logging driver for a container, the log system must be configured properly on the container instance. Or,
alternatively, it must be configured 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.
AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.
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"
The Amazon ECS container agent running on a container instance must register the logging drivers available on
that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed
on that instance can use these log configuration options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
List<E> secrets
The secrets to pass to the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
NetworkConfiguration networkConfiguration
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
FargatePlatformConfiguration fargatePlatformConfiguration
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
Integer vcpus
This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus
parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the
resourceRequirement structure in the job definition.
This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate
resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can
use either this parameter or resourceRequirement but not both.
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 parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided. For jobs that
run on Fargate resources, you must specify the vCPU requirement for the job using
resourceRequirements.
Integer memory
This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the
memory parameter set in the job definition, but doesn't override any memory requirement specified in
the ResourceRequirement structure in the job definition.
This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate
resources. For these resources, use resourceRequirement instead.
List<E> command
The command to send to the container that overrides the default command from the Docker image or the job definition.
String instanceType
The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.
List<E> environment
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for
variables that are set by the AWS Batch service.
List<E> resourceRequirements
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The
supported resources include GPU, MEMORY, and VCPU.
String image
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.
Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
Images in Amazon ECR repositories use the full registry and repository URI (for example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu 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).
Integer vcpus
The number of vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to
CpuShares in the Create a
container section of the Docker Remote API and the
--cpu-shares option to docker run. The
number of vCPUs must be specified but can be be specified in several places. You must specify it at least once
for each node.
This parameter is supported on EC2 resources but isn't supported for jobs that run on Fargate resources. For
these resources, use resourceRequirement instead. You can use this parameter or
resourceRequirements structure but not both.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. For jobs that run
on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
Integer memory
This parameter indicates the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it is terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.
This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate resources, you
should specify the memory requirement using resourceRequirement. You can do this for EC2 resources.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
List<E> command
The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to
docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
String jobRoleArn
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
String executionRoleArn
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
List<E> volumes
A list of data volumes used in a job.
List<E> environment
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.
We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for
variables that are set by the AWS Batch service.
List<E> mountPoints
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.
Boolean readonlyRootFilesystem
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.
Boolean privileged
When this parameter is true, the container is given elevated permissions 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. The default value is false.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided, or specified as false.
List<E> ulimits
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.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
String user
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.
String instanceType
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
This parameter isn't applicable to single-node container jobs or for jobs that run on Fargate resources and shouldn't be provided.
List<E> resourceRequirements
The type and amount of resources to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
LinuxParameters linuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
LogConfiguration logConfiguration
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option
to docker run. By default, containers use the same
logging driver that the Docker daemon uses. However the container might use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the container definition. To use a different
logging driver for a container, the log system must be configured properly on the container instance (or on a
different log server for remote logging options). For more information on the options for different supported log
drivers, see Configure logging drivers in
the Docker documentation.
AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the
Docker Remote API version on your container instance, log into your container instance and run the following
command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must register the logging drivers available on
that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed
on that instance can use these log configuration options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
List<E> secrets
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
NetworkConfiguration networkConfiguration
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
FargatePlatformConfiguration fargatePlatformConfiguration
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
String computeEnvironmentName
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
String type
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in
the AWS Batch User Guide.
String state
The state of the compute environment. If the state is ENABLED, then the compute environment accepts
jobs from a queue and can scale out automatically based on queues.
If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated
job queue on the compute resources within the environment. If the compute environment is managed, then it can
scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
ComputeResource computeResources
Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.
String serviceRole
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.
If your specified role has a path other than /, then you must specify either the full role ARN
(recommended) or prefix the role name with the path. For example, if a role with the name bar has a
path of /foo/ then you would specify /foo/bar as the role name. For more information,
see Friendly names and paths in the IAM User Guide.
Depending on how you created your AWS Batch service role, its ARN might contain the service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the
service-role path prefix. Because of this, we recommend that you specify the full ARN of your
service role when you create compute environments.
Map<K,V> tags
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
String jobQueueName
The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.
String state
The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job
queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can
finish.
Integer priority
The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
priority parameter) are evaluated first when associated with the same compute environment. Priority
is determined in descending order. For example, a job queue with a priority value of 10 is given
scheduling preference over a job queue with a priority value of 1. All of the compute environments
must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or
FARGATE_SPOT); EC2 and Fargate compute environments cannot be mixed.
List<E> computeEnvironmentOrder
The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler
uses this parameter to determine which compute environment should run a specific job. Compute environments must
be in the VALID state before you can associate them with a job queue. You can associate up to three
compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or
SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute
environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
Map<K,V> tags
The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.
String computeEnvironment
The name or Amazon Resource Name (ARN) of the compute environment to delete.
String jobQueue
The short name or full Amazon Resource Name (ARN) of the queue to delete.
String jobDefinition
The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to
deregister.
List<E> computeEnvironments
A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
Integer maxResults
The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
When this parameter is used, DescribeComputeEnvironments 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 DescribeComputeEnvironments request with the returned
nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
DescribeComputeEnvironments returns up to 100 results and a nextToken value if
applicable.
String nextToken
The nextToken value returned from a previous paginated DescribeComputeEnvironments
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.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
List<E> computeEnvironments
The list of compute environments.
String nextToken
The nextToken value to include in a future DescribeComputeEnvironments 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.
List<E> jobDefinitions
A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
Integer maxResults
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 and 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 isn't used, then DescribeJobDefinitions returns up
to 100 results and a nextToken value if applicable.
String jobDefinitionName
The name of the job definition to describe.
String status
The status used to filter job definitions.
String nextToken
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.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
List<E> jobDefinitions
The list of job definitions.
String nextToken
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.
List<E> jobQueues
A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
Integer maxResults
The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter
is used, DescribeJobQueues only returns maxResults results in a single page and a
nextToken response element. The remaining results of the initial request can be seen by sending
another DescribeJobQueues request with the returned nextToken value. This value can be
between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results
and a nextToken value if applicable.
String nextToken
The nextToken value returned from a previous paginated DescribeJobQueues 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.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
List<E> jobQueues
The list of job queues.
String nextToken
The nextToken value to include in a future DescribeJobQueues request. When the results
of a DescribeJobQueues 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.
String hostPath
The path for the device on the host container instance.
String containerPath
The path inside the container used to expose the host device. By default, the hostPath value is
used.
List<E> permissions
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 imageType
The image type to match with the instance type to select an AMI. If the imageIdOverride parameter
isn't specified, then a recent Amazon ECS-optimized
AMI (ECS_AL1) is used. Starting on March 31, 2021, this default will be changing to
ECS_AL2 (Amazon Linux
2).
Amazon Linux
2− Default for all AWS Graviton-based instance families (for example, C6g, M6g,
R6g, and T4g) and can be used for all non-GPU instance types.
Amazon Linux
2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be
used for all non-AWS Graviton-based instance types.
Amazon Linux−Default for all non-GPU, non-AWS Graviton instance families. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.
String imageIdOverride
The AMI ID used for instances launched in the compute environment that match the image type. This setting
overrides the imageId set in the computeResource object.
String accessPointId
The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfiguration must either be omitted or set to / which will enforce the path
set on the EFS access point. If an access point is used, transit encryption must be enabled in the
EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points
in the Amazon Elastic File System User Guide.
String iam
Whether or not to use the AWS Batch execution IAM role defined in a job definition when mounting the Amazon EFS
file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this
parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS
Access Points in the AWS Batch User Guide. EFS IAM authorization requires that
TransitEncryption be ENABLED and that a JobRoleArn is specified.
String fileSystemId
The Amazon EFS file system ID to use.
String rootDirectory
The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter
is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect
as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the root directory parameter must
either be omitted or set to / which will enforce the path set on the Amazon EFS access point.
String transitEncryption
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS
server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted,
the default value of DISABLED is used. For more information, see Encrypting data in transit in the
Amazon Elastic File System User Guide.
Integer transitEncryptionPort
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
EFSAuthorizationConfig authorizationConfig
The authorization configuration details for the Amazon EFS file system.
String onStatusReason
Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up
to 512 characters long, and can contain letters, numbers, periods (.), colons (:), and white space (including
spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an
exact match.
String onReason
Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512
characters long, and can contain letters, numbers, periods (.), colons (:), and white space (including spaces and
tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact
match.
String onExitCode
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a
job. The pattern can be up to 512 characters long, can contain only numbers, and can optionally end with an
asterisk (*) so that only the start of the string needs to be an exact match.
String action
Specifies the action to take if all of the specified conditions (onStatusReason,
onReason, and onExitCode) are met. The values aren't case sensitive.
String platformVersion
The AWS Fargate platform version where the jobs are running. A platform version is specified only for jobs
running on Fargate resources. If one isn't specified, the LATEST platform version is used by
default. This uses a recent, approved version of the AWS Fargate platform for compute resources. For more
information, see AWS
Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
String sourcePath
The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't 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.
This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.
String jobDefinitionName
The name of the job definition.
String jobDefinitionArn
The Amazon Resource Name (ARN) for the job definition.
Integer revision
The revision of the job definition.
String status
The status of the job definition.
String type
The type of job definition. If the job is run on Fargate resources, then multinode isn't supported.
For more information about multi-node parallel jobs, see Creating a multi-node parallel
job definition in the AWS Batch User Guide.
Map<K,V> parameters
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.
RetryStrategy retryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition.
ContainerProperties containerProperties
An object with various properties specific to container-based jobs.
JobTimeout timeout
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 haven't finished.
NodeProperties nodeProperties
An object with various properties specific to multi-node parallel jobs.
If the job runs on Fargate resources, then you must not specify nodeProperties; use
containerProperties instead.
Map<K,V> tags
The tags applied to the job definition.
Boolean propagateTags
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation.
For tags with the same name, job tags are given priority over job definitions tags. If the total number of
combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
List<E> platformCapabilities
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. Jobs run on Fargate resources specify FARGATE.
String jobArn
The Amazon Resource Name (ARN) of the job.
String jobName
The name of the job.
String jobId
The ID for the job.
String jobQueue
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
String status
The current status for the job.
If your jobs don't progress to STARTING, see Jobs Stuck
in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
List<E> attempts
A list of job attempts associated with this job.
String statusReason
A short, human-readable string to provide additional details about the current status of the job.
Long createdAt
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 retryStrategy
The retry strategy to use for this job if an attempt fails.
Long startedAt
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 isn't provided for child jobs of
array jobs or multi-node parallel jobs.
Long stoppedAt
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).
List<E> dependsOn
A list of job IDs that this job depends on.
String jobDefinition
The job definition that's used by this job.
Map<K,V> parameters
Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
ContainerDetail container
An object representing the details of the container that's associated with the job.
NodeDetails nodeDetails
An object representing the details of a node that's associated with a multi-node parallel job.
NodeProperties nodeProperties
An object representing the node properties of a multi-node parallel job.
This isn't applicable to jobs running on Fargate resources.
ArrayPropertiesDetail arrayProperties
The array properties of the job, if it is an array job.
JobTimeout timeout
The timeout configuration for the job.
Map<K,V> tags
The tags applied to the job.
Boolean propagateTags
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation.
For tags with the same name, job tags are given priority over job definitions tags. If the total number of
combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
List<E> platformCapabilities
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. Jobs run on Fargate resources specify FARGATE.
String jobQueueName
The name of the job queue.
String jobQueueArn
The Amazon Resource Name (ARN) of the job queue.
String state
Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it's able
to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs
already in the queue can finish.
String status
The status of the job queue (for example, CREATING or VALID).
String statusReason
A short, human-readable string to provide additional details about the current status of the job queue.
Integer priority
The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
priority parameter) are evaluated first when associated with the same compute environment. Priority
is determined in descending order, for example, a job queue with a priority value of 10 is given
scheduling preference over a job queue with a priority value of 1. All of the compute environments
must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or
FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
List<E> computeEnvironmentOrder
The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
Map<K,V> tags
The tags applied to the job queue. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.
String jobArn
The Amazon Resource Name (ARN) of the job.
String jobId
The ID of the job.
String jobName
The name of the job.
Long createdAt
The Unix timestamp 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.
String status
The current status for the job.
String statusReason
A short, human-readable string to provide additional details about the current status of the job.
Long startedAt
The Unix timestamp for when the job was started (when the job transitioned from the STARTING state
to the RUNNING state).
Long stoppedAt
The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state to
a terminal state, such as SUCCEEDED or FAILED).
ContainerSummary container
An object representing the details of the container that's associated with the job.
ArrayPropertiesSummary arrayProperties
The array properties of the job, if it is an array job.
NodePropertiesSummary nodeProperties
The node properties for a single node in a job summary list.
This isn't applicable to jobs running on Fargate resources.
Integer attemptDurationSeconds
The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS
Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.
String launchTemplateId
The ID of the launch template.
String launchTemplateName
The name of the launch template.
String version
The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is
$Default, the default version of the launch template is used.
After the compute environment is created, the launch template version used will not be changed, even if the
$Default or $Latest version for the launch template is updated. To use a new launch
template version, create a new compute environment, add the new compute environment to the existing job queue,
remove the old compute environment from the job queue, and delete the old compute environment.
Default: $Default.
List<E> devices
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.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
Boolean initProcessEnabled
If true, run an init process inside the container that forwards signals and reaps processes. This
parameter maps to the --init option to docker run. This parameter requires version 1.25 of the
Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container
instance, log into your container instance and run the following command:
sudo docker version | grep "Server API version"
Integer sharedMemorySize
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the
--shm-size option to docker run.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
List<E> tmpfs
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs option to docker run.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
Integer maxSwap
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the
--memory-swap option to docker run where
the value is the sum of the container memory plus the maxSwap value. For more information, see
--memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values
are 0 or any positive integer. If the maxSwap parameter is omitted, the container
doesn't 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.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
Integer swappiness
This allows you to tune a container's memory swappiness behavior. A swappiness value of
0 causes swapping not to happen unless absolutely necessary. A swappiness value of
100 causes pages to be swapped very aggressively. Accepted values are whole numbers between
0 and 100. If the swappiness parameter isn't specified, a default value of
60 is used. If a value isn't specified for maxSwap then this parameter is ignored. If
maxSwap is set to 0, the container doesn't use swap. This parameter maps to the
--memory-swappiness option to docker
run.
Consider the following when you use a per-container swap configuration.
Swap space must be enabled and allocated on the container instance for the containers to use.
The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
The swap space parameters are only supported for job definitions using EC2 resources.
If the maxSwap and swappiness parameters are omitted from a job definition, each
container will have a default swappiness value of 60, and the total swap usage will be limited to
two times the memory reservation of the container.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
String jobQueue
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
String arrayJobId
The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
String multiNodeJobId
The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
String jobStatus
The job status used to filter jobs in the specified queue. If you don't specify a status, only
RUNNING jobs are returned.
Integer maxResults
The maximum number of results returned by ListJobs in paginated output. When this parameter is used,
ListJobs only returns maxResults results in a single page and a nextToken
response element. The remaining results of the initial request can be seen by sending another
ListJobs request with the returned nextToken value. This value can be between 1 and
100. If this parameter isn't used, then ListJobs returns up to 100 results and a
nextToken value if applicable.
String nextToken
The nextToken value returned from a previous paginated ListJobs 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.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
List<E> jobSummaryList
A list of job summaries that match the request.
String nextToken
The nextToken value to include in a future ListJobs request. When the results of a
ListJobs 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.
String resourceArn
The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
String logDriver
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.
Jobs running on Fargate resources are restricted to the awslogs and splunk log drivers.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the
Docker Remote API version on your container instance, log into your container instance and run the following
command: sudo docker version | grep "Server API version"
Map<K,V> options
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"
List<E> secretOptions
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
String containerPath
The path on the container where the host volume is mounted.
Boolean readOnly
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.
String sourceVolume
The name of the volume to mount.
String assignPublicIp
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is "DISABLED".
Integer nodeIndex
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.
Boolean isMainNode
Specifies whether the current node is the main node for a multi-node parallel job.
Integer numNodes
The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:
There must be at least one node range in your job definition that has an open upper boundary (such as
: or n:).
The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.
The main node index specified in the job definition must be fewer than the number of nodes specified in the override.
List<E> nodePropertyOverrides
The node property overrides for the job.
Integer numNodes
The number of nodes associated with a multi-node parallel job.
Integer mainNode
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.
List<E> nodeRangeProperties
A list of node ranges and their properties associated with a multi-node parallel job.
Boolean isMainNode
Specifies whether the current node is the main node for a multi-node parallel job.
Integer numNodes
The number of nodes associated with a multi-node parallel job.
Integer nodeIndex
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.
String targetNodes
The range of nodes, using node index values, that's used to override. A range of 0:3 indicates nodes
with index values of 0 through 3. If the starting range value is omitted (
:n), then 0 is used to start the range. If the ending range value is omitted (
n:), then the highest possible node index is used to end the range.
ContainerOverrides containerOverrides
The overrides that should be sent to a node range.
String targetNodes
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 can nest node ranges, for example 0:10 and 4:5, in which case
the 4:5 range properties override the 0:10 properties.
ContainerProperties container
The container details for the node range.
String jobDefinitionName
The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
String type
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.
If the job is run on Fargate resources, then multinode isn't supported.
Map<K,V> parameters
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.
ContainerProperties containerProperties
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.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only
containerProperties.
NodeProperties nodeProperties
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.
If the job runs on Fargate resources, then you must not specify nodeProperties; use
containerProperties instead.
RetryStrategy retryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
Boolean propagateTags
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task
creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number
of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
JobTimeout timeout
The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.
Map<K,V> tags
The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.
List<E> platformCapabilities
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.
String value
The quantity of the specified resource to reserve for the container. The values vary based on the
type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs running on Fargate resources.
The memory hard limit (in MiB) present to the container. This parameter is supported for jobs running on EC2
resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter
maps to Memory in the Create
a container section of the Docker Remote API and the
--memory option to docker run. You must
specify at least 4 MiB of memory for a job. This is required but can be specified in several places for
multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to
Memory in the Create a
container section of the Docker Remote API and the
--memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
For jobs running on Fargate resources, then value is the hard limit (in MiB), and must match one of
the supported values and the VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option
to docker run. Each vCPU is equivalent to 1,024 CPU
shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several
places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the
MEMORY values must be one of the values supported for that VCPU value. The supported values are
0.25, 0.5, 1, 2, and 4
MEMORY = 512, 1024, or 2048
MEMORY = 1024, 2048, 3072, or 4096
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480,
21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
String type
The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
Integer attempts
The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts.
If the value of attempts is greater than one, the job is retried on failure the same number of
attempts as the value.
List<E> evaluateOnExit
Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this
parameter is specified, then the attempts parameter must also be specified.
String name
The name of the secret.
String valueFrom
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.
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
String jobName
The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
String jobQueue
The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
ArrayProperties arrayProperties
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
List<E> dependsOn
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job
completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a
job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of
each dependency to complete before it can begin.
String jobDefinition
The job definition used by this job. This value can be one of name, name:revision, or
the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then
the latest active revision is used.
Map<K,V> parameters
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job
definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob
request override any corresponding parameter defaults from the job definition.
ContainerOverrides containerOverrides
A list of container overrides in the JSON format that specify the name of a container in the specified job
definition and the overrides it should receive. You can override the default command for a container, which is
specified in the job definition or the Docker image, with a command override. You can also override
existing environment variables on a container or add new environment variables to it with an
environment override.
NodeOverrides nodeOverrides
A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides
instead.
RetryStrategy retryStrategy
The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
Boolean propagateTags
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If
no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation.
For tags with the same name, job tags are given priority over job definitions tags. If the total number of
combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When
specified, this overrides the tag propagation setting in the job definition.
JobTimeout timeout
The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
Map<K,V> tags
The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
String resourceArn
The Amazon Resource Name (ARN) of the resource that tags are added to. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
Map<K,V> tags
The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
String jobId
The AWS Batch job ID of the job to terminate.
String reason
A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.
String containerPath
The absolute file path in the container where the tmpfs volume is mounted.
Integer size
The size (in MiB) of the tmpfs volume.
List<E> mountOptions
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 resourceArn
The Amazon Resource Name (ARN) of the resource from which to delete tags. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
List<E> tagKeys
The keys of the tags to be removed.
String computeEnvironment
The name or full Amazon Resource Name (ARN) of the compute environment to update.
String state
The state of the compute environment. Compute environments in the ENABLED state can accept jobs from
a queue and scale in or out automatically based on the workload demand of its associated queues.
If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated
job queue on the compute resources within the environment. If the compute environment is managed, then it can
scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
ComputeResourceUpdate computeResources
Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
String serviceRole
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.
If your specified role has a path other than /, then you must either specify the full role ARN (this
is recommended) or prefix the role name with the path.
Depending on how you created your AWS Batch service role, its ARN might contain the service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the
service-role path prefix. Because of this, we recommend that you specify the full ARN of your
service role when you create compute environments.
String jobQueue
The name or the Amazon Resource Name (ARN) of the job queue.
String state
Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept
jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in
the queue can finish.
Integer priority
The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
priority parameter) are evaluated first when associated with the same compute environment. Priority
is determined in descending order, for example, a job queue with a priority value of 10 is given
scheduling preference over a job queue with a priority value of 1. All of the compute environments
must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or
FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.
List<E> computeEnvironmentOrder
Details the set of compute environments mapped to a job queue and their order relative to each other. This is one
of the parameters used by the job scheduler to determine which compute environment should run a given job.
Compute environments must be in the VALID state before you can associate them with a job queue. All
of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (
FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
Host host
The contents of the host parameter determine whether your data volume persists on the host container
instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for
your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop
running.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
String name
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.
EFSVolumeConfiguration efsVolumeConfiguration
This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs
running on Fargate resources must specify a platformVersion of at least 1.4.0.
Copyright © 2021. All rights reserved.