Skip to content
AWS for Query.Farm

aws.batch.describe_jobs

Example SQL Queries

SELECT * FROM
aws.batch.describe_jobs
WHERE
"jobs" = 'VALUE';

Description

Describes a list of Batch jobs.

Table Definition

Column NameColumn Data Type
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
_input_jobs Input Column
VARCHAR[]
Show child fields
_input_jobs[]
jobs

The list of jobs.

STRUCT(
    "job_arn" VARCHAR,
    "job_name" VARCHAR,
    "job_id" VARCHAR,
    "job_queue" VARCHAR,
    "status" VARCHAR,
    "share_identifier" VARCHAR,
    "scheduling_priority" BIGINT,
    "attempts" STRUCT(
        "container" STRUCT(
            "container_instance_arn" VARCHAR,
            "task_arn" VARCHAR,
            "exit_code" BIGINT,
            "reason" VARCHAR,
            "log_stream_name" VARCHAR,
            "network_interfaces" STRUCT(
                "attachment_id" VARCHAR,
                "ipv6_address" VARCHAR,
                "private_ipv4_address" VARCHAR
            )[]
        ),
        "started_at" BIGINT,
        "stopped_at" BIGINT,
        "status_reason" VARCHAR,
        "task_properties" STRUCT(
            "container_instance_arn" VARCHAR,
            "task_arn" VARCHAR,
            "containers" STRUCT(
                "exit_code" BIGINT,
                "name" VARCHAR,
                "reason" VARCHAR,
                "log_stream_name" VARCHAR,
                "network_interfaces" STRUCT(
                    "attachment_id" VARCHAR,
                    "ipv6_address" VARCHAR,
                    "private_ipv4_address" VARCHAR
                )[]
            )[]
        )[]
    )[],
    "status_reason" VARCHAR,
    "created_at" BIGINT,
    "retry_strategy" STRUCT(
        "attempts" BIGINT,
        "evaluate_on_exit" STRUCT(
            "on_status_reason" VARCHAR,
            "on_reason" VARCHAR,
            "on_exit_code" VARCHAR,
            "action" VARCHAR
        )[]
    ),
    "started_at" BIGINT,
    "stopped_at" BIGINT,
    "depends_on" STRUCT(
        "job_id" VARCHAR,
        "type" VARCHAR
    )[],
    "job_definition" VARCHAR,
    "parameters" MAP(VARCHAR, VARCHAR),
    "container" STRUCT(
        "image" VARCHAR,
        "vcpus" BIGINT,
        "memory" BIGINT,
        "command" VARCHAR[],
        "job_role_arn" VARCHAR,
        "execution_role_arn" VARCHAR,
        "volumes" STRUCT(
            "host" STRUCT(
                "source_path" VARCHAR
            ),
            "name" VARCHAR,
            "efs_volume_configuration" STRUCT(
                "file_system_id" VARCHAR,
                "root_directory" VARCHAR,
                "transit_encryption" VARCHAR,
                "transit_encryption_port" BIGINT,
                "authorization_config" STRUCT(
                    "access_point_id" VARCHAR,
                    "iam" VARCHAR
                )
            )
        )[],
        "environment" STRUCT(
            "name" VARCHAR,
            "value" VARCHAR
        )[],
        "mount_points" STRUCT(
            "container_path" VARCHAR,
            "read_only" BOOLEAN,
            "source_volume" VARCHAR
        )[],
        "readonly_root_filesystem" BOOLEAN,
        "ulimits" STRUCT(
            "hard_limit" BIGINT,
            "name" VARCHAR,
            "soft_limit" BIGINT
        )[],
        "privileged" BOOLEAN,
        "user" VARCHAR,
        "exit_code" BIGINT,
        "reason" VARCHAR,
        "container_instance_arn" VARCHAR,
        "task_arn" VARCHAR,
        "log_stream_name" VARCHAR,
        "instance_type" VARCHAR,
        "network_interfaces" STRUCT(
            "attachment_id" VARCHAR,
            "ipv6_address" VARCHAR,
            "private_ipv4_address" VARCHAR
        )[],
        "resource_requirements" STRUCT(
            "value" VARCHAR,
            "type" VARCHAR
        )[],
        "linux_parameters" STRUCT(
            "devices" STRUCT(
                "host_path" VARCHAR,
                "container_path" VARCHAR,
                "permissions" VARCHAR[]
            )[],
            "init_process_enabled" BOOLEAN,
            "shared_memory_size" BIGINT,
            "tmpfs" STRUCT(
                "container_path" VARCHAR,
                "size" BIGINT,
                "mount_options" VARCHAR[]
            )[],
            "max_swap" BIGINT,
            "swappiness" BIGINT
        ),
        "log_configuration" STRUCT(
            "log_driver" VARCHAR,
            "options" MAP(VARCHAR, VARCHAR),
            "secret_options" STRUCT(
                "name" VARCHAR,
                "value_from" VARCHAR
            )[]
        ),
        "secrets" STRUCT(
            "name" VARCHAR,
            "value_from" VARCHAR
        )[],
        "network_configuration" STRUCT(
            "assign_public_ip" VARCHAR
        ),
        "fargate_platform_configuration" STRUCT(
            "platform_version" VARCHAR
        ),
        "ephemeral_storage" STRUCT(
            "size_in_gi_b" BIGINT
        ),
        "runtime_platform" STRUCT(
            "operating_system_family" VARCHAR,
            "cpu_architecture" VARCHAR
        ),
        "repository_credentials" STRUCT(
            "credentials_parameter" VARCHAR
        )
    ),
    "node_details" STRUCT(
        "node_index" BIGINT,
        "is_main_node" BOOLEAN
    ),
    "node_properties" STRUCT(
        "num_nodes" BIGINT,
        "main_node" BIGINT,
        "node_range_properties" STRUCT(
            "target_nodes" VARCHAR,
            "container" STRUCT(
                "image" VARCHAR,
                "vcpus" BIGINT,
                "memory" BIGINT,
                "command" VARCHAR[],
                "job_role_arn" VARCHAR,
                "execution_role_arn" VARCHAR,
                "volumes" STRUCT(
                    "host" STRUCT(
                        "source_path" VARCHAR
                    ),
                    "name" VARCHAR,
                    "efs_volume_configuration" STRUCT(
                        "file_system_id" VARCHAR,
                        "root_directory" VARCHAR,
                        "transit_encryption" VARCHAR,
                        "transit_encryption_port" BIGINT,
                        "authorization_config" STRUCT(
                            "access_point_id" VARCHAR,
                            "iam" VARCHAR
                        )
                    )
                )[],
                "environment" STRUCT(
                    "name" VARCHAR,
                    "value" VARCHAR
                )[],
                "mount_points" STRUCT(
                    "container_path" VARCHAR,
                    "read_only" BOOLEAN,
                    "source_volume" VARCHAR
                )[],
                "readonly_root_filesystem" BOOLEAN,
                "privileged" BOOLEAN,
                "ulimits" STRUCT(
                    "hard_limit" BIGINT,
                    "name" VARCHAR,
                    "soft_limit" BIGINT
                )[],
                "user" VARCHAR,
                "instance_type" VARCHAR,
                "resource_requirements" STRUCT(
                    "value" VARCHAR,
                    "type" VARCHAR
                )[],
                "linux_parameters" STRUCT(
                    "devices" STRUCT(
                        "host_path" VARCHAR,
                        "container_path" VARCHAR,
                        "permissions" VARCHAR[]
                    )[],
                    "init_process_enabled" BOOLEAN,
                    "shared_memory_size" BIGINT,
                    "tmpfs" STRUCT(
                        "container_path" VARCHAR,
                        "size" BIGINT,
                        "mount_options" VARCHAR[]
                    )[],
                    "max_swap" BIGINT,
                    "swappiness" BIGINT
                ),
                "log_configuration" STRUCT(
                    "log_driver" VARCHAR,
                    "options" MAP(VARCHAR, VARCHAR),
                    "secret_options" STRUCT(
                        "name" VARCHAR,
                        "value_from" VARCHAR
                    )[]
                ),
                "secrets" STRUCT(
                    "name" VARCHAR,
                    "value_from" VARCHAR
                )[],
                "network_configuration" STRUCT(
                    "assign_public_ip" VARCHAR
                ),
                "fargate_platform_configuration" STRUCT(
                    "platform_version" VARCHAR
                ),
                "ephemeral_storage" STRUCT(
                    "size_in_gi_b" BIGINT
                ),
                "runtime_platform" STRUCT(
                    "operating_system_family" VARCHAR,
                    "cpu_architecture" VARCHAR
                ),
                "repository_credentials" STRUCT(
                    "credentials_parameter" VARCHAR
                )
            ),
            "instance_types" VARCHAR[],
            "ecs_properties" STRUCT(
                "task_properties" STRUCT(
                    "containers" STRUCT(
                        "command" VARCHAR[],
                        "depends_on" STRUCT(
                            "container_name" VARCHAR,
                            "condition" VARCHAR
                        )[],
                        "environment" STRUCT(
                            "name" VARCHAR,
                            "value" VARCHAR
                        )[],
                        "essential" BOOLEAN,
                        "image" VARCHAR,
                        "linux_parameters" STRUCT(
                            "devices" STRUCT(
                                "host_path" VARCHAR,
                                "container_path" VARCHAR,
                                "permissions" VARCHAR[]
                            )[],
                            "init_process_enabled" BOOLEAN,
                            "shared_memory_size" BIGINT,
                            "tmpfs" STRUCT(
                                "container_path" VARCHAR,
                                "size" BIGINT,
                                "mount_options" VARCHAR[]
                            )[],
                            "max_swap" BIGINT,
                            "swappiness" BIGINT
                        ),
                        "log_configuration" STRUCT(
                            "log_driver" VARCHAR,
                            "options" MAP(VARCHAR, VARCHAR),
                            "secret_options" STRUCT(
                                "name" VARCHAR,
                                "value_from" VARCHAR
                            )[]
                        ),
                        "mount_points" STRUCT(
                            "container_path" VARCHAR,
                            "read_only" BOOLEAN,
                            "source_volume" VARCHAR
                        )[],
                        "name" VARCHAR,
                        "privileged" BOOLEAN,
                        "readonly_root_filesystem" BOOLEAN,
                        "repository_credentials" STRUCT(
                            "credentials_parameter" VARCHAR
                        ),
                        "resource_requirements" STRUCT(
                            "value" VARCHAR,
                            "type" VARCHAR
                        )[],
                        "secrets" STRUCT(
                            "name" VARCHAR,
                            "value_from" VARCHAR
                        )[],
                        "ulimits" STRUCT(
                            "hard_limit" BIGINT,
                            "name" VARCHAR,
                            "soft_limit" BIGINT
                        )[],
                        "user" VARCHAR
                    )[],
                    "ephemeral_storage" STRUCT(
                        "size_in_gi_b" BIGINT
                    ),
                    "execution_role_arn" VARCHAR,
                    "platform_version" VARCHAR,
                    "ipc_mode" VARCHAR,
                    "task_role_arn" VARCHAR,
                    "pid_mode" VARCHAR,
                    "network_configuration" STRUCT(
                        "assign_public_ip" VARCHAR
                    ),
                    "runtime_platform" STRUCT(
                        "operating_system_family" VARCHAR,
                        "cpu_architecture" VARCHAR
                    ),
                    "volumes" STRUCT(
                        "host" STRUCT(
                            "source_path" VARCHAR
                        ),
                        "name" VARCHAR,
                        "efs_volume_configuration" STRUCT(
                            "file_system_id" VARCHAR,
                            "root_directory" VARCHAR,
                            "transit_encryption" VARCHAR,
                            "transit_encryption_port" BIGINT,
                            "authorization_config" STRUCT(
                                "access_point_id" VARCHAR,
                                "iam" VARCHAR
                            )
                        )
                    )[]
                )[]
            ),
            "eks_properties" STRUCT(
                "pod_properties" STRUCT(
                    "service_account_name" VARCHAR,
                    "host_network" BOOLEAN,
                    "dns_policy" VARCHAR,
                    "image_pull_secrets" STRUCT(
                        "name" VARCHAR
                    )[],
                    "containers" STRUCT(
                        "name" VARCHAR,
                        "image" VARCHAR,
                        "image_pull_policy" VARCHAR,
                        "command" VARCHAR[],
                        "args" VARCHAR[],
                        "env" STRUCT(
                            "name" VARCHAR,
                            "value" VARCHAR
                        )[],
                        "resources" STRUCT(
                            "limits" MAP(VARCHAR, VARCHAR),
                            "requests" MAP(VARCHAR, VARCHAR)
                        ),
                        "volume_mounts" STRUCT(
                            "name" VARCHAR,
                            "mount_path" VARCHAR,
                            "read_only" BOOLEAN
                        )[],
                        "security_context" STRUCT(
                            "run_as_user" BIGINT,
                            "run_as_group" BIGINT,
                            "privileged" BOOLEAN,
                            "allow_privilege_escalation" BOOLEAN,
                            "read_only_root_filesystem" BOOLEAN,
                            "run_as_non_root" BOOLEAN
                        )
                    )[],
                    "init_containers" STRUCT(
                        "name" VARCHAR,
                        "image" VARCHAR,
                        "image_pull_policy" VARCHAR,
                        "command" VARCHAR[],
                        "args" VARCHAR[],
                        "env" STRUCT(
                            "name" VARCHAR,
                            "value" VARCHAR
                        )[],
                        "resources" STRUCT(
                            "limits" MAP(VARCHAR, VARCHAR),
                            "requests" MAP(VARCHAR, VARCHAR)
                        ),
                        "volume_mounts" STRUCT(
                            "name" VARCHAR,
                            "mount_path" VARCHAR,
                            "read_only" BOOLEAN
                        )[],
                        "security_context" STRUCT(
                            "run_as_user" BIGINT,
                            "run_as_group" BIGINT,
                            "privileged" BOOLEAN,
                            "allow_privilege_escalation" BOOLEAN,
                            "read_only_root_filesystem" BOOLEAN,
                            "run_as_non_root" BOOLEAN
                        )
                    )[],
                    "volumes" STRUCT(
                        "name" VARCHAR,
                        "host_path" STRUCT(
                            "path" VARCHAR
                        ),
                        "empty_dir" STRUCT(
                            "medium" VARCHAR,
                            "size_limit" VARCHAR
                        ),
                        "secret" STRUCT(
                            "secret_name" VARCHAR,
                            "optional" BOOLEAN
                        )
                    )[],
                    "metadata" STRUCT(
                        "labels" MAP(VARCHAR, VARCHAR)
                    ),
                    "share_process_namespace" BOOLEAN
                )
            )
        )[]
    ),
    "array_properties" STRUCT(
        "status_summary" MAP(VARCHAR, BIGINT),
        "size" BIGINT,
        "index" BIGINT
    ),
    "timeout" STRUCT(
        "attempt_duration_seconds" BIGINT
    ),
    "tags" MAP(VARCHAR, VARCHAR),
    "propagate_tags" BOOLEAN,
    "platform_capabilities" VARCHAR[],
    "eks_properties" STRUCT(
        "pod_properties" STRUCT(
            "service_account_name" VARCHAR,
            "host_network" BOOLEAN,
            "dns_policy" VARCHAR,
            "image_pull_secrets" STRUCT(
                "name" VARCHAR
            )[],
            "containers" STRUCT(
                "name" VARCHAR,
                "image" VARCHAR,
                "image_pull_policy" VARCHAR,
                "command" VARCHAR[],
                "args" VARCHAR[],
                "env" STRUCT(
                    "name" VARCHAR,
                    "value" VARCHAR
                )[],
                "resources" STRUCT(
                    "limits" MAP(VARCHAR, VARCHAR),
                    "requests" MAP(VARCHAR, VARCHAR)
                ),
                "exit_code" BIGINT,
                "reason" VARCHAR,
                "volume_mounts" STRUCT(
                    "name" VARCHAR,
                    "mount_path" VARCHAR,
                    "read_only" BOOLEAN
                )[],
                "security_context" STRUCT(
                    "run_as_user" BIGINT,
                    "run_as_group" BIGINT,
                    "privileged" BOOLEAN,
                    "allow_privilege_escalation" BOOLEAN,
                    "read_only_root_filesystem" BOOLEAN,
                    "run_as_non_root" BOOLEAN
                )
            )[],
            "init_containers" STRUCT(
                "name" VARCHAR,
                "image" VARCHAR,
                "image_pull_policy" VARCHAR,
                "command" VARCHAR[],
                "args" VARCHAR[],
                "env" STRUCT(
                    "name" VARCHAR,
                    "value" VARCHAR
                )[],
                "resources" STRUCT(
                    "limits" MAP(VARCHAR, VARCHAR),
                    "requests" MAP(VARCHAR, VARCHAR)
                ),
                "exit_code" BIGINT,
                "reason" VARCHAR,
                "volume_mounts" STRUCT(
                    "name" VARCHAR,
                    "mount_path" VARCHAR,
                    "read_only" BOOLEAN
                )[],
                "security_context" STRUCT(
                    "run_as_user" BIGINT,
                    "run_as_group" BIGINT,
                    "privileged" BOOLEAN,
                    "allow_privilege_escalation" BOOLEAN,
                    "read_only_root_filesystem" BOOLEAN,
                    "run_as_non_root" BOOLEAN
                )
            )[],
            "volumes" STRUCT(
                "name" VARCHAR,
                "host_path" STRUCT(
                    "path" VARCHAR
                ),
                "empty_dir" STRUCT(
                    "medium" VARCHAR,
                    "size_limit" VARCHAR
                ),
                "secret" STRUCT(
                    "secret_name" VARCHAR,
                    "optional" BOOLEAN
                )
            )[],
            "pod_name" VARCHAR,
            "node_name" VARCHAR,
            "metadata" STRUCT(
                "labels" MAP(VARCHAR, VARCHAR)
            ),
            "share_process_namespace" BOOLEAN
        )
    ),
    "eks_attempts" STRUCT(
        "containers" STRUCT(
            "name" VARCHAR,
            "exit_code" BIGINT,
            "reason" VARCHAR
        )[],
        "init_containers" STRUCT(
            "name" VARCHAR,
            "exit_code" BIGINT,
            "reason" VARCHAR
        )[],
        "eks_cluster_arn" VARCHAR,
        "pod_name" VARCHAR,
        "node_name" VARCHAR,
        "started_at" BIGINT,
        "stopped_at" BIGINT,
        "status_reason" VARCHAR
    )[],
    "ecs_properties" STRUCT(
        "task_properties" STRUCT(
            "containers" STRUCT(
                "command" VARCHAR[],
                "depends_on" STRUCT(
                    "container_name" VARCHAR,
                    "condition" VARCHAR
                )[],
                "environment" STRUCT(
                    "name" VARCHAR,
                    "value" VARCHAR
                )[],
                "essential" BOOLEAN,
                "image" VARCHAR,
                "linux_parameters" STRUCT(
                    "devices" STRUCT(
                        "host_path" VARCHAR,
                        "container_path" VARCHAR,
                        "permissions" VARCHAR[]
                    )[],
                    "init_process_enabled" BOOLEAN,
                    "shared_memory_size" BIGINT,
                    "tmpfs" STRUCT(
                        "container_path" VARCHAR,
                        "size" BIGINT,
                        "mount_options" VARCHAR[]
                    )[],
                    "max_swap" BIGINT,
                    "swappiness" BIGINT
                ),
                "log_configuration" STRUCT(
                    "log_driver" VARCHAR,
                    "options" MAP(VARCHAR, VARCHAR),
                    "secret_options" STRUCT(
                        "name" VARCHAR,
                        "value_from" VARCHAR
                    )[]
                ),
                "mount_points" STRUCT(
                    "container_path" VARCHAR,
                    "read_only" BOOLEAN,
                    "source_volume" VARCHAR
                )[],
                "name" VARCHAR,
                "privileged" BOOLEAN,
                "readonly_root_filesystem" BOOLEAN,
                "repository_credentials" STRUCT(
                    "credentials_parameter" VARCHAR
                ),
                "resource_requirements" STRUCT(
                    "value" VARCHAR,
                    "type" VARCHAR
                )[],
                "secrets" STRUCT(
                    "name" VARCHAR,
                    "value_from" VARCHAR
                )[],
                "ulimits" STRUCT(
                    "hard_limit" BIGINT,
                    "name" VARCHAR,
                    "soft_limit" BIGINT
                )[],
                "user" VARCHAR,
                "exit_code" BIGINT,
                "reason" VARCHAR,
                "log_stream_name" VARCHAR,
                "network_interfaces" STRUCT(
                    "attachment_id" VARCHAR,
                    "ipv6_address" VARCHAR,
                    "private_ipv4_address" VARCHAR
                )[]
            )[],
            "container_instance_arn" VARCHAR,
            "task_arn" VARCHAR,
            "ephemeral_storage" STRUCT(
                "size_in_gi_b" BIGINT
            ),
            "execution_role_arn" VARCHAR,
            "platform_version" VARCHAR,
            "ipc_mode" VARCHAR,
            "task_role_arn" VARCHAR,
            "pid_mode" VARCHAR,
            "network_configuration" STRUCT(
                "assign_public_ip" VARCHAR
            ),
            "runtime_platform" STRUCT(
                "operating_system_family" VARCHAR,
                "cpu_architecture" VARCHAR
            ),
            "volumes" STRUCT(
                "host" STRUCT(
                    "source_path" VARCHAR
                ),
                "name" VARCHAR,
                "efs_volume_configuration" STRUCT(
                    "file_system_id" VARCHAR,
                    "root_directory" VARCHAR,
                    "transit_encryption" VARCHAR,
                    "transit_encryption_port" BIGINT,
                    "authorization_config" STRUCT(
                        "access_point_id" VARCHAR,
                        "iam" VARCHAR
                    )
                )
            )[]
        )[]
    ),
    "is_cancelled" BOOLEAN,
    "is_terminated" BOOLEAN
)[]
Show child fields
jobs[]
Show child fields
jobs[].array_properties

