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 is 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 is 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 seconds and 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 seconds and 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.
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.
String type
The type of the compute environment.
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 does not 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 do not 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.
String serviceRole
The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
String type
The type of compute environment: EC2 or SPOT.
String allocationStrategy
The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance
type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service
limits. If this is not specified, the default is BEST_FIT, which will use only the best fitting
instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower
but can limit scaling. BEST_FIT_PROGRESSIVE will select an additional instance type that is large
enough to meet the requirements of the jobs in the queue, with a preference for an instance type with a lower
cost. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select
an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a
preference for an instance type that is less likely to be interrupted.
Integer minvCpus
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
DISABLED).
Integer maxvCpus
The maximum number of Amazon EC2 vCPUs that an environment can reach.
Integer desiredvCpus
The desired number of Amazon EC2 vCPUS in the compute environment.
List<E> instanceTypes
The instances types that may 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 pick instance types (from
the C, M, and R instance families) on the fly that match the demand of your job queues.
String imageId
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
List<E> subnets
The VPC subnets into which the compute resources are launched. 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. If security groups are specified using both securityGroupIds and
launchTemplate, the values in securityGroupIds will be used.
String ec2KeyPair
The Amazon EC2 key pair that is used for instances launched in the compute environment.
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.
Map<K,V> tags
Key-value pair tags to be applied to 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" }.
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.
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 below 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.
String spotIamFleetRole
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute
environment. For more information, see Amazon EC2 Spot Fleet Role
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.
String image
The image used to start the container.
Integer vcpus
The number of VCPUs allocated for the job.
Integer memory
The number of MiB of memory reserved for the job.
List<E> command
The command that is passed to the container.
String jobRoleArn
The Amazon Resource Name (ARN) associated with the job upon execution.
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.
List<E> ulimits
A list of ulimit values to set in the container.
Boolean privileged
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the root user).
String user
The user name to use inside the container.
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 on which the container is running.
String taskArn
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.
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.
List<E> networkInterfaces
The network interfaces associated with the job.
List<E> resourceRequirements
The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU.
LinuxParameters linuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
Integer vcpus
The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
Integer memory
The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
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 is not valid for single-node container jobs.
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 a resource to assign to a container. This value overrides the value set in the job
definition. Currently, the only supported resource is GPU.
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.
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 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.
Integer memory
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.
If you are 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 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
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
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 do not 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 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.
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.
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. 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.
List<E> resourceRequirements
The type and amount of a resource to assign to a container. Currently, the only supported resource is
GPU.
LinuxParameters linuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
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. 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.
ComputeResource computeResources
Details of 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.
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 may contain the service-role path
prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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 jobQueueName
The name of the job queue.
String state
The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.
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.
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 execute a given 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.
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 is not 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 is 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 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 jobDefinitionName
The name of the job definition to describe.
String status
The status with which 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 is 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 along with
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 is not 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 is 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 at which 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 sourcePath
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.
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.
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 have not finished.
NodeProperties nodeProperties
An object with various properties specific to multi-node parallel jobs.
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 with which the job is associated.
String status
The current status for the job.
If your jobs do not 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 seconds and 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 seconds and milliseconds) for when the job was started (when the job transitioned from the
STARTING state to the RUNNING state).
Long stoppedAt
The Unix timestamp (in seconds and 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 names or IDs on which this job depends.
String jobDefinition
The job definition that is 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 is associated with the job.
NodeDetails nodeDetails
An object representing the details of a node that is associated with a multi-node parallel job.
NodeProperties nodeProperties
An object representing the node properties of a multi-node parallel job.
ArrayPropertiesDetail arrayProperties
The array properties of the job, if it is an array job.
JobTimeout timeout
The timeout configuration for the job.
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.
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.
List<E> computeEnvironmentOrder
The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
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 is 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.
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.
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.
String jobQueue
The name or full Amazon Resource Name (ARN) of the job queue with which 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 with which to filter jobs in the specified queue. If you do not 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 along with 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 is not 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 is 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 containerPath
The path on the container at which to mount the host volume.
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.
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, with which 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 may 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.
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.
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.
RetryStrategy retryStrategy
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.
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 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.
String value
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.
String type
The type of resource to assign to a container. Currently, the only supported resource type is GPU.
Integer attempts
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.
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 into which 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 either a name:revision or the Amazon Resource
Name (ARN) for the job definition.
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 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 (that is specified in
the job definition or the Docker image) with a command override. You can also override existing
environment variables (that are specified in the job definition or Docker image) 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.
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.
JobTimeout timeout
The timeout configuration for this SubmitJob operation. You can specify a timeout duration 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. 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.
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 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.
ComputeResourceUpdate computeResources
Details of the compute resources managed by the compute environment. Required for a managed compute environment.
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.
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 may contain the service-role path
prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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.
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.
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 execute a given job.
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 is not guaranteed to persist after the containers associated with it stop
running.
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.
Copyright © 2019. All rights reserved.