Amazonka.ECS.Types.Task

Documentation

data Task

Details on a task in a cluster.

See: newTask smart constructor.

Constructors

Task'

Fields

• attachments :: Maybe [Attachment]

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

• attributes :: Maybe [Attribute]

  The attributes of the task

• availabilityZone :: Maybe Text

  The Availability Zone for the task.

• capacityProviderName :: Maybe Text

  The capacity provider that's associated with the task.

• clusterArn :: Maybe Text

  The ARN of the cluster that hosts the task.

• connectivity :: Maybe Connectivity

  The connectivity status of a task.

• connectivityAt :: Maybe POSIX

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

• containerInstanceArn :: Maybe Text

  The ARN of the container instances that host the task.

• containers :: Maybe [Container]

  The containers that's associated with the task.

• cpu :: Maybe Text

  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 :: Maybe POSIX

  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 :: Maybe Text

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

• enableExecuteCommand :: Maybe Bool

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

• ephemeralStorage :: Maybe EphemeralStorage

  The ephemeral storage settings for the task.

• executionStoppedAt :: Maybe POSIX

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

• group' :: Maybe Text

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

• healthStatus :: Maybe HealthStatus

  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.

  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 :: Maybe [InferenceAccelerator]

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

• lastStatus :: Maybe Text

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

• launchType :: Maybe LaunchType

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

• memory :: Maybe Text

  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 :: Maybe TaskOverride

  One or more container overrides.

• platformFamily :: Maybe Text

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

• platformVersion :: Maybe Text

  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.

• pullStartedAt :: Maybe POSIX

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

• pullStoppedAt :: Maybe POSIX

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

• startedAt :: Maybe POSIX

  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 :: Maybe Text

  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 :: Maybe TaskStopCode

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

  The following are valid values:

  • TaskFailedToStart

  • EssentialContainerExited

  • UserInitiated

  • TerminationNotice

  • ServiceSchedulerInitiated

  • SpotInterruption

• stoppedAt :: Maybe POSIX

  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 :: Maybe Text

  The reason that the task was stopped.

• stoppingAt :: Maybe POSIX

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

• tags :: Maybe [Tag]

  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.
• taskArn :: Maybe Text

  The Amazon Resource Name (ARN) of the task.

• taskDefinitionArn :: Maybe Text

  The ARN of the task definition that creates the task.

• version :: Maybe 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.

Instances

FromJSON Task

Defined in Amazonka.ECS.Types.Task

Methods

parseJSON :: Value -> Parser Task

parseJSONList :: Value -> Parser [Task]

Generic Task

Defined in Amazonka.ECS.Types.Task

Associated Types

type Rep Task :: Type -> Type

Methods

from :: Task -> Rep Task x

to :: Rep Task x -> Task

Read Task

Defined in Amazonka.ECS.Types.Task

Methods

readsPrec :: Int -> ReadS Task

readList :: ReadS [Task]

readPrec :: ReadPrec Task

readListPrec :: ReadPrec [Task]

Show Task

Defined in Amazonka.ECS.Types.Task

Methods

showsPrec :: Int -> Task -> ShowS

show :: Task -> String

showList :: [Task] -> ShowS

NFData Task

Defined in Amazonka.ECS.Types.Task

Methods

rnf :: Task -> ()

Eq Task

Defined in Amazonka.ECS.Types.Task

Methods

(==) :: Task -> Task -> Bool

(/=) :: Task -> Task -> Bool

Hashable Task

Defined in Amazonka.ECS.Types.Task

Methods

hashWithSalt :: Int -> Task -> Int

hash :: Task -> Int

type Rep Task

Defined in Amazonka.ECS.Types.Task