The array properties of the job, if it's an array job.

Show child fields
jobs[].array_properties.index

The job index within the array that's associated with this job. This parameter is returned for array job children.

jobs[].array_properties.size

The size of the array job. This parameter is returned for parent array jobs.

jobs[].array_properties.status_summary

A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.

jobs[].attempts[]
Show child fields
jobs[].attempts[].container

The details for the container in this job attempt.

Show child fields
jobs[].attempts[].container.container_instance_arn

The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.

jobs[].attempts[].container.exit_code

The exit code for the job attempt. A non-zero exit code is considered failed.

jobs[].attempts[].container.log_stream_name

The name of the 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 the RUNNING status.

jobs[].attempts[].container.network_interfaces[]
Show child fields
jobs[].attempts[].container.network_interfaces[].attachment_id

The attachment ID for the network interface.

jobs[].attempts[].container.network_interfaces[].ipv6_address

The private IPv6 address for the network interface.

jobs[].attempts[].container.network_interfaces[].private_ipv4_address

The private IPv4 address for the network interface.

jobs[].attempts[].container.reason

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

jobs[].attempts[].container.task_arn

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

jobs[].attempts[].started_at

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

jobs[].attempts[].status_reason

A short, human-readable string to provide additional details for the current status of the job attempt.

jobs[].attempts[].stopped_at

