ContainerDetail - Amazon Batch
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ContainerDetail

An object that represents the details of a container that's part of a job.

Contents

command

The command that's passed to the container.

Type: Array of strings

Required: No

containerInstanceArn

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

Type: String

Required: No

enableExecuteCommand

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

Type: Boolean

Required: No

environment

The environment variables to pass to a container.

Note

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Amazon Batch sets.

Type: Array of KeyValuePair objects

Required: No

ephemeralStorage

The amount of ephemeral storage allocated for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Amazon Fargate.

Type: EphemeralStorage object

Required: No

executionRoleArn

The Amazon Resource Name (ARN) of the execution role that Amazon Batch can assume. For more information, see Batch execution IAM role in the Amazon Batch User Guide.

Type: String

Required: No

exitCode

The exit code returned upon completion.

Type: Integer

Required: No

fargatePlatformConfiguration

The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Type: FargatePlatformConfiguration object

Required: No

image

The image used to start the container.

Type: String

Required: No

instanceType

The instance type of the underlying host infrastructure of a multi-node parallel job.

Note

This parameter isn't applicable to jobs that are running on Fargate resources.

Type: String

Required: No

jobRoleArn

The Amazon Resource Name (ARN) that's associated with the job when run.

Type: String

Required: No

linuxParameters

Linux-specific modifications that are applied to the container, such as details for device mappings.

Type: LinuxParameters object

Required: No

logConfiguration

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Note

Amazon Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

Note

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

Type: LogConfiguration object

Required: No

logStreamName

The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Amazon 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

For jobs running on Amazon EC2 resources that didn't specify memory requirements using resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.

Type: Integer

Required: No

mountPoints

The mount points for data volumes in your container.

Type: Array of MountPoint objects

Required: No

networkConfiguration

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Type: NetworkConfiguration object

Required: No

networkInterfaces

The network interfaces that are associated with the job.

Type: Array of NetworkInterface objects

Required: No

privileged

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.

Note

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

Type: Boolean

Required: No

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.

Type: Boolean

Required: No

reason

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

Type: String

Required: No

repositoryCredentials

The private repository authentication credentials to use.

Type: RepositoryCredentials object

Required: No

resourceRequirements

The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

Type: Array of ResourceRequirement objects

Required: No

runtimePlatform

An object that represents the compute environment architecture for Amazon Batch jobs on Fargate.

Type: RuntimePlatform object

Required: No

secrets

The secrets to pass to the container. For more information, see Specifying sensitive data in the Amazon Batch User Guide.

Type: Array of Secret objects

Required: No

taskArn

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

Type: String

Required: No

ulimits

A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

Note

This parameter isn't applicable to jobs that are running on Fargate resources.

Type: Array of Ulimit objects

Required: No

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.

Type: String

Required: No

vcpus

The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirements object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.

Note

This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.

Type: Integer

Required: No

volumes

A list of volumes that are 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 Amazon SDKs, see the following: