ECS / Client / start_task

start_task#

ECS.Client.start_task(**kwargs)#

Starts a new task from the specified task definition on the specified container instance or instances.

Note
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

Note
Amazon Elastic Inference (EI) is no longer available to customers.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

See also: AWS API Documentation

Request Syntax
response = client.start_task(
    cluster='string',
    containerInstances=[
        'string',
    ],
    enableECSManagedTags=True|False,
    enableExecuteCommand=True|False,
    group='string',
    networkConfiguration={
        'awsvpcConfiguration': {
            'subnets': [
                'string',
            ],
            'securityGroups': [
                'string',
            ],
            'assignPublicIp': 'ENABLED'|'DISABLED'
        }
    },
    overrides={
        'containerOverrides': [
            {
                'name': 'string',
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'environmentFiles': [
                    {
                        'value': 'string',
                        'type': 's3'
                    },
                ],
                'cpu': 123,
                'memory': 123,
                'memoryReservation': 123,
                'resourceRequirements': [
                    {
                        'value': 'string',
                        'type': 'GPU'|'InferenceAccelerator'
                    },
                ]
            },
        ],
        'cpu': 'string',
        'inferenceAcceleratorOverrides': [
            {
                'deviceName': 'string',
                'deviceType': 'string'
            },
        ],
        'executionRoleArn': 'string',
        'memory': 'string',
        'taskRoleArn': 'string',
        'ephemeralStorage': {
            'sizeInGiB': 123
        }
    },
    propagateTags='TASK_DEFINITION'|'SERVICE'|'NONE',
    referenceId='string',
    startedBy='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    taskDefinition='string',
    volumeConfigurations=[
        {
            'name': 'string',
            'managedEBSVolume': {
                'encrypted': True|False,
                'kmsKeyId': 'string',
                'volumeType': 'string',
                'sizeInGiB': 123,
                'snapshotId': 'string',
                'iops': 123,
                'throughput': 123,
                'tagSpecifications': [
                    {
                        'resourceType': 'volume',
                        'tags': [
                            {
                                'key': 'string',
                                'value': 'string'
                            },
                        ],
                        'propagateTags': 'TASK_DEFINITION'|'SERVICE'|'NONE'
                    },
                ],
                'roleArn': 'string',
                'terminationPolicy': {
                    'deleteOnTermination': True|False
                },
                'filesystemType': 'ext3'|'ext4'|'xfs'|'ntfs'
            }
        },
    ]
)
type cluster:

string

param cluster:

The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.

type containerInstances:

list

param containerInstances:

[REQUIRED]

The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

(string) –

type enableECSManagedTags:

boolean

param enableECSManagedTags:

Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

type enableExecuteCommand:

boolean

param enableExecuteCommand:

Whether or not the execute command functionality is turned on for the task. If true, this turns on the execute command functionality on all containers in the task.

type group:

string

param group:

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

type networkConfiguration:

dict

param networkConfiguration:

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

awsvpcConfiguration (dict) –

The VPC subnets and security groups that are associated with a task.

Note
All specified subnets and security groups must be from the same VPC.

subnets (list) – [REQUIRED]

The IDs of the subnets associated with the task or service. There’s a limit of 16 subnets that can be specified per awsvpcConfiguration.

Note
All specified subnets must be from the same VPC.

(string) –

securityGroups (list) –

The IDs of the security groups associated with the task or service. If you don’t specify a security group, the default security group for the VPC is used. There’s a limit of 5 security groups that can be specified per awsvpcConfiguration.

Note
All specified security groups must be from the same VPC.

(string) –

assignPublicIp (string) –

Whether the task’s elastic network interface receives a public IP address. The default value is DISABLED.

type overrides:

dict

param overrides:

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it receives. You can override the default command for a container (that’s specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

Note
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

containerOverrides (list) –

One or more container overrides that are sent to a task.

(dict) –

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see Retrieve secrets through environment variables in the Amazon ECS Developer Guide.

name (string) –

The name of the container that receives the override. This parameter is required if any override is specified.

command (list) –

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

(string) –

environment (list) –

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

(dict) –

A key-value pair object.

name (string) –

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

value (string) –

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

environmentFiles (list) –

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

(dict) –

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they’re processed from the top down. We recommend that you use unique variable names. For more information, see Use a file to pass environment variables to a container in the Amazon Elastic Container Service Developer Guide.

Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply.

You must use the following platforms for the Fargate launch type:

Linux platform version 1.4.0 or later.

Windows platform version 1.0.0 or later.

Consider the following when using the Fargate launch type:

The file is handled like a native Docker env-file.

There is no support for shell escape handling.

The container entry point interperts the VARIABLE values.

value (string) – [REQUIRED]

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

type (string) – [REQUIRED]

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

cpu (integer) –

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

memory (integer) –

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

memoryReservation (integer) –

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

resourceRequirements (list) –

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

(dict) –

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

value (string) – [REQUIRED]

The value for the specified resource type.

When the type is GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that’s reserved for all containers in a task can’t exceed the number of available GPUs on the container instance that the task is launched on.

When the type is InferenceAccelerator, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

type (string) – [REQUIRED]

The type of resource to assign to a container.

cpu (string) –

The CPU override for the task.

inferenceAcceleratorOverrides (list) –

The Elastic Inference accelerator override for the task.

(dict) –

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

deviceName (string) –

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

deviceType (string) –

The Elastic Inference accelerator type to use.

executionRoleArn (string) –

The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

memory (string) –

The memory override for the task.

taskRoleArn (string) –

The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.

ephemeralStorage (dict) –

The ephemeral storage setting override for the task.

Note
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

Linux platform version 1.4.0 or later.

Windows platform version 1.0.0 or later.

sizeInGiB (integer) – [REQUIRED]

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

type propagateTags:

string

param propagateTags:

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren’t propagated.

type referenceId:

string

param referenceId:

This parameter is only used by Amazon ECS. It is not intended for use by customers.

type startedBy:

string

param startedBy:

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.

If a task is started by an Amazon ECS service, the startedBy parameter contains the deployment ID of the service that starts it.

type tags:

list

param tags:

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50

For each resource, each tag key must be unique, and each tag key can have only one value.

Maximum key length - 128 Unicode characters in UTF-8

Maximum value length - 256 Unicode characters in UTF-8

If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

Tag keys and values are case-sensitive.

Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

(dict) –

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50

For each resource, each tag key must be unique, and each tag key can have only one value.

Maximum key length - 128 Unicode characters in UTF-8

Maximum value length - 256 Unicode characters in UTF-8

If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

Tag keys and values are case-sensitive.

Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

key (string) –

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

value (string) –

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

type taskDefinition:

string

param taskDefinition:

[REQUIRED]

The family and revision ( family:revision) or full ARN of the task definition to start. If a revision isn’t specified, the latest ACTIVE revision is used.

type volumeConfigurations:

list

param volumeConfigurations:

The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

(dict) –

Configuration settings for the task volume that was configuredAtLaunch that weren’t set during RegisterTaskDef.

name (string) – [REQUIRED]

The name of the volume. This value must match the volume name from the Volume object in the task definition.

managedEBSVolume (dict) –

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.

encrypted (boolean) –

Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.

kmsKeyId (string) –

The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.

Warning
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.

volumeType (string) –

The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

The following are the supported volume types.

General Purpose SSD: gp2``| ``gp3

Provisioned IOPS SSD: io1``| ``io2

Throughput Optimized HDD: st1

Cold HDD: sc1

Magnetic: standard

Note
The magnetic volume type is not supported on Fargate.

sizeInGiB (integer) –

The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.

The following are the supported volume size values for each volume type.

gp2 and gp3: 1-16,384

io1 and io2: 4-16,384

st1 and sc1: 125-16,384

standard: 1-1,024

snapshotId (string) –

The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.

iops (integer) –

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type.

gp3: 3,000 - 16,000 IOPS

io1: 100 - 64,000 IOPS

io2: 100 - 256,000 IOPS

This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.

This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.

throughput (integer) –

The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.

Warning
This parameter is only supported for the gp3 volume type.

tagSpecifications (list) –

The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.

(dict) –

The tag specifications of an Amazon EBS volume.

resourceType (string) – [REQUIRED]

The type of volume resource.

tags (list) –

The tags applied to this Amazon EBS volume. AmazonECSCreated and AmazonECSManaged are reserved tags that can’t be used.

(dict) –

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50

For each resource, each tag key must be unique, and each tag key can have only one value.

Maximum key length - 128 Unicode characters in UTF-8

Maximum value length - 256 Unicode characters in UTF-8

If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

Tag keys and values are case-sensitive.

Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

key (string) –

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

value (string) –

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

propagateTags (string) –

Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a SERVICE specified in

ServiceVolumeConfiguration. If no value is specified, the tags aren’t propagated.

roleArn (string) – [REQUIRED]

The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

terminationPolicy (dict) –

The termination policy for the volume when the task exits. This provides a way to control whether Amazon ECS terminates the Amazon EBS volume when the task stops.

deleteOnTermination (boolean) – [REQUIRED]

Indicates whether the volume should be deleted on when the task stops. If a value of true is specified, Amazon ECS deletes the Amazon EBS volume on your behalf when the task goes into the STOPPED state. If no value is specified, the default value is true is used. When set to false, Amazon ECS leaves the volume in your account.

filesystemType (string) –

The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

The available filesystem types are

ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.

rtype:

dict

returns:
Response Syntax
{
    'tasks': [
        {
            'attachments': [
                {
                    'id': 'string',
                    'type': 'string',
                    'status': 'string',
                    'details': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ]
                },
            ],
            'attributes': [
                {
                    'name': 'string',
                    'value': 'string',
                    'targetType': 'container-instance',
                    'targetId': 'string'
                },
            ],
            'availabilityZone': 'string',
            'capacityProviderName': 'string',
            'clusterArn': 'string',
            'connectivity': 'CONNECTED'|'DISCONNECTED',
            'connectivityAt': datetime(2015, 1, 1),
            'containerInstanceArn': 'string',
            'containers': [
                {
                    'containerArn': 'string',
                    'taskArn': 'string',
                    'name': 'string',
                    'image': 'string',
                    'imageDigest': 'string',
                    'runtimeId': 'string',
                    'lastStatus': 'string',
                    'exitCode': 123,
                    'reason': 'string',
                    'networkBindings': [
                        {
                            'bindIP': 'string',
                            'containerPort': 123,
                            'hostPort': 123,
                            'protocol': 'tcp'|'udp',
                            'containerPortRange': 'string',
                            'hostPortRange': 'string'
                        },
                    ],
                    'networkInterfaces': [
                        {
                            'attachmentId': 'string',
                            'privateIpv4Address': 'string',
                            'ipv6Address': 'string'
                        },
                    ],
                    'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
                    'managedAgents': [
                        {
                            'lastStartedAt': datetime(2015, 1, 1),
                            'name': 'ExecuteCommandAgent',
                            'reason': 'string',
                            'lastStatus': 'string'
                        },
                    ],
                    'cpu': 'string',
                    'memory': 'string',
                    'memoryReservation': 'string',
                    'gpuIds': [
                        'string',
                    ]
                },
            ],
            'cpu': 'string',
            'createdAt': datetime(2015, 1, 1),
            'desiredStatus': 'string',
            'enableExecuteCommand': True|False,
            'executionStoppedAt': datetime(2015, 1, 1),
            'group': 'string',
            'healthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
            'inferenceAccelerators': [
                {
                    'deviceName': 'string',
                    'deviceType': 'string'
                },
            ],
            'lastStatus': 'string',
            'launchType': 'EC2'|'FARGATE'|'EXTERNAL',
            'memory': 'string',
            'overrides': {
                'containerOverrides': [
                    {
                        'name': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'environmentFiles': [
                            {
                                'value': 'string',
                                'type': 's3'
                            },
                        ],
                        'cpu': 123,
                        'memory': 123,
                        'memoryReservation': 123,
                        'resourceRequirements': [
                            {
                                'value': 'string',
                                'type': 'GPU'|'InferenceAccelerator'
                            },
                        ]
                    },
                ],
                'cpu': 'string',
                'inferenceAcceleratorOverrides': [
                    {
                        'deviceName': 'string',
                        'deviceType': 'string'
                    },
                ],
                'executionRoleArn': 'string',
                'memory': 'string',
                'taskRoleArn': 'string',
                'ephemeralStorage': {
                    'sizeInGiB': 123
                }
            },
            'platformVersion': 'string',
            'platformFamily': 'string',
            'pullStartedAt': datetime(2015, 1, 1),
            'pullStoppedAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'startedBy': 'string',
            'stopCode': 'TaskFailedToStart'|'EssentialContainerExited'|'UserInitiated'|'ServiceSchedulerInitiated'|'SpotInterruption'|'TerminationNotice',
            'stoppedAt': datetime(2015, 1, 1),
            'stoppedReason': 'string',
            'stoppingAt': datetime(2015, 1, 1),
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'taskArn': 'string',
            'taskDefinitionArn': 'string',
            'version': 123,
            'ephemeralStorage': {
                'sizeInGiB': 123
            },
            'fargateEphemeralStorage': {
                'sizeInGiB': 123,
                'kmsKeyId': 'string'
            }
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string',
            'detail': 'string'
        },
    ]
}
Response Structure

(dict) –

tasks (list) –

A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.

(dict) –

Details on a task in a cluster.

attachments (list) –

The Elastic Network Adapter that’s associated with the task if the task uses the awsvpc network mode.

(dict) –

An object representing a container instance or task attachment.

id (string) –

The unique identifier for the attachment.

type (string) –

The type of the attachment, such as ElasticNetworkInterface, Service Connect, and AmazonElasticBlockStorage.

status (string) –

The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

details (list) –

Details of the attachment.

For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

For Service Connect services, this includes portName, clientAliases, discoveryName, and ingressPortOverride.

For Elastic Block Storage, this includes roleArn, deleteOnTermination, volumeName, volumeId, and statusReason (only when the attachment fails to create or attach).

(dict) –

A key-value pair object.

name (string) –

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

value (string) –

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

attributes (list) –

The attributes of the task

(dict) –

An attribute is a name-value pair that’s associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

name (string) –

The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).

value (string) –

The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can’t start or end with a space.

targetType (string) –

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

targetId (string) –

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

availabilityZone (string) –

The Availability Zone for the task.

capacityProviderName (string) –

The capacity provider that’s associated with the task.

clusterArn (string) –

The ARN of the cluster that hosts the task.

connectivity (string) –

The connectivity status of a task.

connectivityAt (datetime) –