The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

jobs[].attempts[].task_properties[]
Show child fields
jobs[].attempts[].task_properties[].container_instance_arn

The Amazon Resource Name (ARN) of the container instance that hosts the task.

jobs[].attempts[].task_properties[].containers[]
Show child fields
jobs[].attempts[].task_properties[].containers[].exit_code

The exit code for the container’s attempt. A non-zero exit code is considered failed.

jobs[].attempts[].task_properties[].containers[].log_stream_name

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 the RUNNING status.

jobs[].attempts[].task_properties[].containers[].name

The name of a container.

jobs[].attempts[].task_properties[].containers[].network_interfaces[]
Show child fields
jobs[].attempts[].task_properties[].containers[].network_interfaces[].attachment_id

The attachment ID for the network interface.

jobs[].attempts[].task_properties[].containers[].network_interfaces[].ipv6_address

The private IPv6 address for the network interface.

jobs[].attempts[].task_properties[].containers[].network_interfaces[].private_ipv4_address

The private IPv4 address for the network interface.

jobs[].attempts[].task_properties[].containers[].reason

A short (255 max characters) string that's easy to understand and provides additional details for a running or stopped container.

jobs[].attempts[].task_properties[].task_arn

The ARN of the Amazon ECS task.

jobs[].container

An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.

Show child fields
jobs[].container.command[]
jobs[].container.container_instance_arn

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

jobs[].container.environment[]
Show child fields
jobs[].container.environment[].name

The name of the key-value pair. For environment variables, this is the name of the environment variable.

jobs[].container.environment[].value

The value of the key-value pair. For environment variables, this is the value of the environment variable.

jobs[].container.ephemeral_storage

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.

Show child fields
jobs[].container.ephemeral_storage.size_in_gi_b

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

