Skip to content

ECS  >  Operations  >  delete_task_definitions

delete_task_definitions

Operation

delete_task_definitions async

delete_task_definitions(input: DeleteTaskDefinitionsInput, plugins: list[Plugin] | None = None) -> DeleteTaskDefinitionsOutput

Deletes one or more task definitions.

You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service's desired count.

You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition revision.

A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.

When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.

Parameters:

Name Type Description Default
input DeleteTaskDefinitionsInput

An instance of DeleteTaskDefinitionsInput.

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
DeleteTaskDefinitionsOutput

An instance of DeleteTaskDefinitionsOutput.

Input

DeleteTaskDefinitionsInput dataclass

Bases: _SerdeShape

Dataclass for DeleteTaskDefinitionsInput structure.

Attributes

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

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to delete. You must specify a revision.

You can specify up to 10 task definitions as a comma separated list.

Output

DeleteTaskDefinitionsOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteTaskDefinitionsOutput 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_definitions class-attribute instance-attribute
task_definitions: list[TaskDefinition] | None = ...

The list of deleted task definitions.