The Unix timestamp for the time when the task last went into CONNECTED status.

containerInstanceArn (string) –

The ARN of the container instances that host the task.

containers (list) –

The containers that’s associated with the task.

(dict) –

A Docker container that’s part of a task.

containerArn (string) –

The Amazon Resource Name (ARN) of the container.

taskArn (string) –

The ARN of the task.

name (string) –

The name of the container.

image (string) –

The image used for the container.

imageDigest (string) –

The container image manifest digest.

runtimeId (string) –

The ID of the Docker container.

lastStatus (string) –

The last known status of the container.

exitCode (integer) –

The exit code returned from the container.

reason (string) –

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

networkBindings (list) –

The network bindings associated with the container.

(dict) –

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

bindIP (string) –

The IP address that the container is bound to on the container instance.

containerPort (integer) –

The port number on the container that’s used with the network binding.

hostPort (integer) –

The port number on the host that’s used with the network binding.

protocol (string) –

The protocol used for the network binding.

containerPortRange (string) –

The port number range on the container that’s bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

You must use either the bridge network mode or the awsvpc network mode.

This parameter is available for both the EC2 and Fargate launch types.

This parameter is available for both the Linux and Windows operating systems.

The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ecs-init package

You can specify a maximum of 100 port ranges per container.

You do not specify a hostPortRange. The value of the hostPortRange is set as follows:

For containers in a task with the awsvpc network mode, the hostPortRange is set to the same value as the containerPortRange. This is a static mapping strategy.

For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.

The containerPortRange valid values are between 1 and 65535.

A port can only be included in one port mapping per container.

You cannot specify overlapping port ranges.

The first port in the range must be less than last port in the range.

Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

hostPortRange (string) –

The port number range on the host that’s used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.

networkInterfaces (list) –

The network interfaces associated with the container.

(dict) –

An object representing the elastic network interface for tasks that use the awsvpc network mode.

attachmentId (string) –

The attachment ID for the network interface.

privateIpv4Address (string) –

The private IPv4 address for the network interface.

ipv6Address (string) –

The private IPv6 address for the network interface.

healthStatus (string) –

The health status of the container. If health checks aren’t configured for this container in its task definition, then it reports the health status as UNKNOWN.

managedAgents (list) –

The details of any Amazon ECS managed agents associated with the container.

(dict) –

Details about the managed agent status for the container.

lastStartedAt (datetime) –

The Unix timestamp for the time when the managed agent was last started.

name (string) –

The name of the managed agent. When the execute command feature is turned on, the managed agent name is ExecuteCommandAgent.

reason (string) –

The reason for why the managed agent is in the state it is in.

lastStatus (string) –

The last known status of the managed agent.

cpu (string) –

The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

memory (string) –

The hard limit (in MiB) of memory set for the container.

memoryReservation (string) –

The soft limit (in MiB) of memory set for the container.

gpuIds (list) –

The IDs of each GPU assigned to the container.

(string) –

cpu (string) –

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.

If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units ( 0.125 vCPUs) and 10240 CPU units ( 10 vCPUs).

If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform 1.4.0 or later.

16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments This option requires Linux platform 1.4.0 or later.

createdAt (datetime) –

The Unix timestamp for the time when the task was created. More specifically, it’s for the time when the task entered the PENDING state.

desiredStatus (string) –

The desired status of the task. For more information, see Task Lifecycle.

enableExecuteCommand (boolean) –

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

executionStoppedAt (datetime) –

The Unix timestamp for the time when the task execution stopped.

group (string) –

The name of the task group that’s associated with the task.

healthStatus (string) –

The health status for the task. It’s determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.

Note
The Amazon ECS container agent doesn’t monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image’s Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

inferenceAccelerators (list) –

The Elastic Inference accelerator that’s associated with the task.

(dict) –

Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

deviceName (string) –

The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.

deviceType (string) –

The Elastic Inference accelerator type to use.

lastStatus (string) –

The last known status for the task. For more information, see Task Lifecycle.

launchType (string) –

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

memory (string) –

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it’s expressed as a string using GB (for example, 1GB or 1 GB), it’s converted to an integer indicating the MiB when the task definition is registered.

If you use the EC2 launch type, this field is optional.

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU) This option requires Linux platform 1.4.0 or later.

Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU) This option requires Linux platform 1.4.0 or later.

overrides (dict) –

One or more container overrides.

containerOverrides (list) –

One or more container overrides that are sent to a task.

(dict) –

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see Retrieve secrets through environment variables in the Amazon ECS Developer Guide.

name (string) –

The name of the container that receives the override. This parameter is required if any override is specified.

command (list) –

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

(string) –

environment (list) –

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

(dict) –

A key-value pair object.

name (string) –

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

value (string) –

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

environmentFiles (list) –

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