jobs[].container.execution_role_arn

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.

jobs[].container.exit_code

The exit code returned upon completion.

jobs[].container.fargate_platform_configuration

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

Show child fields
jobs[].container.fargate_platform_configuration.platform_version

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

jobs[].container.image

The image used to start the container.

jobs[].container.instance_type

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.

jobs[].container.job_role_arn

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

jobs[].container.linux_parameters

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

Show child fields
jobs[].container.linux_parameters.devices[]
Show child fields
jobs[].container.linux_parameters.devices[].container_path

The path inside the container that's used to expose the host device. By default, the hostPath value is used.

jobs[].container.linux_parameters.devices[].host_path

The path for the device on the host container instance.

jobs[].container.linux_parameters.devices[].permissions[]
jobs[].container.linux_parameters.init_process_enabled

If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 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"

jobs[].container.linux_parameters.max_swap

The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].container.linux_parameters.shared_memory_size

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].container.linux_parameters.swappiness

You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

  • Swap space must be enabled and allocated on the container instance for the containers to use.

    By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

  • The swap space parameters are only supported for job definitions using EC2 resources.

  • If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].container.linux_parameters.tmpfs[]
Show child fields
jobs[].container.linux_parameters.tmpfs[].container_path

The absolute file path in the container where the tmpfs volume is mounted.

jobs[].container.linux_parameters.tmpfs[].mount_options[]
jobs[].container.linux_parameters.tmpfs[].size

The size (in MiB) of the tmpfs volume.

jobs[].container.log_configuration

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.

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_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.

Show child fields
jobs[].container.log_configuration.log_driver

The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

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"

jobs[].container.log_configuration.options

The configuration options to send to the log driver. This parameter requires version 1.19 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"

jobs[].container.log_configuration.secret_options[]
Show child fields
jobs[].container.log_configuration.secret_options[].name

The name of the secret.

jobs[].container.log_configuration.secret_options[].value_from

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

jobs[].container.log_stream_name

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 the RUNNING status.

jobs[].container.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.

jobs[].container.mount_points[]
Show child fields
jobs[].container.mount_points[].container_path

The path on the container where the host volume is mounted.

jobs[].container.mount_points[].read_only

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.

jobs[].container.mount_points[].source_volume

The name of the volume to mount.

jobs[].container.network_configuration

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

Show child fields
jobs[].container.network_configuration.assign_public_ip

Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the Amazon Elastic Container Service Developer Guide. The default value is "DISABLED".

jobs[].container.network_interfaces[]
Show child fields
jobs[].container.network_interfaces[].attachment_id

The attachment ID for the network interface.

jobs[].container.network_interfaces[].ipv6_address

The private IPv6 address for the network interface.

jobs[].container.network_interfaces[].private_ipv4_address

The private IPv4 address for the network interface.

jobs[].container.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.

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

jobs[].container.readonly_root_filesystem

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 .

jobs[].container.reason

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

jobs[].container.repository_credentials

The private repository authentication credentials to use.

Show child fields
jobs[].container.repository_credentials.credentials_parameter

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

jobs[].container.resource_requirements[]
Show child fields
jobs[].container.resource_requirements[].type

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

jobs[].container.resource_requirements[].value

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type="GPU"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.
type="MEMORY"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

value = 16384

VCPU = 2, 4, or 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720

VCPU = 4

value = 20480, 24576, or 28672

VCPU = 4 or 8

value = 36864, 45056, 53248, or 61440

VCPU = 8

value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16

type="VCPU"

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. For Amazon EC2 resources, 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.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

jobs[].container.runtime_platform

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

Show child fields
jobs[].container.runtime_platform.cpu_architecture

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.

This parameter must be set to X86_64 for Windows containers.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

jobs[].container.runtime_platform.operating_system_family

The operating system for the compute environment. Valid values are: LINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL.

The following parameters can’t be set for Windows containers: linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration.

The Batch Scheduler checks the compute environments that are attached to the job queue before registering a task definition with Fargate. In this scenario, the job queue is where the job is submitted. If the job requires a Windows container and the first compute environment is LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

jobs[].container.secrets[]
Show child fields
jobs[].container.secrets[].name

The name of the secret.

jobs[].container.secrets[].value_from

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

jobs[].container.task_arn

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.

jobs[].container.ulimits[]
Show child fields
jobs[].container.ulimits[].hard_limit

The hard limit for the ulimit type.

jobs[].container.ulimits[].name

The type of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.

jobs[].container.ulimits[].soft_limit

The soft limit for the ulimit type.

jobs[].container.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.

jobs[].container.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.

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.

jobs[].container.volumes[]
Show child fields
jobs[].container.volumes[].efs_volume_configuration

This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

Show child fields
jobs[].container.volumes[].efs_volume_configuration.authorization_config

The authorization configuration details for the Amazon EFS file system.

Show child fields
jobs[].container.volumes[].efs_volume_configuration.authorization_config.access_point_id

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

jobs[].container.volumes[].efs_volume_configuration.authorization_config.iam

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

jobs[].container.volumes[].efs_volume_configuration.file_system_id

The Amazon EFS file system ID to use.

jobs[].container.volumes[].efs_volume_configuration.root_directory

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

jobs[].container.volumes[].efs_volume_configuration.transit_encryption

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

jobs[].container.volumes[].efs_volume_configuration.transit_encryption_port

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

jobs[].container.volumes[].host

The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Show child fields
jobs[].container.volumes[].host.source_path

The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't 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.

This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.

jobs[].container.volumes[].name

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

jobs[].created_at

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

jobs[].depends_on[]
Show child fields
jobs[].depends_on[].job_id

The job ID of the Batch job that's associated with this dependency.

jobs[].depends_on[].type

The type of the job dependency.

jobs[].ecs_properties

An object with properties that are specific to Amazon ECS-based jobs.

Show child fields
jobs[].ecs_properties.task_properties[]
Show child fields
jobs[].ecs_properties.task_properties[].container_instance_arn

The Amazon Resource Name (ARN) of the container instance that hosts the task.

jobs[].ecs_properties.task_properties[].containers[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].command[]
jobs[].ecs_properties.task_properties[].containers[].depends_on[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].depends_on[].condition

The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

jobs[].ecs_properties.task_properties[].containers[].depends_on[].container_name

A unique identifier for the container.

jobs[].ecs_properties.task_properties[].containers[].environment[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].environment[].name

The name of the key-value pair. For environment variables, this is the name of the environment variable.

jobs[].ecs_properties.task_properties[].containers[].environment[].value

The value of the key-value pair. For environment variables, this is the value of the environment variable.

jobs[].ecs_properties.task_properties[].containers[].essential

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

jobs[].ecs_properties.task_properties[].containers[].exit_code

The exit code returned upon completion.

jobs[].ecs_properties.task_properties[].containers[].image

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. 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 the docker run .

jobs[].ecs_properties.task_properties[].containers[].linux_parameters

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see KernelCapabilities.

This parameter is not supported for Windows containers.

Show child fields
jobs[].ecs_properties.task_properties[].containers[].linux_parameters.devices[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].linux_parameters.devices[].container_path

The path inside the container that's used to expose the host device. By default, the hostPath value is used.

jobs[].ecs_properties.task_properties[].containers[].linux_parameters.devices[].host_path

The path for the device on the host container instance.

jobs[].ecs_properties.task_properties[].containers[].linux_parameters.devices[].permissions[]
jobs[].ecs_properties.task_properties[].containers[].linux_parameters.init_process_enabled

If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 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"

jobs[].ecs_properties.task_properties[].containers[].linux_parameters.max_swap

The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].ecs_properties.task_properties[].containers[].linux_parameters.shared_memory_size

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].ecs_properties.task_properties[].containers[].linux_parameters.swappiness

You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

  • Swap space must be enabled and allocated on the container instance for the containers to use.

    By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

  • The swap space parameters are only supported for job definitions using EC2 resources.

  • If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].ecs_properties.task_properties[].containers[].linux_parameters.tmpfs[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].linux_parameters.tmpfs[].container_path

The absolute file path in the container where the tmpfs volume is mounted.

jobs[].ecs_properties.task_properties[].containers[].linux_parameters.tmpfs[].mount_options[]
jobs[].ecs_properties.task_properties[].containers[].linux_parameters.tmpfs[].size

The size (in MiB) of the tmpfs volume.

jobs[].ecs_properties.task_properties[].containers[].log_configuration

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 can 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 on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may 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 --format '{{.Server.APIVersion}}'

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.

