Class: Aws::ECS::Types::Task

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Details on a task in a cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachmentsArray<Types::Attachment>

The Elastic Network Adapter associated with the task if the task uses the `awsvpc` network mode.

Returns:


10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#attributesArray<Types::Attribute>

The attributes of the task

Returns:


10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zoneString

The availability zone of the task.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_provider_nameString

The capacity provider associated with the task.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arnString

The ARN of the cluster that hosts the task.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#connectivityString

The connectivity status of a task.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#connectivity_atTime

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

Returns:

  • (Time)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#container_instance_arnString

The ARN of the container instances that host the task.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#containersArray<Types::Container>

The containers associated with the task.

Returns:


10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#cpuString

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 indicating the CPU units when the task definition is registered.

If you are using 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 are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the `memory` parameter:

  • 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: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

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

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix timestamp for when the task was created (the task entered the `PENDING` state).

Returns:

  • (Time)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#desired_statusString

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

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#enable_execute_commandBoolean

Whether or not execute command functionality is enabled for this task. If `true`, this enables execute command functionality on all containers in the task.

Returns:

  • (Boolean)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#ephemeral_storageTypes::EphemeralStorage

The ephemeral storage settings for the task.


10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#execution_stopped_atTime

The Unix timestamp for when the task execution stopped.

Returns:

  • (Time)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#groupString

The name of the task group associated with the task.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#health_statusString

The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as `HEALTHY`, then the task status also reports as `HEALTHY`. If any essential containers in the task are reporting as `UNHEALTHY` or `UNKNOWN`, then the task status also reports as `UNHEALTHY` or `UNKNOWN`, accordingly.

<note markdown=“1”> The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.

</note>

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#inference_acceleratorsArray<Types::InferenceAccelerator>

The Elastic Inference accelerator associated with the task.

Returns:


10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#last_statusString

The last known status of the task. For more information, see [Task Lifecycle].

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#launch_typeString

The infrastructure on which your task is running. For more information, see [Amazon ECS launch types] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#memoryString

The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example `1024`. It can also be expressed as a string using GB, for example `1GB` or `1 GB`. String values are converted to an integer indicating the MiB when the task definition is registered.

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

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your 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)

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#overridesTypes::TaskOverride

One or more container overrides.

Returns:


10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#platform_versionString

The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the `LATEST` platform version is used by default. For more information, see [Fargate Platform Versions] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#pull_started_atTime

The Unix timestamp for when the container image pull began.

Returns:

  • (Time)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#pull_stopped_atTime

The Unix timestamp for when the container image pull completed.

Returns:

  • (Time)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#started_atTime

The Unix timestamp for when the task started (the task transitioned from the `PENDING` state to the `RUNNING` state).

Returns:

  • (Time)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#started_byString

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

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#stop_codeString

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

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#stopped_atTime

The Unix timestamp for when the task was stopped (the task transitioned from the `RUNNING` state to the `STOPPED` state).

Returns:

  • (Time)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#stopped_reasonString

The reason that the task was stopped.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#stopping_atTime

The Unix timestamp for when the task stops (transitions from the `RUNNING` state to `STOPPED`).

Returns:

  • (Time)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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.

Returns:


10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#task_arnString

The Amazon Resource Name (ARN) of the task.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#task_definition_arnString

The ARN of the task definition that creates the task.

Returns:

  • (String)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end

#versionInteger

The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating 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.

Returns:

  • (Integer)

10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
# File 'lib/aws-sdk-ecs/types.rb', line 10328

class Task < Struct.new(
  :attachments,
  :attributes,
  :availability_zone,
  :capacity_provider_name,
  :cluster_arn,
  :connectivity,
  :connectivity_at,
  :container_instance_arn,
  :containers,
  :cpu,
  :created_at,
  :desired_status,
  :enable_execute_command,
  :execution_stopped_at,
  :group,
  :health_status,
  :inference_accelerators,
  :last_status,
  :launch_type,
  :memory,
  :overrides,
  :platform_version,
  :pull_started_at,
  :pull_stopped_at,
  :started_at,
  :started_by,
  :stop_code,
  :stopped_at,
  :stopped_reason,
  :stopping_at,
  :tags,
  :task_arn,
  :task_definition_arn,
  :version,
  :ephemeral_storage)
  SENSITIVE = []
  include Aws::Structure
end