(dict) –

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they’re processed from the top down. We recommend that you use unique variable names. For more information, see Use a file to pass environment variables to a container in the Amazon Elastic Container Service Developer Guide.

Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply.

You must use the following platforms for the Fargate launch type:

Linux platform version 1.4.0 or later.

Windows platform version 1.0.0 or later.

Consider the following when using the Fargate launch type:

The file is handled like a native Docker env-file.

There is no support for shell escape handling.

The container entry point interperts the VARIABLE values.

value (string) –

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

type (string) –

The file type to use. Environment files are objects in Amazon S3. The only supported value is s3.

cpu (integer) –

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

memory (integer) –

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

memoryReservation (integer) –

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

resourceRequirements (list) –

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

(dict) –

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

value (string) –

The value for the specified resource type.

When the type is GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that’s reserved for all containers in a task can’t exceed the number of available GPUs on the container instance that the task is launched on.

When the type is InferenceAccelerator, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

type (string) –

The type of resource to assign to a container.

cpu (string) –

The CPU override for the task.

inferenceAcceleratorOverrides (list) –

The Elastic Inference accelerator override for the task.

(dict) –

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

deviceName (string) –

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

deviceType (string) –

The Elastic Inference accelerator type to use.

executionRoleArn (string) –

The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

memory (string) –

The memory override for the task.

taskRoleArn (string) –

The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.

ephemeralStorage (dict) –

The ephemeral storage setting override for the task.

Note
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

Linux platform version 1.4.0 or later.

Windows platform version 1.0.0 or later.

sizeInGiB (integer) –

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

platformVersion (string) –

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn’t specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

platformFamily (string) –

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).

pullStartedAt (datetime) –

The Unix timestamp for the time when the container image pull began.

pullStoppedAt (datetime) –

The Unix timestamp for the time when the container image pull completed.

startedAt (datetime) –

The Unix timestamp for the time when the task started. More specifically, it’s for the time when the task transitioned from the PENDING state to the RUNNING state.

startedBy (string) –

The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.

stopCode (string) –

The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

stoppedAt (datetime) –

The Unix timestamp for the time when the task was stopped. More specifically, it’s for the time when the task transitioned from the RUNNING state to the STOPPED state.

stoppedReason (string) –

The reason that the task was stopped.

stoppingAt (datetime) –

The Unix timestamp for the time when the task stops. More specifically, it’s for the time when the task transitions from the RUNNING state to STOPPING.

tags (list) –

The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50

For each resource, each tag key must be unique, and each tag key can have only one value.

Maximum key length - 128 Unicode characters in UTF-8

Maximum value length - 256 Unicode characters in UTF-8

If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

Tag keys and values are case-sensitive.

Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

(dict) –

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50

For each resource, each tag key must be unique, and each tag key can have only one value.

Maximum key length - 128 Unicode characters in UTF-8

Maximum value length - 256 Unicode characters in UTF-8

If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

Tag keys and values are case-sensitive.

Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

key (string) –

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

value (string) –

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

taskArn (string) –

The Amazon Resource Name (ARN) of the task.

taskDefinitionArn (string) –

The ARN of the task definition that creates the task.

version (integer) –

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

ephemeralStorage (dict) –

The ephemeral storage settings for the task.

sizeInGiB (integer) –

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

fargateEphemeralStorage (dict) –

The Fargate ephemeral storage settings for the task.

sizeInGiB (integer) –

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

200 GiB.

kmsKeyId (string) –

Specify an Key Management Service key ID to encrypt the ephemeral storage for the task.

failures (list) –

Any failures associated with the call.

(dict) –

A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

arn (string) –

The Amazon Resource Name (ARN) of the failed resource.

reason (string) –

The reason for the failure.

detail (string) –

The details of the failure.

Exceptions

ECS.Client.exceptions.ServerException

ECS.Client.exceptions.ClientException

ECS.Client.exceptions.InvalidParameterException

ECS.Client.exceptions.ClusterNotFoundException

ECS.Client.exceptions.UnsupportedFeatureException