type Rep Task = D1 ('MetaData "Task" "Amazonka.ECS.Types.Task" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "Task'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attachment])) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute]))) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "capacityProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Connectivity))) :*: (S1 ('MetaSel ('Just "connectivityAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "containerInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "containers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Container])))))) :*: (((S1 ('MetaSel ('Just "cpu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "desiredStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enableExecuteCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "ephemeralStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EphemeralStorage)) :*: S1 ('MetaSel ('Just "executionStoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthStatus)) :*: S1 ('MetaSel ('Just "inferenceAccelerators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InferenceAccelerator]))))))) :*: ((((S1 ('MetaSel ('Just "lastStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "launchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchType))) :*: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "overrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskOverride)))) :*: ((S1 ('MetaSel ('Just "platformFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "pullStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "pullStoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :*: (((S1 ('MetaSel ('Just "startedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stopCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskStopCode))) :*: (S1 ('MetaSel ('Just "stoppedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "stoppedReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "stoppingAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))))))

newTask :: Task

Create a value of Task with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachments:Task', task_attachments - The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.

$sel:attributes:Task', task_attributes - The attributes of the task

$sel:availabilityZone:Task', task_availabilityZone - The Availability Zone for the task.

$sel:capacityProviderName:Task', task_capacityProviderName - The capacity provider that's associated with the task.

$sel:clusterArn:Task', task_clusterArn - The ARN of the cluster that hosts the task.

$sel:connectivity:Task', task_connectivity - The connectivity status of a task.

$sel:connectivityAt:Task', task_connectivityAt - The Unix timestamp for the time when the task last went into CONNECTED status.

$sel:containerInstanceArn:Task', task_containerInstanceArn - The ARN of the container instances that host the task.

$sel:containers:Task', task_containers - The containers that's associated with the task.

Task, task_cpu - 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.

$sel:createdAt:Task', task_createdAt - 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.

$sel:desiredStatus:Task', task_desiredStatus - The desired status of the task. For more information, see Task Lifecycle.

$sel:enableExecuteCommand:Task', task_enableExecuteCommand - Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.

Task, task_ephemeralStorage - The ephemeral storage settings for the task.

$sel:executionStoppedAt:Task', task_executionStoppedAt - The Unix timestamp for the time when the task execution stopped.

$sel:group':Task', task_group - The name of the task group that's associated with the task.

Task, task_healthStatus - 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.

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.

$sel:inferenceAccelerators:Task', task_inferenceAccelerators - The Elastic Inference accelerator that's associated with the task.

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

$sel:launchType:Task', task_launchType - The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

Task, task_memory - 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.

$sel:overrides:Task', task_overrides - One or more container overrides.

$sel:platformFamily:Task', task_platformFamily - 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.).

$sel:platformVersion:Task', task_platformVersion - 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.

$sel:pullStartedAt:Task', task_pullStartedAt - The Unix timestamp for the time when the container image pull began.

$sel:pullStoppedAt:Task', task_pullStoppedAt - The Unix timestamp for the time when the container image pull completed.

$sel:startedAt:Task', task_startedAt - 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.

$sel:startedBy:Task', task_startedBy - 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.

$sel:stopCode:Task', task_stopCode - The stop code indicating why a task was stopped. The stoppedReason might contain additional details.

The following are valid values:

• TaskFailedToStart

• EssentialContainerExited

• UserInitiated

• TerminationNotice

• ServiceSchedulerInitiated

• SpotInterruption

$sel:stoppedAt:Task', task_stoppedAt - 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.

$sel:stoppedReason:Task', task_stoppedReason - The reason that the task was stopped.

$sel:stoppingAt:Task', task_stoppingAt - 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 STOPPED.

$sel:tags:Task', task_tags - 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.

Task, task_taskArn - The Amazon Resource Name (ARN) of the task.

$sel:taskDefinitionArn:Task', task_taskDefinitionArn - The ARN of the task definition that creates the task.

$sel:version:Task', task_version - 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.

task_attachments :: Lens' Task (Maybe [Attachment])

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

task_attributes :: Lens' Task (Maybe [Attribute])

The attributes of the task

task_availabilityZone :: Lens' Task (Maybe Text)

The Availability Zone for the task.

task_capacityProviderName :: Lens' Task (Maybe Text)

The capacity provider that's associated with the task.

task_clusterArn :: Lens' Task (Maybe Text)

The ARN of the cluster that hosts the task.

task_connectivity :: Lens' Task (Maybe Connectivity)

The connectivity status of a task.

task_connectivityAt :: Lens' Task (Maybe UTCTime)

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

task_containerInstanceArn :: Lens' Task (Maybe Text)

The ARN of the container instances that host the task.

task_containers :: Lens' Task (Maybe [Container])

The containers that's associated with the task.

task_cpu :: Lens' Task (Maybe Text)

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.

task_createdAt :: Lens' Task (Maybe UTCTime)

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.

task_desiredStatus :: Lens' Task (Maybe Text)

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

task_enableExecuteCommand :: Lens' Task (Maybe Bool)

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

task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage)

The ephemeral storage settings for the task.

task_executionStoppedAt :: Lens' Task (Maybe UTCTime)

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

task_group :: Lens' Task (Maybe Text)

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

task_healthStatus :: Lens' Task (Maybe HealthStatus)

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.

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.

task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator])

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

task_lastStatus :: Lens' Task (Maybe Text)

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

task_launchType :: Lens' Task (Maybe LaunchType)

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

task_memory :: Lens' Task (Maybe Text)

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.

task_overrides :: Lens' Task (Maybe TaskOverride)

One or more container overrides.

task_platformFamily :: Lens' Task (Maybe Text)

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

task_platformVersion :: Lens' Task (Maybe Text)

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.

task_pullStartedAt :: Lens' Task (Maybe UTCTime)

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

task_pullStoppedAt :: Lens' Task (Maybe UTCTime)

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

task_startedAt :: Lens' Task (Maybe UTCTime)

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.

task_startedBy :: Lens' Task (Maybe Text)

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.

task_stopCode :: Lens' Task (Maybe TaskStopCode)

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

The following are valid values:

• TaskFailedToStart

• EssentialContainerExited

• UserInitiated

• TerminationNotice

• ServiceSchedulerInitiated

• SpotInterruption

task_stoppedAt :: Lens' Task (Maybe UTCTime)

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.

task_stoppedReason :: Lens' Task (Maybe Text)

The reason that the task was stopped.

task_stoppingAt :: Lens' Task (Maybe UTCTime)

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

task_tags :: Lens' Task (Maybe [Tag])

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.

task_taskArn :: Lens' Task (Maybe Text)

The Amazon Resource Name (ARN) of the task.

task_taskDefinitionArn :: Lens' Task (Maybe Text)

The ARN of the task definition that creates the task.

task_version :: Lens' Task (Maybe 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.