Show child fields
jobs[].ecs_properties.task_properties[].containers[].log_configuration.log_driver

The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

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"

jobs[].ecs_properties.task_properties[].containers[].log_configuration.options

The configuration options to send to the log driver. This parameter requires version 1.19 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"

jobs[].ecs_properties.task_properties[].containers[].log_configuration.secret_options[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].log_configuration.secret_options[].name

The name of the secret.

jobs[].ecs_properties.task_properties[].containers[].log_configuration.secret_options[].value_from

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

jobs[].ecs_properties.task_properties[].containers[].log_stream_name

The name of the 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 the RUNNING status.

jobs[].ecs_properties.task_properties[].containers[].mount_points[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].mount_points[].container_path

The path on the container where the host volume is mounted.

jobs[].ecs_properties.task_properties[].containers[].mount_points[].read_only

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.

jobs[].ecs_properties.task_properties[].containers[].mount_points[].source_volume

The name of the volume to mount.

jobs[].ecs_properties.task_properties[].containers[].name

The name of a container.

jobs[].ecs_properties.task_properties[].containers[].network_interfaces[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].network_interfaces[].attachment_id

The attachment ID for the network interface.

jobs[].ecs_properties.task_properties[].containers[].network_interfaces[].ipv6_address

The private IPv6 address for the network interface.

jobs[].ecs_properties.task_properties[].containers[].network_interfaces[].private_ipv4_address

The private IPv4 address for the network interface.

jobs[].ecs_properties.task_properties[].containers[].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.

This parameter is not supported for Windows containers or tasks run on Fargate.

jobs[].ecs_properties.task_properties[].containers[].readonly_root_filesystem

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.

This parameter is not supported for Windows containers.

jobs[].ecs_properties.task_properties[].containers[].reason

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

jobs[].ecs_properties.task_properties[].containers[].repository_credentials

The private repository authentication credentials to use.

Show child fields
jobs[].ecs_properties.task_properties[].containers[].repository_credentials.credentials_parameter

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

jobs[].ecs_properties.task_properties[].containers[].resource_requirements[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].resource_requirements[].type

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

jobs[].ecs_properties.task_properties[].containers[].resource_requirements[].value

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type="GPU"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.
type="MEMORY"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

value = 16384

VCPU = 2, 4, or 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720

VCPU = 4

value = 20480, 24576, or 28672

VCPU = 4 or 8

value = 36864, 45056, 53248, or 61440

VCPU = 8

value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16

type="VCPU"

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. For Amazon EC2 resources, 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.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

jobs[].ecs_properties.task_properties[].containers[].secrets[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].secrets[].name

The name of the secret.

jobs[].ecs_properties.task_properties[].containers[].secrets[].value_from

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

jobs[].ecs_properties.task_properties[].containers[].ulimits[]
Show child fields
jobs[].ecs_properties.task_properties[].containers[].ulimits[].hard_limit

The hard limit for the ulimit type.

jobs[].ecs_properties.task_properties[].containers[].ulimits[].name

The type of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.

jobs[].ecs_properties.task_properties[].containers[].ulimits[].soft_limit

The soft limit for the ulimit type.

jobs[].ecs_properties.task_properties[].containers[].user

The user 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.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gi

  • uid:group

This parameter is not supported for Windows containers.

jobs[].ecs_properties.task_properties[].ephemeral_storage

The amount of ephemeral storage allocated for the task.

Show child fields
jobs[].ecs_properties.task_properties[].ephemeral_storage.size_in_gi_b

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

jobs[].ecs_properties.task_properties[].execution_role_arn

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.

jobs[].ecs_properties.task_properties[].ipc_mode

The IPC resource namespace to use for the containers in the task.

jobs[].ecs_properties.task_properties[].network_configuration

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

Show child fields
jobs[].ecs_properties.task_properties[].network_configuration.assign_public_ip

Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the Amazon Elastic Container Service Developer Guide. The default value is "DISABLED".

jobs[].ecs_properties.task_properties[].pid_mode

The process namespace to use for the containers in the task.

jobs[].ecs_properties.task_properties[].platform_version

The Fargate platform version where the jobs are running.

jobs[].ecs_properties.task_properties[].runtime_platform

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

Show child fields
jobs[].ecs_properties.task_properties[].runtime_platform.cpu_architecture

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.

This parameter must be set to X86_64 for Windows containers.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

jobs[].ecs_properties.task_properties[].runtime_platform.operating_system_family

The operating system for the compute environment. Valid values are: LINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL.

The following parameters can’t be set for Windows containers: linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration.

The Batch Scheduler checks the compute environments that are attached to the job queue before registering a task definition with Fargate. In this scenario, the job queue is where the job is submitted. If the job requires a Windows container and the first compute environment is LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

jobs[].ecs_properties.task_properties[].task_arn

The ARN of the Amazon ECS task.

jobs[].ecs_properties.task_properties[].task_role_arn

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

This is object is comparable to ContainerProperties:jobRoleArn.

jobs[].ecs_properties.task_properties[].volumes[]
Show child fields
jobs[].ecs_properties.task_properties[].volumes[].efs_volume_configuration

This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

