String jobId
A list of up to 100 job IDs to cancel.
String reason
A message to attach to the job that explains the reason for cancelling 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. An
ENABLED state indicates that you can register instances with the compute environment and that the
associated instances can accept jobs.
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.
Integer minvCpus
The minimum number of EC2 vCPUs that an environment should maintain.
Integer maxvCpus
The maximum number of EC2 vCPUs that an environment can reach.
Integer desiredvCpus
The desired number of EC2 vCPUS in the compute environment.
List<E> instanceTypes
The instances types that may launched.
List<E> subnets
The VPC subnets into which the compute resources are launched.
List<E> securityGroupIds
The EC2 security group that is associated with instances launched in the compute environment.
String ec2KeyPair
The EC2 key pair that is used for instances launched in the compute environment.
String instanceRole
The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
Map<K,V> tags
Key-value pair tags to be applied to resources that are launched in the compute environment.
Integer bidPercentage
The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.
String spotIamFleetRole
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute
environment.
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.
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.
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.
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.
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.
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.
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 plain text environment variables for sensitive information, such as credential data.
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 computeEnvironmentName
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.
String type
The type of the compute environment.
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.
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.
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 lower integer value for the
priority parameter) are evaluated first when associated with same compute environment. Priority is
determined in ascending order, for example, a job queue with a priority value of 1 is given
scheduling preference over a job queue with a priority value of 10.
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 3
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 space-separated 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 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 the host parameter contains a
sourcePath file location, then the data volume persists at the specified location on the host
container instance until you delete it manually. If the sourcePath value 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.
ContainerProperties containerProperties
An object with various properties specific to container-based jobs.
String jobId
The job ID of the AWS Batch job associated with this dependency.
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.
String statusReason
A short, human-readable string to provide additional details about the current status of the job.
Long createdAt
The Unix timestamp for when the job was created (when the task entered the PENDING state).
Long startedAt
The Unix timestamp for when the job was started (when the task transitioned from the PENDING state
to the RUNNING state).
Long stoppedAt
The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state
to the STOPPED state).
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.
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 jobQueue
The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
String jobStatus
The job status with which to filter jobs in the specified queue.
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.
String jobDefinitionName
The name of the job definition to register.
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 for container-based jobs. This parameter is required if the
type parameter is container.
String jobName
The name of the job.
String jobQueue
The job queue into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
List<E> dependsOn
A list of job names or IDs on which this job depends. A job can depend upon a maximum of 100 jobs.
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.
String jobId
Job IDs to be terminated. Up to 100 jobs can be specified.
String reason
A message to attach to the job that explains the reason for cancelling 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 name or full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to ECS, Auto Scaling, and EC2 on your behalf.
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 lower integer value for the
priority parameter) are evaluated first when associated with same compute environment. Priority is
determined in ascending order, for example, a job queue with a priority value of 1 is given
scheduling preference over a job queue with a priority value of 10.
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, but 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 © 2017. All rights reserved.