Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Task = Task' {
- attachments :: Maybe [Attachment]
- attributes :: Maybe [Attribute]
- availabilityZone :: Maybe Text
- capacityProviderName :: Maybe Text
- clusterArn :: Maybe Text
- connectivity :: Maybe Connectivity
- connectivityAt :: Maybe POSIX
- containerInstanceArn :: Maybe Text
- containers :: Maybe [Container]
- cpu :: Maybe Text
- createdAt :: Maybe POSIX
- desiredStatus :: Maybe Text
- enableExecuteCommand :: Maybe Bool
- ephemeralStorage :: Maybe EphemeralStorage
- executionStoppedAt :: Maybe POSIX
- group' :: Maybe Text
- healthStatus :: Maybe HealthStatus
- inferenceAccelerators :: Maybe [InferenceAccelerator]
- lastStatus :: Maybe Text
- launchType :: Maybe LaunchType
- memory :: Maybe Text
- overrides :: Maybe TaskOverride
- platformFamily :: Maybe Text
- platformVersion :: Maybe Text
- pullStartedAt :: Maybe POSIX
- pullStoppedAt :: Maybe POSIX
- startedAt :: Maybe POSIX
- startedBy :: Maybe Text
- stopCode :: Maybe TaskStopCode
- stoppedAt :: Maybe POSIX
- stoppedReason :: Maybe Text
- stoppingAt :: Maybe POSIX
- tags :: Maybe [Tag]
- taskArn :: Maybe Text
- taskDefinitionArn :: Maybe Text
- version :: Maybe Integer
- newTask :: Task
- task_attachments :: Lens' Task (Maybe [Attachment])
- task_attributes :: Lens' Task (Maybe [Attribute])
- task_availabilityZone :: Lens' Task (Maybe Text)
- task_capacityProviderName :: Lens' Task (Maybe Text)
- task_clusterArn :: Lens' Task (Maybe Text)
- task_connectivity :: Lens' Task (Maybe Connectivity)
- task_connectivityAt :: Lens' Task (Maybe UTCTime)
- task_containerInstanceArn :: Lens' Task (Maybe Text)
- task_containers :: Lens' Task (Maybe [Container])
- task_cpu :: Lens' Task (Maybe Text)
- task_createdAt :: Lens' Task (Maybe UTCTime)
- task_desiredStatus :: Lens' Task (Maybe Text)
- task_enableExecuteCommand :: Lens' Task (Maybe Bool)
- task_ephemeralStorage :: Lens' Task (Maybe EphemeralStorage)
- task_executionStoppedAt :: Lens' Task (Maybe UTCTime)
- task_group :: Lens' Task (Maybe Text)
- task_healthStatus :: Lens' Task (Maybe HealthStatus)
- task_inferenceAccelerators :: Lens' Task (Maybe [InferenceAccelerator])
- task_lastStatus :: Lens' Task (Maybe Text)
- task_launchType :: Lens' Task (Maybe LaunchType)
- task_memory :: Lens' Task (Maybe Text)
- task_overrides :: Lens' Task (Maybe TaskOverride)
- task_platformFamily :: Lens' Task (Maybe Text)
- task_platformVersion :: Lens' Task (Maybe Text)
- task_pullStartedAt :: Lens' Task (Maybe UTCTime)
- task_pullStoppedAt :: Lens' Task (Maybe UTCTime)
- task_startedAt :: Lens' Task (Maybe UTCTime)
- task_startedBy :: Lens' Task (Maybe Text)
- task_stopCode :: Lens' Task (Maybe TaskStopCode)
- task_stoppedAt :: Lens' Task (Maybe UTCTime)
- task_stoppedReason :: Lens' Task (Maybe Text)
- task_stoppingAt :: Lens' Task (Maybe UTCTime)
- task_tags :: Lens' Task (Maybe [Tag])
- task_taskArn :: Lens' Task (Maybe Text)
- task_taskDefinitionArn :: Lens' Task (Maybe Text)
- task_version :: Lens' Task (Maybe Integer)
Documentation
Details on a task in a cluster.
See: newTask
smart constructor.
Task' | |
|
Instances
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 incrementsThis option requires Linux platform
1.4.0
or later.16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB incrementsThis 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]) Source #
The Elastic Network Adapter that's associated with the task if the task
uses the awsvpc
network mode.
task_capacityProviderName :: Lens' Task (Maybe Text) Source #
The capacity provider that's associated with the task.
task_connectivity :: Lens' Task (Maybe Connectivity) Source #
The connectivity status of a task.
task_connectivityAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the task last went into CONNECTED
status.
task_containerInstanceArn :: Lens' Task (Maybe Text) Source #
The ARN of the container instances that host the task.
task_containers :: Lens' Task (Maybe [Container]) Source #
The containers that's associated with the task.
task_cpu :: Lens' Task (Maybe Text) Source #
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 incrementsThis option requires Linux platform
1.4.0
or later.16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB incrementsThis option requires Linux platform
1.4.0
or later.
task_createdAt :: Lens' Task (Maybe UTCTime) Source #
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) Source #
The desired status of the task. For more information, see Task Lifecycle.
task_enableExecuteCommand :: Lens' Task (Maybe Bool) Source #
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) Source #
The ephemeral storage settings for the task.
task_executionStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the task execution stopped.
task_group :: Lens' Task (Maybe Text) Source #
The name of the task group that's associated with the task.
task_healthStatus :: Lens' Task (Maybe HealthStatus) Source #
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]) Source #
The Elastic Inference accelerator that's associated with the task.
task_lastStatus :: Lens' Task (Maybe Text) Source #
The last known status for the task. For more information, see Task Lifecycle.
task_launchType :: Lens' Task (Maybe LaunchType) Source #
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) Source #
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) Source #
One or more container overrides.
task_platformFamily :: Lens' Task (Maybe Text) Source #
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) Source #
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) Source #
The Unix timestamp for the time when the container image pull began.
task_pullStoppedAt :: Lens' Task (Maybe UTCTime) Source #
The Unix timestamp for the time when the container image pull completed.
task_startedAt :: Lens' Task (Maybe UTCTime) Source #
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) Source #
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) Source #
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) Source #
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_stoppingAt :: Lens' Task (Maybe UTCTime) Source #
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]) Source #
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_taskDefinitionArn :: Lens' Task (Maybe Text) Source #
The ARN of the task definition that creates the task.
task_version :: Lens' Task (Maybe Integer) Source #
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.