Show child fields
jobs[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.authorization_config

The authorization configuration details for the Amazon EFS file system.

Show child fields
jobs[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.authorization_config.access_point_id

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

jobs[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.authorization_config.iam

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

jobs[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.file_system_id

The Amazon EFS file system ID to use.

jobs[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.root_directory

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

jobs[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.transit_encryption

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

jobs[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.transit_encryption_port

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

jobs[].ecs_properties.task_properties[].volumes[].host

The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Show child fields
jobs[].ecs_properties.task_properties[].volumes[].host.source_path

The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't 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.

This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.

jobs[].ecs_properties.task_properties[].volumes[].name

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

jobs[].eks_attempts[]
Show child fields
jobs[].eks_attempts[].containers[]
Show child fields
jobs[].eks_attempts[].containers[].exit_code

The exit code returned for the job attempt. A non-zero exit code is considered failed.

jobs[].eks_attempts[].containers[].name

The name of a container.

jobs[].eks_attempts[].containers[].reason

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

jobs[].eks_attempts[].eks_cluster_arn

The Amazon Resource Name (ARN) of the Amazon EKS cluster.

jobs[].eks_attempts[].init_containers[]
Show child fields
jobs[].eks_attempts[].init_containers[].exit_code

The exit code returned for the job attempt. A non-zero exit code is considered failed.

jobs[].eks_attempts[].init_containers[].name

The name of a container.

jobs[].eks_attempts[].init_containers[].reason

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

jobs[].eks_attempts[].node_name

The name of the node for this job attempt.

jobs[].eks_attempts[].pod_name

The name of the pod for this job attempt.

jobs[].eks_attempts[].started_at

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

jobs[].eks_attempts[].status_reason

A short, human-readable string to provide additional details for the current status of the job attempt.

jobs[].eks_attempts[].stopped_at

The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

jobs[].eks_properties

An object with various properties that are specific to Amazon EKS based jobs.

Show child fields
jobs[].eks_properties.pod_properties

The properties for the Kubernetes pod resources of a job.

Show child fields
jobs[].eks_properties.pod_properties.containers[]
Show child fields
jobs[].eks_properties.pod_properties.containers[].args[]
jobs[].eks_properties.pod_properties.containers[].command[]
jobs[].eks_properties.pod_properties.containers[].env[]
Show child fields
jobs[].eks_properties.pod_properties.containers[].env[].name

The name of the environment variable.

jobs[].eks_properties.pod_properties.containers[].env[].value

The value of the environment variable.

jobs[].eks_properties.pod_properties.containers[].exit_code

The exit code returned for the job attempt. A non-zero exit code is considered failed.

jobs[].eks_properties.pod_properties.containers[].image

The Docker image used to start the container.

jobs[].eks_properties.pod_properties.containers[].image_pull_policy

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.containers[].name

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

jobs[].eks_properties.pod_properties.containers[].reason

A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

jobs[].eks_properties.pod_properties.containers[].resources

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Show child fields
jobs[].eks_properties.pod_properties.containers[].resources.limits

The type and quantity of the resources to reserve for the container. The values vary based on the name that's specified. Resources can be requested using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using. To learn how, see Memory management in the Batch User Guide.
cpu

The number of CPUs that's reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that's reserved for the container. Values must be a whole integer. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

jobs[].eks_properties.pod_properties.containers[].resources.requests

The type and quantity of the resources to request for the container. The values vary based on the name that's specified. Resources can be requested by using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
cpu

The number of CPUs that are reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that are reserved for the container. Values must be a whole integer. nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

jobs[].eks_properties.pod_properties.containers[].security_context

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

Show child fields
jobs[].eks_properties.pod_properties.containers[].security_context.allow_privilege_escalation

Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process. The default value is false.

jobs[].eks_properties.pod_properties.containers[].security_context.privileged

When this parameter is true, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.containers[].security_context.read_only_root_filesystem

When this parameter is true, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.containers[].security_context.run_as_group

When this parameter is specified, the container is run as the specified group ID (gid). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.containers[].security_context.run_as_non_root

When this parameter is specified, the container is run as a user with a uid other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.containers[].security_context.run_as_user

When this parameter is specified, the container is run as the specified user ID (uid). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.containers[].volume_mounts[]
Show child fields
jobs[].eks_properties.pod_properties.containers[].volume_mounts[].mount_path

The path on the container where the volume is mounted.

jobs[].eks_properties.pod_properties.containers[].volume_mounts[].name

The name the volume mount. This must match the name of one of the volumes in the pod.

jobs[].eks_properties.pod_properties.containers[].volume_mounts[].read_only

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.

jobs[].eks_properties.pod_properties.dns_policy

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

jobs[].eks_properties.pod_properties.host_network

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.image_pull_secrets[]
Show child fields
jobs[].eks_properties.pod_properties.image_pull_secrets[].name

Provides a unique identifier for the ImagePullSecret. This object is required when EksPodProperties$imagePullSecrets is used.

jobs[].eks_properties.pod_properties.init_containers[]
Show child fields
jobs[].eks_properties.pod_properties.init_containers[].args[]
jobs[].eks_properties.pod_properties.init_containers[].command[]
jobs[].eks_properties.pod_properties.init_containers[].env[]
Show child fields
jobs[].eks_properties.pod_properties.init_containers[].env[].name

The name of the environment variable.

jobs[].eks_properties.pod_properties.init_containers[].env[].value

The value of the environment variable.

jobs[].eks_properties.pod_properties.init_containers[].exit_code

The exit code returned for the job attempt. A non-zero exit code is considered failed.

jobs[].eks_properties.pod_properties.init_containers[].image

The Docker image used to start the container.

jobs[].eks_properties.pod_properties.init_containers[].image_pull_policy

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.init_containers[].name

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

jobs[].eks_properties.pod_properties.init_containers[].reason

A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

jobs[].eks_properties.pod_properties.init_containers[].resources

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Show child fields
jobs[].eks_properties.pod_properties.init_containers[].resources.limits

The type and quantity of the resources to reserve for the container. The values vary based on the name that's specified. Resources can be requested using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using. To learn how, see Memory management in the Batch User Guide.
cpu

The number of CPUs that's reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that's reserved for the container. Values must be a whole integer. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

jobs[].eks_properties.pod_properties.init_containers[].resources.requests

The type and quantity of the resources to request for the container. The values vary based on the name that's specified. Resources can be requested by using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
cpu

The number of CPUs that are reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that are reserved for the container. Values must be a whole integer. nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

jobs[].eks_properties.pod_properties.init_containers[].security_context

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

Show child fields
jobs[].eks_properties.pod_properties.init_containers[].security_context.allow_privilege_escalation

Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process. The default value is false.

jobs[].eks_properties.pod_properties.init_containers[].security_context.privileged

When this parameter is true, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.init_containers[].security_context.read_only_root_filesystem

When this parameter is true, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.init_containers[].security_context.run_as_group

When this parameter is specified, the container is run as the specified group ID (gid). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.init_containers[].security_context.run_as_non_root

When this parameter is specified, the container is run as a user with a uid other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.init_containers[].security_context.run_as_user

When this parameter is specified, the container is run as the specified user ID (uid). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.init_containers[].volume_mounts[]
Show child fields
jobs[].eks_properties.pod_properties.init_containers[].volume_mounts[].mount_path

The path on the container where the volume is mounted.

jobs[].eks_properties.pod_properties.init_containers[].volume_mounts[].name

The name the volume mount. This must match the name of one of the volumes in the pod.

jobs[].eks_properties.pod_properties.init_containers[].volume_mounts[].read_only

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.

jobs[].eks_properties.pod_properties.metadata

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

Show child fields
jobs[].eks_properties.pod_properties.metadata.labels

Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63 uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be added or modified at any time. Each resource can have multiple labels, but each key must be unique for a given object.

jobs[].eks_properties.pod_properties.node_name

The name of the node for this job.

jobs[].eks_properties.pod_properties.pod_name

The name of the pod for this job.

jobs[].eks_properties.pod_properties.service_account_name

The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.share_process_namespace

Indicates if the processes in a container are shared, or visible, to other containers in the same pod. For more information, see Share Process Namespace between Containers in a Pod.

jobs[].eks_properties.pod_properties.volumes[]
Show child fields
jobs[].eks_properties.pod_properties.volumes[].empty_dir

Specifies the configuration of a Kubernetes emptyDir volume. For more information, see emptyDir in the Kubernetes documentation.

Show child fields
jobs[].eks_properties.pod_properties.volumes[].empty_dir.medium

The medium to store the volume. The default value is an empty string, which uses the storage of the node.

""

(Default) Use the disk storage of the node.

"Memory"

Use the tmpfs volume that's backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container's memory limit.

jobs[].eks_properties.pod_properties.volumes[].empty_dir.size_limit

The maximum size of the volume. By default, there's no maximum size defined.

jobs[].eks_properties.pod_properties.volumes[].host_path

Specifies the configuration of a Kubernetes hostPath volume. For more information, see hostPath in the Kubernetes documentation.

Show child fields
jobs[].eks_properties.pod_properties.volumes[].host_path.path

The path of the file or directory on the host to mount into containers on the pod.

jobs[].eks_properties.pod_properties.volumes[].name

The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

jobs[].eks_properties.pod_properties.volumes[].secret

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

Show child fields
jobs[].eks_properties.pod_properties.volumes[].secret.optional

Specifies whether the secret or the secret's keys must be defined.

jobs[].eks_properties.pod_properties.volumes[].secret.secret_name

The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

jobs[].is_cancelled

Indicates whether the job is canceled.

jobs[].is_terminated

Indicates whether the job is terminated.

jobs[].job_arn

The Amazon Resource Name (ARN) of the job.

jobs[].job_definition

The Amazon Resource Name (ARN) of the job definition that this job uses.

jobs[].job_id

The job ID.

jobs[].job_name

The job name.

jobs[].job_queue

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

jobs[].node_details

An object that represents the details of a node that's associated with a multi-node parallel job.

Show child fields
jobs[].node_details.is_main_node

Specifies whether the current node is the main node for a multi-node parallel job.

jobs[].node_details.node_index

The node index for the node. Node index numbering starts at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

jobs[].node_properties

An object that represents the node properties of a multi-node parallel job.

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

Show child fields
jobs[].node_properties.main_node

Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.

jobs[].node_properties.node_range_properties[]
Show child fields
jobs[].node_properties.node_range_properties[].container

The container details for the node range.

Show child fields
jobs[].node_properties.node_range_properties[].container.command[]
jobs[].node_properties.node_range_properties[].container.environment[]
Show child fields
jobs[].node_properties.node_range_properties[].container.environment[].name

The name of the key-value pair. For environment variables, this is the name of the environment variable.

jobs[].node_properties.node_range_properties[].container.environment[].value

The value of the key-value pair. For environment variables, this is the value of the environment variable.

jobs[].node_properties.node_range_properties[].container.ephemeral_storage

The amount of ephemeral storage to allocate 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.

Show child fields
jobs[].node_properties.node_range_properties[].container.ephemeral_storage.size_in_gi_b

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

jobs[].node_properties.node_range_properties[].container.execution_role_arn

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

jobs[].node_properties.node_range_properties[].container.fargate_platform_configuration

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

Show child fields
jobs[].node_properties.node_range_properties[].container.fargate_platform_configuration.platform_version

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

jobs[].node_properties.node_range_properties[].container.image

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 . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

  • Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest .

  • Images in Amazon ECR repositories use the full registry and repository URI (for example, 123456789012.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).

jobs[].node_properties.node_range_properties[].container.instance_type

The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

jobs[].node_properties.node_range_properties[].container.job_role_arn

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

jobs[].node_properties.node_range_properties[].container.linux_parameters

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

Show child fields
jobs[].node_properties.node_range_properties[].container.linux_parameters.devices[]
Show child fields
jobs[].node_properties.node_range_properties[].container.linux_parameters.devices[].container_path

The path inside the container that's used to expose the host device. By default, the hostPath value is used.

jobs[].node_properties.node_range_properties[].container.linux_parameters.devices[].host_path

The path for the device on the host container instance.

jobs[].node_properties.node_range_properties[].container.linux_parameters.devices[].permissions[]
jobs[].node_properties.node_range_properties[].container.linux_parameters.init_process_enabled

If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 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"

jobs[].node_properties.node_range_properties[].container.linux_parameters.max_swap

The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].node_properties.node_range_properties[].container.linux_parameters.shared_memory_size

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].node_properties.node_range_properties[].container.linux_parameters.swappiness

You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

  • Swap space must be enabled and allocated on the container instance for the containers to use.

    By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

  • The swap space parameters are only supported for job definitions using EC2 resources.

  • If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].node_properties.node_range_properties[].container.linux_parameters.tmpfs[]
Show child fields
jobs[].node_properties.node_range_properties[].container.linux_parameters.tmpfs[].container_path

The absolute file path in the container where the tmpfs volume is mounted.

jobs[].node_properties.node_range_properties[].container.linux_parameters.tmpfs[].mount_options[]
jobs[].node_properties.node_range_properties[].container.linux_parameters.tmpfs[].size

The size (in MiB) of the tmpfs volume.

jobs[].node_properties.node_range_properties[].container.log_configuration

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 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).

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_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.

Show child fields
jobs[].node_properties.node_range_properties[].container.log_configuration.log_driver

The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

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"

jobs[].node_properties.node_range_properties[].container.log_configuration.options

The configuration options to send to the log driver. This parameter requires version 1.19 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"

jobs[].node_properties.node_range_properties[].container.log_configuration.secret_options[]
Show child fields
jobs[].node_properties.node_range_properties[].container.log_configuration.secret_options[].name

The name of the secret.

jobs[].node_properties.node_range_properties[].container.log_configuration.secret_options[].value_from

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

jobs[].node_properties.node_range_properties[].container.memory

This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

jobs[].node_properties.node_range_properties[].container.mount_points[]
Show child fields
jobs[].node_properties.node_range_properties[].container.mount_points[].container_path

The path on the container where the host volume is mounted.

jobs[].node_properties.node_range_properties[].container.mount_points[].read_only

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.

jobs[].node_properties.node_range_properties[].container.mount_points[].source_volume

The name of the volume to mount.

jobs[].node_properties.node_range_properties[].container.network_configuration

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

Show child fields
jobs[].node_properties.node_range_properties[].container.network_configuration.assign_public_ip

Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the Amazon Elastic Container Service Developer Guide. The default value is "DISABLED".

jobs[].node_properties.node_range_properties[].container.privileged

When this parameter is true, the container is given elevated permissions 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. The default value is false.

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

jobs[].node_properties.node_range_properties[].container.readonly_root_filesystem

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.

jobs[].node_properties.node_range_properties[].container.repository_credentials

The private repository authentication credentials to use.

Show child fields
jobs[].node_properties.node_range_properties[].container.repository_credentials.credentials_parameter

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

jobs[].node_properties.node_range_properties[].container.resource_requirements[]
Show child fields
jobs[].node_properties.node_range_properties[].container.resource_requirements[].type

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

jobs[].node_properties.node_range_properties[].container.resource_requirements[].value

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type="GPU"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.
type="MEMORY"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

value = 16384

VCPU = 2, 4, or 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720

VCPU = 4

value = 20480, 24576, or 28672

VCPU = 4 or 8

value = 36864, 45056, 53248, or 61440

VCPU = 8

value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16

type="VCPU"

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. For Amazon EC2 resources, 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.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

jobs[].node_properties.node_range_properties[].container.runtime_platform

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

Show child fields
jobs[].node_properties.node_range_properties[].container.runtime_platform.cpu_architecture

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.

This parameter must be set to X86_64 for Windows containers.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

jobs[].node_properties.node_range_properties[].container.runtime_platform.operating_system_family

The operating system for the compute environment. Valid values are: LINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL.

The following parameters can’t be set for Windows containers: linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration.

The Batch Scheduler checks the compute environments that are attached to the job queue before registering a task definition with Fargate. In this scenario, the job queue is where the job is submitted. If the job requires a Windows container and the first compute environment is LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

jobs[].node_properties.node_range_properties[].container.secrets[]
Show child fields
jobs[].node_properties.node_range_properties[].container.secrets[].name

The name of the secret.

jobs[].node_properties.node_range_properties[].container.secrets[].value_from

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

jobs[].node_properties.node_range_properties[].container.ulimits[]
Show child fields
jobs[].node_properties.node_range_properties[].container.ulimits[].hard_limit

The hard limit for the ulimit type.

jobs[].node_properties.node_range_properties[].container.ulimits[].name

The type of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.

jobs[].node_properties.node_range_properties[].container.ulimits[].soft_limit

The soft limit for the ulimit type.

jobs[].node_properties.node_range_properties[].container.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.

jobs[].node_properties.node_range_properties[].container.vcpus

This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

jobs[].node_properties.node_range_properties[].container.volumes[]
Show child fields
jobs[].node_properties.node_range_properties[].container.volumes[].efs_volume_configuration

This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

Show child fields
jobs[].node_properties.node_range_properties[].container.volumes[].efs_volume_configuration.authorization_config

The authorization configuration details for the Amazon EFS file system.

Show child fields
jobs[].node_properties.node_range_properties[].container.volumes[].efs_volume_configuration.authorization_config.access_point_id

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

jobs[].node_properties.node_range_properties[].container.volumes[].efs_volume_configuration.authorization_config.iam

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

jobs[].node_properties.node_range_properties[].container.volumes[].efs_volume_configuration.file_system_id

The Amazon EFS file system ID to use.

jobs[].node_properties.node_range_properties[].container.volumes[].efs_volume_configuration.root_directory

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

jobs[].node_properties.node_range_properties[].container.volumes[].efs_volume_configuration.transit_encryption

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

jobs[].node_properties.node_range_properties[].container.volumes[].efs_volume_configuration.transit_encryption_port

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

jobs[].node_properties.node_range_properties[].container.volumes[].host

The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Show child fields
jobs[].node_properties.node_range_properties[].container.volumes[].host.source_path

The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't 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.

This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.

jobs[].node_properties.node_range_properties[].container.volumes[].name

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

jobs[].node_properties.node_range_properties[].ecs_properties

This is an object that represents the properties of the node range for a multi-node parallel job.

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].command[]
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].depends_on[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].depends_on[].condition

The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].depends_on[].container_name

