Skip to content

ECS  >  Operations  >  describe_task_sets

describe_task_sets

Operation

describe_task_sets async

describe_task_sets(input: DescribeTaskSetsInput, plugins: list[Plugin] | None = None) -> DescribeTaskSetsOutput

Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Parameters:

Name Type Description Default
input DescribeTaskSetsInput

An instance of DescribeTaskSetsInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeTaskSetsOutput

An instance of DescribeTaskSetsOutput.

Input

DescribeTaskSetsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeTaskSetsInput structure.

Attributes

cluster class-attribute instance-attribute
cluster: str | None = ...

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

include class-attribute instance-attribute
include: list[str] | None = ...

Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

service class-attribute instance-attribute
service: str | None = ...

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

task_sets class-attribute instance-attribute
task_sets: list[str] | None = ...

The ID or full Amazon Resource Name (ARN) of task sets to describe.

Output

DescribeTaskSetsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeTaskSetsOutput structure.

Attributes

failures class-attribute instance-attribute
failures: list[Failure] | None = ...

Any failures associated with the call.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

task_sets class-attribute instance-attribute
task_sets: list[TaskSet] | None = ...

The list of task sets described.