2017/03/28 - AWS Batch - 4 updated api methods
Changes Update batch client to latest version
{'jobDefinitions': {'retryStrategy': {'attempts': 'integer'}}}
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.
See also: AWS API Documentation
Request Syntax
client.describe_job_definitions(
jobDefinitions=[
'string',
],
maxResults=123,
jobDefinitionName='string',
status='string',
nextToken='string'
)
list
A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
(string) --
integer
The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.
string
The name of the job definition to describe.
string
The status with which to filter job definitions.
string
The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
dict
Response Syntax
{
'jobDefinitions': [
{
'jobDefinitionName': 'string',
'jobDefinitionArn': 'string',
'revision': 123,
'status': 'string',
'type': 'string',
'parameters': {
'string': 'string'
},
'retryStrategy': {
'attempts': 123
},
'containerProperties': {
'image': 'string',
'vcpus': 123,
'memory': 123,
'command': [
'string',
],
'jobRoleArn': 'string',
'volumes': [
{
'host': {
'sourcePath': 'string'
},
'name': 'string'
},
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'mountPoints': [
{
'containerPath': 'string',
'readOnly': True|False,
'sourceVolume': 'string'
},
],
'readonlyRootFilesystem': True|False,
'privileged': True|False,
'ulimits': [
{
'hardLimit': 123,
'name': 'string',
'softLimit': 123
},
],
'user': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobDefinitions (list) --
The list of job definitions.
(dict) --
An object representing an AWS Batch job definition.
jobDefinitionName (string) --
The name of the job definition.
jobDefinitionArn (string) --
The Amazon Resource Name (ARN) for the job definition.
revision (integer) --
The revision of the job definition.
status (string) --
The status of the job definition.
type (string) --
The type of job definition.
parameters (dict) --
Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
(string) --
(string) --
retryStrategy (dict) --
The retry strategy to use for failed jobs that are submitted with this job definition.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.
containerProperties (dict) --
An object with various properties specific to container-based jobs.
image (string) --
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
vcpus (integer) --
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.
memory (integer) --
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
(dict) --
A key-value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties.
containerPath (string) --
The path on the container at which to mount the host volume.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
softLimit (integer) --
The soft limit for the ulimit type.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
nextToken (string) --
The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
{'jobs': {'attempts': [{'container': {'containerInstanceArn': 'string',
'exitCode': 'integer',
'reason': 'string',
'taskArn': 'string'},
'startedAt': 'long',
'statusReason': 'string',
'stoppedAt': 'long'}],
'container': {'taskArn': 'string'},
'retryStrategy': {'attempts': 'integer'}}}
Describes a list of AWS Batch jobs.
See also: AWS API Documentation
Request Syntax
client.describe_jobs(
jobs=[
'string',
]
)
list
[REQUIRED]
A space-separated list of up to 100 job IDs.
(string) --
dict
Response Syntax
{
'jobs': [
{
'jobName': 'string',
'jobId': 'string',
'jobQueue': 'string',
'status': 'SUBMITTED'|'PENDING'|'RUNNABLE'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
'attempts': [
{
'container': {
'containerInstanceArn': 'string',
'taskArn': 'string',
'exitCode': 123,
'reason': 'string'
},
'startedAt': 123,
'stoppedAt': 123,
'statusReason': 'string'
},
],
'statusReason': 'string',
'createdAt': 123,
'retryStrategy': {
'attempts': 123
},
'startedAt': 123,
'stoppedAt': 123,
'dependsOn': [
{
'jobId': 'string'
},
],
'jobDefinition': 'string',
'parameters': {
'string': 'string'
},
'container': {
'image': 'string',
'vcpus': 123,
'memory': 123,
'command': [
'string',
],
'jobRoleArn': 'string',
'volumes': [
{
'host': {
'sourcePath': 'string'
},
'name': 'string'
},
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'mountPoints': [
{
'containerPath': 'string',
'readOnly': True|False,
'sourceVolume': 'string'
},
],
'readonlyRootFilesystem': True|False,
'ulimits': [
{
'hardLimit': 123,
'name': 'string',
'softLimit': 123
},
],
'privileged': True|False,
'user': 'string',
'exitCode': 123,
'reason': 'string',
'containerInstanceArn': 'string',
'taskArn': 'string'
}
},
]
}
Response Structure
(dict) --
jobs (list) --
The list of jobs.
(dict) --
An object representing an AWS Batch job.
jobName (string) --
The name of the job.
jobId (string) --
The ID for the job.
jobQueue (string) --
The Amazon Resource Name (ARN) of the job queue with which the job is associated.
status (string) --
The current status for the job.
attempts (list) --
A list of job attempts associated with this job.
(dict) --
An object representing a job attempt.
container (dict) --
Details about the container in this job attempt.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
taskArn (string) --
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt.
exitCode (integer) --
The exit code for the job attempt. A non-zero exit code is considered a failure.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
startedAt (integer) --
The Unix timestamp for when the attempt was started (when the task transitioned from the PENDING state to the RUNNING state).
stoppedAt (integer) --
The Unix timestamp for when the attempt was stopped (when the task transitioned from the RUNNING state to the STOPPED state).
statusReason (string) --
A short, human-readable string to provide additional details about the current status of the job attempt.
statusReason (string) --
A short, human-readable string to provide additional details about the current status of the job.
createdAt (integer) --
The Unix timestamp for when the job was created (when the task entered the PENDING state).
retryStrategy (dict) --
The retry strategy to use for this job if an attempt fails.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.
startedAt (integer) --
The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).
stoppedAt (integer) --
The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).
dependsOn (list) --
A list of job names or IDs on which this job depends.
(dict) --
An object representing an AWS Batch job dependency.
jobId (string) --
The job ID of the AWS Batch job associated with this dependency.
jobDefinition (string) --
The job definition that is used by this job.
parameters (dict) --
Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
(string) --
(string) --
container (dict) --
An object representing the details of the container that is associated with the job.
image (string) --
The image used to start the container.
vcpus (integer) --
The number of VCPUs allocated for the job.
memory (integer) --
The number of MiB of memory reserved for the job.
command (list) --
The command that is passed to the container.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) associated with the job upon execution.
volumes (list) --
A list of volumes associated with the job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container.
(dict) --
A key-value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties.
containerPath (string) --
The path on the container at which to mount the host volume.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system.
ulimits (list) --
A list of ulimit values to set in the container.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
softLimit (integer) --
The soft limit for the ulimit type.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
user (string) --
The user name to use inside the container.
exitCode (integer) --
The exit code to return upon completion.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance on which the container is running.
taskArn (string) --
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.
{'retryStrategy': {'attempts': 'integer'}}
Registers an AWS Batch job definition.
See also: AWS API Documentation
Request Syntax
client.register_job_definition(
jobDefinitionName='string',
type='container',
parameters={
'string': 'string'
},
containerProperties={
'image': 'string',
'vcpus': 123,
'memory': 123,
'command': [
'string',
],
'jobRoleArn': 'string',
'volumes': [
{
'host': {
'sourcePath': 'string'
},
'name': 'string'
},
],
'environment': [
{
'name': 'string',
'value': 'string'
},
],
'mountPoints': [
{
'containerPath': 'string',
'readOnly': True|False,
'sourceVolume': 'string'
},
],
'readonlyRootFilesystem': True|False,
'privileged': True|False,
'ulimits': [
{
'hardLimit': 123,
'name': 'string',
'softLimit': 123
},
],
'user': 'string'
},
retryStrategy={
'attempts': 123
}
)
string
[REQUIRED]
The name of the job definition to register.
string
[REQUIRED]
The type of job definition.
dict
Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
(string) --
(string) --
dict
An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container.
image (string) -- [REQUIRED]
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
vcpus (integer) -- [REQUIRED]
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.
memory (integer) -- [REQUIRED]
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.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
(dict) --
A key-value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties.
containerPath (string) --
The path on the container at which to mount the host volume.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) -- [REQUIRED]
The hard limit for the ulimit type.
name (string) -- [REQUIRED]
The type of the ulimit.
softLimit (integer) -- [REQUIRED]
The soft limit for the ulimit type.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
dict
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.
dict
Response Syntax
{
'jobDefinitionName': 'string',
'jobDefinitionArn': 'string',
'revision': 123
}
Response Structure
(dict) --
jobDefinitionName (string) --
The name of the job definition.
jobDefinitionArn (string) --
The Amazon Resource Name (ARN) of the job definition.
revision (integer) --
The revision of the job definition.
{'retryStrategy': {'attempts': 'integer'}}
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
See also: AWS API Documentation
Request Syntax
client.submit_job(
jobName='string',
jobQueue='string',
dependsOn=[
{
'jobId': 'string'
},
],
jobDefinition='string',
parameters={
'string': 'string'
},
containerOverrides={
'vcpus': 123,
'memory': 123,
'command': [
'string',
],
'environment': [
{
'name': 'string',
'value': 'string'
},
]
},
retryStrategy={
'attempts': 123
}
)
string
[REQUIRED]
The name of the job. A name must be 1 to 128 characters in length.
Pattern: ^[a-zA-Z0-9_]+$
string
[REQUIRED]
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
A list of job IDs on which this job depends. A job can depend upon a maximum of 100 jobs.
(dict) --
An object representing an AWS Batch job dependency.
jobId (string) --
The job ID of the AWS Batch job associated with this dependency.
string
[REQUIRED]
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.
dict
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.
(string) --
(string) --
dict
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.
vcpus (integer) --
The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
memory (integer) --
The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the job definition.
(string) --
environment (list) --
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.
(dict) --
A key-value pair object.
name (string) --
The name of the key value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key value pair. For environment variables, this is the value of the environment variable.
dict
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.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.
dict
Response Syntax
{
'jobName': 'string',
'jobId': 'string'
}
Response Structure
(dict) --
jobName (string) --
The name of the job.
jobId (string) --
The unique identifier for the job.