/AWS1/CL_BTCCONTAINERDETAIL¶
An object that represents the details of a container that's part of a job.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_image TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The image used to start the container.
iv_vcpus TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER¶
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 thevcpusandresourceRequirementsobject. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.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.
iv_memory TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER¶
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, seeresourceRequirements.
it_command TYPE /AWS1/CL_BTCSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST¶
The command that's passed to the container.
iv_jobrolearn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The Amazon Resource Name (ARN) that's associated with the job when run.
iv_executionrolearn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
it_volumes TYPE /AWS1/CL_BTCVOLUME=>TT_VOLUMES TT_VOLUMES¶
A list of volumes that are associated with the job.
it_environment TYPE /AWS1/CL_BTCKEYVALUEPAIR=>TT_ENVIRONMENTVARIABLES TT_ENVIRONMENTVARIABLES¶
The environment variables to pass to a container.
Environment variables cannot start with "
AWS_BATCH". This naming convention is reserved for variables that Batch sets.
it_mountpoints TYPE /AWS1/CL_BTCMOUNTPOINT=>TT_MOUNTPOINTS TT_MOUNTPOINTS¶
The mount points for data volumes in your container.
iv_readonlyrootfilesystem TYPE /AWS1/BTCBOOLEAN /AWS1/BTCBOOLEAN¶
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.
it_ulimits TYPE /AWS1/CL_BTCULIMIT=>TT_ULIMITS TT_ULIMITS¶
A list of
ulimitvalues to set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run.This parameter isn't applicable to jobs that are running on Fargate resources.
iv_privileged TYPE /AWS1/BTCBOOLEAN /AWS1/BTCBOOLEAN¶
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the
rootuser). The default value isfalse.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as
false.
iv_user TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The user name to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run.
iv_exitcode TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER¶
The exit code returned upon completion.
iv_reason TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
iv_containerinstancearn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The Amazon Resource Name (ARN) of the container instance that the container is running on.
iv_taskarn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
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
STARTINGstatus.
iv_logstreamname TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
/aws/batch/job. Each container attempt receives a log stream name when they reach theRUNNINGstatus.
iv_instancetype TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
it_networkinterfaces TYPE /AWS1/CL_BTCNETWORKINTERFACE=>TT_NETWORKINTERFACELIST TT_NETWORKINTERFACELIST¶
The network interfaces that are associated with the job.
it_resourcerequirements TYPE /AWS1/CL_BTCRESRCREQUIREMENT=>TT_RESOURCEREQUIREMENTS TT_RESOURCEREQUIREMENTS¶
The type and amount of resources to assign to a container. The supported resources include
GPU,MEMORY, andVCPU.
io_linuxparameters TYPE REF TO /AWS1/CL_BTCLINUXPARAMETERS /AWS1/CL_BTCLINUXPARAMETERS¶
Linux-specific modifications that are applied to the container, such as details for device mappings.
io_logconfiguration TYPE REF TO /AWS1/CL_BTCLOGCONFIGURATION /AWS1/CL_BTCLOGCONFIGURATION¶
The log configuration specification for the container.
This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption 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.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"The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERSenvironment 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.
it_secrets TYPE /AWS1/CL_BTCSECRET=>TT_SECRETLIST TT_SECRETLIST¶
The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
io_networkconfiguration TYPE REF TO /AWS1/CL_BTCNETWORKCONF /AWS1/CL_BTCNETWORKCONF¶
The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
io_fargateplatformconf TYPE REF TO /AWS1/CL_BTCFARGATEPLATFORMC00 /AWS1/CL_BTCFARGATEPLATFORMC00¶
The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
io_ephemeralstorage TYPE REF TO /AWS1/CL_BTCEPHEMERALSTORAGE /AWS1/CL_BTCEPHEMERALSTORAGE¶
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 Fargate.
io_runtimeplatform TYPE REF TO /AWS1/CL_BTCRUNTIMEPLATFORM /AWS1/CL_BTCRUNTIMEPLATFORM¶
An object that represents the compute environment architecture for Batch jobs on Fargate.
io_repositorycredentials TYPE REF TO /AWS1/CL_BTCREPOSITORYCREDS /AWS1/CL_BTCREPOSITORYCREDS¶
The private repository authentication credentials to use.
iv_enableexecutecommand TYPE /AWS1/BTCBOOLEAN /AWS1/BTCBOOLEAN¶
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.
Queryable Attributes¶
image¶
The image used to start the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGE() |
Getter for IMAGE, with configurable default |
ASK_IMAGE() |
Getter for IMAGE w/ exceptions if field has no value |
HAS_IMAGE() |
Determine if IMAGE has a value |
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 thevcpusandresourceRequirementsobject. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VCPUS() |
Getter for VCPUS, with configurable default |
ASK_VCPUS() |
Getter for VCPUS w/ exceptions if field has no value |
HAS_VCPUS() |
Determine if VCPUS has a value |
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, seeresourceRequirements.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MEMORY() |
Getter for MEMORY, with configurable default |
ASK_MEMORY() |
Getter for MEMORY w/ exceptions if field has no value |
HAS_MEMORY() |
Determine if MEMORY has a value |
command¶
The command that's passed to the container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMMAND() |
Getter for COMMAND, with configurable default |
ASK_COMMAND() |
Getter for COMMAND w/ exceptions if field has no value |
HAS_COMMAND() |
Determine if COMMAND has a value |
jobRoleArn¶
The Amazon Resource Name (ARN) that's associated with the job when run.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBROLEARN() |
Getter for JOBROLEARN, with configurable default |
ASK_JOBROLEARN() |
Getter for JOBROLEARN w/ exceptions if field has no value |
HAS_JOBROLEARN() |
Determine if JOBROLEARN has a value |
executionRoleArn¶
The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONROLEARN() |
Getter for EXECUTIONROLEARN, with configurable default |
ASK_EXECUTIONROLEARN() |
Getter for EXECUTIONROLEARN w/ exceptions if field has no va |
HAS_EXECUTIONROLEARN() |
Determine if EXECUTIONROLEARN has a value |
volumes¶
A list of volumes that are associated with the job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VOLUMES() |
Getter for VOLUMES, with configurable default |
ASK_VOLUMES() |
Getter for VOLUMES w/ exceptions if field has no value |
HAS_VOLUMES() |
Determine if VOLUMES has a value |
environment¶
The environment variables to pass to a container.
Environment variables cannot start with "
AWS_BATCH". This naming convention is reserved for variables that Batch sets.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENT() |
Getter for ENVIRONMENT, with configurable default |
ASK_ENVIRONMENT() |
Getter for ENVIRONMENT w/ exceptions if field has no value |
HAS_ENVIRONMENT() |
Determine if ENVIRONMENT has a value |
mountPoints¶
The mount points for data volumes in your container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MOUNTPOINTS() |
Getter for MOUNTPOINTS, with configurable default |
ASK_MOUNTPOINTS() |
Getter for MOUNTPOINTS w/ exceptions if field has no value |
HAS_MOUNTPOINTS() |
Determine if MOUNTPOINTS has a value |
readonlyRootFilesystem¶
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_READONLYROOTFILESYSTEM() |
Getter for READONLYROOTFILESYSTEM, with configurable default |
ASK_READONLYROOTFILESYSTEM() |
Getter for READONLYROOTFILESYSTEM w/ exceptions if field has |
HAS_READONLYROOTFILESYSTEM() |
Determine if READONLYROOTFILESYSTEM has a value |
ulimits¶
A list of
ulimitvalues to set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run.This parameter isn't applicable to jobs that are running on Fargate resources.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ULIMITS() |
Getter for ULIMITS, with configurable default |
ASK_ULIMITS() |
Getter for ULIMITS w/ exceptions if field has no value |
HAS_ULIMITS() |
Determine if ULIMITS has a value |
privileged¶
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the
rootuser). The default value isfalse.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as
false.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIVILEGED() |
Getter for PRIVILEGED, with configurable default |
ASK_PRIVILEGED() |
Getter for PRIVILEGED w/ exceptions if field has no value |
HAS_PRIVILEGED() |
Determine if PRIVILEGED has a value |
user¶
The user name to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USER() |
Getter for USER, with configurable default |
ASK_USER() |
Getter for USER w/ exceptions if field has no value |
HAS_USER() |
Determine if USER has a value |
exitCode¶
The exit code returned upon completion.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXITCODE() |
Getter for EXITCODE, with configurable default |
ASK_EXITCODE() |
Getter for EXITCODE w/ exceptions if field has no value |
HAS_EXITCODE() |
Determine if EXITCODE has a value |
reason¶
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REASON() |
Getter for REASON, with configurable default |
ASK_REASON() |
Getter for REASON w/ exceptions if field has no value |
HAS_REASON() |
Determine if REASON has a value |
containerInstanceArn¶
The Amazon Resource Name (ARN) of the container instance that the container is running on.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTAINERINSTANCEARN() |
Getter for CONTAINERINSTANCEARN, with configurable default |
ASK_CONTAINERINSTANCEARN() |
Getter for CONTAINERINSTANCEARN w/ exceptions if field has n |
HAS_CONTAINERINSTANCEARN() |
Determine if CONTAINERINSTANCEARN has a value |
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
STARTINGstatus.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKARN() |
Getter for TASKARN, with configurable default |
ASK_TASKARN() |
Getter for TASKARN w/ exceptions if field has no value |
HAS_TASKARN() |
Determine if TASKARN has a value |
logStreamName¶
The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
/aws/batch/job. Each container attempt receives a log stream name when they reach theRUNNINGstatus.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGSTREAMNAME() |
Getter for LOGSTREAMNAME, with configurable default |
ASK_LOGSTREAMNAME() |
Getter for LOGSTREAMNAME w/ exceptions if field has no value |
HAS_LOGSTREAMNAME() |
Determine if LOGSTREAMNAME has a value |
instanceType¶
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCETYPE() |
Getter for INSTANCETYPE, with configurable default |
ASK_INSTANCETYPE() |
Getter for INSTANCETYPE w/ exceptions if field has no value |
HAS_INSTANCETYPE() |
Determine if INSTANCETYPE has a value |
networkInterfaces¶
The network interfaces that are associated with the job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKINTERFACES() |
Getter for NETWORKINTERFACES, with configurable default |
ASK_NETWORKINTERFACES() |
Getter for NETWORKINTERFACES w/ exceptions if field has no v |
HAS_NETWORKINTERFACES() |
Determine if NETWORKINTERFACES has a value |
resourceRequirements¶
The type and amount of resources to assign to a container. The supported resources include
GPU,MEMORY, andVCPU.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEREQUIREMENTS() |
Getter for RESOURCEREQUIREMENTS, with configurable default |
ASK_RESOURCEREQUIREMENTS() |
Getter for RESOURCEREQUIREMENTS w/ exceptions if field has n |
HAS_RESOURCEREQUIREMENTS() |
Determine if RESOURCEREQUIREMENTS has a value |
linuxParameters¶
Linux-specific modifications that are applied to the container, such as details for device mappings.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LINUXPARAMETERS() |
Getter for LINUXPARAMETERS |
logConfiguration¶
The log configuration specification for the container.
This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption 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.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"The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERSenvironment 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGCONFIGURATION() |
Getter for LOGCONFIGURATION |
secrets¶
The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRETS() |
Getter for SECRETS, with configurable default |
ASK_SECRETS() |
Getter for SECRETS w/ exceptions if field has no value |
HAS_SECRETS() |
Determine if SECRETS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKCONFIGURATION() |
Getter for NETWORKCONFIGURATION |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FARGATEPLATFORMCONF() |
Getter for FARGATEPLATFORMCONFIGURATION |
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 Fargate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EPHEMERALSTORAGE() |
Getter for EPHEMERALSTORAGE |
runtimePlatform¶
An object that represents the compute environment architecture for Batch jobs on Fargate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RUNTIMEPLATFORM() |
Getter for RUNTIMEPLATFORM |
repositoryCredentials¶
The private repository authentication credentials to use.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REPOSITORYCREDENTIALS() |
Getter for REPOSITORYCREDENTIALS |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLEEXECUTECOMMAND() |
Getter for ENABLEEXECUTECOMMAND, with configurable default |
ASK_ENABLEEXECUTECOMMAND() |
Getter for ENABLEEXECUTECOMMAND w/ exceptions if field has n |
HAS_ENABLEEXECUTECOMMAND() |
Determine if ENABLEEXECUTECOMMAND has a value |