A unique identifier for the container.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].environment[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].environment[].name

The name of the key-value pair. For environment variables, this is the name of the environment variable.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].environment[].value

The value of the key-value pair. For environment variables, this is the value of the environment variable.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].essential

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].image

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. 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 the docker run .

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see KernelCapabilities.

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.devices[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.devices[].container_path

The path inside the container that's used to expose the host device. By default, the hostPath value is used.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.devices[].host_path

The path for the device on the host container instance.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.devices[].permissions[]
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.init_process_enabled

If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 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"

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.max_swap

The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.shared_memory_size

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.swappiness

You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

  • Swap space must be enabled and allocated on the container instance for the containers to use.

    By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

  • The swap space parameters are only supported for job definitions using EC2 resources.

  • If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.tmpfs[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.tmpfs[].container_path

The absolute file path in the container where the tmpfs volume is mounted.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.tmpfs[].mount_options[]
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].linux_parameters.tmpfs[].size

The size (in MiB) of the tmpfs volume.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].log_configuration

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 can 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 on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may 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 --format '{{.Server.APIVersion}}'

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.

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].log_configuration.log_driver

The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

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"

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].log_configuration.options

The configuration options to send to the log driver. This parameter requires version 1.19 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"

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].log_configuration.secret_options[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].log_configuration.secret_options[].name

The name of the secret.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].log_configuration.secret_options[].value_from

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].mount_points[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].mount_points[].container_path

The path on the container where the host volume is mounted.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].mount_points[].read_only

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.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].mount_points[].source_volume

The name of the volume to mount.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].name

The name of a container. The name can be used as a unique identifier to target your dependsOn and Overrides objects.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].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.

This parameter is not supported for Windows containers or tasks run on Fargate.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].readonly_root_filesystem

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.

