Skip to content

describe_tasks

Operation

describe_tasks

describe_tasks(request: DescribeTasksInput | DescribeTasksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTasksInputDict]) -> DescribeTasksOutput

Describes a specified task or tasks.

Currently, stopped tasks appear in the returned results for at least one hour.

If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.

Parameters:

Name Type Description Default
request DescribeTasksInput | DescribeTasksInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeTasksInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTasksOutput

An instance of DescribeTasksOutput.

describe_tasks async

describe_tasks(request: DescribeTasksInput | DescribeTasksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTasksInputDict]) -> DescribeTasksOutput

Describes a specified task or tasks.

Currently, stopped tasks appear in the returned results for at least one hour.

If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.

Parameters:

Name Type Description Default
request DescribeTasksInput | DescribeTasksInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeTasksInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTasksOutput

An instance of DescribeTasksOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeTasksInputDict

Bases: TypedDict

Dictionary form of DescribeTasksInput.

Attributes

cluster instance-attribute
cluster: str | None

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed.

include instance-attribute
include: Sequence[str] | None

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

tasks instance-attribute

A list of up to 100 task IDs or full ARN entries.

DescribeTasksInput dataclass

Bases: _SerdeShape

Attributes

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed.

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

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

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

A list of up to 100 task IDs or full ARN entries.

Output

DescribeTasksOutput dataclass

Bases: _SerdeShape

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.

tasks class-attribute instance-attribute
tasks: list[Task] | None = ...

The list of tasks.