AmazonECSClient.DeleteTaskDefinitions Method (DeleteTaskDefinitionsRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DeleteTaskDefinitionsAsync.

Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public virtual DeleteTaskDefinitionsResponse DeleteTaskDefinitions(
         DeleteTaskDefinitionsRequest request
)

Parameters

request: Type: Amazon.ECS.Model.DeleteTaskDefinitionsRequest

Container for the necessary parameters to execute the DeleteTaskDefinitions service method.

Return Value

Type: DeleteTaskDefinitionsResponse

The response from the DeleteTaskDefinitions service method, as returned by ECS.

Exceptions

Exception	Condition
AccessDeniedException	You don't have authorization to perform the requested action.
ClientException	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages.
ServerException	These errors are usually caused by a server issue.

Examples

This example deletes a specified deregistered task definition.

To delete a task definition that has been deregistered


var client = new AmazonECSClient();
var response = client.DeleteTaskDefinitions(new DeleteTaskDefinitionsRequest 
{
    TaskDefinitions = new List<string> {
        "Example-task-definition:1"
    }
});

List<Failure> failures = response.Failures;
List<TaskDefinition> taskDefinitions = response.TaskDefinitions;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.DeleteTaskDefinitions (DeleteTaskDefinitionsRequest)

Method