Skip to content

ECS  >  Operations  >  describe_task_definition

describe_task_definition

Operation

describe_task_definition async 

describe_task_definition(input: DescribeTaskDefinitionInput, plugins: list[Plugin] | None = None) -> DescribeTaskDefinitionOutput

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

Note

You can only describe INACTIVE task definitions while an active task or service references them.

Parameters:

Name Type Description Default
input DescribeTaskDefinitionInput

An instance of DescribeTaskDefinitionInput.

 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
DescribeTaskDefinitionOutput

An instance of DescribeTaskDefinitionOutput.

Input

DescribeTaskDefinitionInput dataclass

Bases: _SerdeShape

Attributes

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

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

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

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

Output

DescribeTaskDefinitionOutput dataclass

Bases: _SerdeShape

Attributes

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.

tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

The metadata that's applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

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_definition class-attribute instance-attribute 
task_definition: TaskDefinition | None = ...

The full task definition description.