This parameter is not supported for Windows containers.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].repository_credentials

The private repository authentication credentials to use.

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].repository_credentials.credentials_parameter

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].resource_requirements[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].resource_requirements[].type

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

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].resource_requirements[].value

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type="GPU"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.
type="MEMORY"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

value = 16384

VCPU = 2, 4, or 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720

VCPU = 4

value = 20480, 24576, or 28672

VCPU = 4 or 8

value = 36864, 45056, 53248, or 61440

VCPU = 8

value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16

type="VCPU"

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. For Amazon EC2 resources, 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.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].secrets[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].secrets[].name

The name of the secret.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].secrets[].value_from

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].ulimits[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].ulimits[].hard_limit

The hard limit for the ulimit type.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].ulimits[].name

The type of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].ulimits[].soft_limit

The soft limit for the ulimit type.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].containers[].user

The user 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.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gi

  • uid:group

This parameter is not supported for Windows containers.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].ephemeral_storage

The amount of ephemeral storage to allocate 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.

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].ephemeral_storage.size_in_gi_b

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].execution_role_arn

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].ipc_mode

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none.

If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same IPC resources.

If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.

If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].network_configuration

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

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].network_configuration.assign_public_ip

Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the Amazon Elastic Container Service Developer Guide. The default value is "DISABLED".

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].pid_mode

The process namespace to use for the containers in the task. The valid values are host or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].platform_version

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].runtime_platform

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

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].runtime_platform.cpu_architecture

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.

This parameter must be set to X86_64 for Windows containers.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].runtime_platform.operating_system_family

The operating system for the compute environment. Valid values are: LINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL.

The following parameters can’t be set for Windows containers: linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration.

The Batch Scheduler checks the compute environments that are attached to the job queue before registering a task definition with Fargate. In this scenario, the job queue is where the job is submitted. If the job requires a Windows container and the first compute environment is LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].task_role_arn

The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

This is object is comparable to ContainerProperties:jobRoleArn.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[]
Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].efs_volume_configuration

This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.authorization_config

The authorization configuration details for the Amazon EFS file system.

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.authorization_config.access_point_id

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.authorization_config.iam

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.file_system_id

The Amazon EFS file system ID to use.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.root_directory

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.transit_encryption

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].efs_volume_configuration.transit_encryption_port

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].host

The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Show child fields
jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].host.source_path

The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't 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.

This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.

jobs[].node_properties.node_range_properties[].ecs_properties.task_properties[].volumes[].name

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

jobs[].node_properties.node_range_properties[].eks_properties

This is an object that represents the properties of the node range for a multi-node parallel job.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties

The properties for the Kubernetes pod resources of a job.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[]
Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].args[]
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].command[]
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].env[]
Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].env[].name

The name of the environment variable.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].env[].value

The value of the environment variable.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].image

The Docker image used to start the container.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].image_pull_policy

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].name

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].resources

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].resources.limits

The type and quantity of the resources to reserve for the container. The values vary based on the name that's specified. Resources can be requested using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using. To learn how, see Memory management in the Batch User Guide.
cpu

The number of CPUs that's reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that's reserved for the container. Values must be a whole integer. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].resources.requests

The type and quantity of the resources to request for the container. The values vary based on the name that's specified. Resources can be requested by using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
cpu

The number of CPUs that are reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that are reserved for the container. Values must be a whole integer. nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].security_context

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].security_context.allow_privilege_escalation

Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process. The default value is false.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].security_context.privileged

When this parameter is true, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].security_context.read_only_root_filesystem

When this parameter is true, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].security_context.run_as_group

When this parameter is specified, the container is run as the specified group ID (gid). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].security_context.run_as_non_root

When this parameter is specified, the container is run as a user with a uid other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].security_context.run_as_user

When this parameter is specified, the container is run as the specified user ID (uid). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].volume_mounts[]
Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].volume_mounts[].mount_path

The path on the container where the volume is mounted.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].volume_mounts[].name

The name the volume mount. This must match the name of one of the volumes in the pod.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.containers[].volume_mounts[].read_only

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.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.dns_policy

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.host_network

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.image_pull_secrets[]
Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.image_pull_secrets[].name

Provides a unique identifier for the ImagePullSecret. This object is required when EksPodProperties$imagePullSecrets is used.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[]
Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].args[]
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].command[]
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].env[]
Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].env[].name

The name of the environment variable.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].env[].value

The value of the environment variable.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].image

The Docker image used to start the container.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].image_pull_policy

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].name

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].resources

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].resources.limits

The type and quantity of the resources to reserve for the container. The values vary based on the name that's specified. Resources can be requested using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using. To learn how, see Memory management in the Batch User Guide.
cpu

The number of CPUs that's reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that's reserved for the container. Values must be a whole integer. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].resources.requests

The type and quantity of the resources to request for the container. The values vary based on the name that's specified. Resources can be requested by using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
cpu

The number of CPUs that are reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that are reserved for the container. Values must be a whole integer. nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].security_context

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].security_context.allow_privilege_escalation

Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process. The default value is false.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].security_context.privileged

When this parameter is true, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].security_context.read_only_root_filesystem

When this parameter is true, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].security_context.run_as_group

When this parameter is specified, the container is run as the specified group ID (gid). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].security_context.run_as_non_root

When this parameter is specified, the container is run as a user with a uid other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].security_context.run_as_user

When this parameter is specified, the container is run as the specified user ID (uid). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].volume_mounts[]
Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].volume_mounts[].mount_path

The path on the container where the volume is mounted.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].volume_mounts[].name

The name the volume mount. This must match the name of one of the volumes in the pod.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.init_containers[].volume_mounts[].read_only

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.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.metadata

Metadata about the Kubernetes pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.metadata.labels

Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63 uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be added or modified at any time. Each resource can have multiple labels, but each key must be unique for a given object.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.service_account_name

The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.share_process_namespace

Indicates if the processes in a container are shared, or visible, to other containers in the same pod. For more information, see Share Process Namespace between Containers in a Pod.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[]
Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].empty_dir

Specifies the configuration of a Kubernetes emptyDir volume. For more information, see emptyDir in the Kubernetes documentation.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].empty_dir.medium

The medium to store the volume. The default value is an empty string, which uses the storage of the node.

""

(Default) Use the disk storage of the node.

"Memory"

Use the tmpfs volume that's backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container's memory limit.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].empty_dir.size_limit

The maximum size of the volume. By default, there's no maximum size defined.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].host_path

Specifies the configuration of a Kubernetes hostPath volume. For more information, see hostPath in the Kubernetes documentation.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].host_path.path

The path of the file or directory on the host to mount into containers on the pod.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].name

The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].secret

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

Show child fields
jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].secret.optional

Specifies whether the secret or the secret's keys must be defined.

jobs[].node_properties.node_range_properties[].eks_properties.pod_properties.volumes[].secret.secret_name

The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

jobs[].node_properties.node_range_properties[].instance_types[]
jobs[].node_properties.node_range_properties[].target_nodes

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range properties override the 0:10 properties.

jobs[].node_properties.num_nodes

The number of nodes that are associated with a multi-node parallel job.

jobs[].parameters

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

jobs[].platform_capabilities[]
jobs[].propagate_tags

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

jobs[].retry_strategy

The retry strategy to use for this job if an attempt fails.

Show child fields
jobs[].retry_strategy.attempts

The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

jobs[].retry_strategy.evaluate_on_exit[]
Show child fields
jobs[].retry_strategy.evaluate_on_exit[].action

Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive.

jobs[].retry_strategy.evaluate_on_exit[].on_exit_code

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can contain up to 512 characters.

jobs[].retry_strategy.evaluate_on_exit[].on_reason

Contains a glob pattern to match against the Reason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

jobs[].retry_strategy.evaluate_on_exit[].on_status_reason

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

jobs[].scheduling_priority

The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

jobs[].share_identifier

The share identifier for the job.

jobs[].started_at

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

jobs[].status

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

jobs[].status_reason

A short, human-readable string to provide more details for the current status of the job.

  • CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to service the job.

  • MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a maxVcpu setting that is smaller than the job requirements.

  • MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances that meet the job requirements.

  • MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the service role permissions.

jobs[].stopped_at

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

jobs[].tags

The tags that are applied to the job.

jobs[].timeout

The timeout configuration for the job.

Show child fields
jobs[].timeout.attempt_duration_seconds

The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60 seconds.

For array jobs, the timeout applies to the child jobs, not to the parent array job.

For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.