Menu
AWS Batch
API Reference (API Version 2016-08-10)

ContainerDetail

An object representing the details of a container that is part of a job.

Contents

command

The command that is passed to the container.

Type: Array of strings

Required: No

containerInstanceArn

The Amazon Resource Name (ARN) of the container instance on which the container is running.

Type: String

Required: No

environment

The environment variables to pass to a container.

Note

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Type: Array of KeyValuePair objects

Required: No

exitCode

The exit code to return upon completion.

Type: Integer

Required: No

image

The image used to start the container.

Type: String

Required: No

jobRoleArn

The Amazon Resource Name (ARN) associated with the job upon execution.

Type: String

Required: No

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.

Type: String

Required: No

memory

The number of MiB of memory reserved for the job.

Type: Integer

Required: No

mountPoints

The mount points for data volumes in your container.

Type: Array of MountPoint objects

Required: No

privileged

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

Type: Boolean

Required: No

readonlyRootFilesystem

When this parameter is true, the container is given read-only access to its root file system.

Type: Boolean

Required: No

reason

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

Type: String

Required: No

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.

Type: String

Required: No

ulimits

A list of ulimit values to set in the container.

Type: Array of Ulimit objects

Required: No

user

The user name to use inside the container.

Type: String

Required: No

vcpus

The number of VCPUs allocated for the job.

Type: Integer

Required: No

volumes

A list of volumes associated with the job.

Type: Array of Volume objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: