AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Deregisters the specified task definition by family and revision. Upon deregistration,
the task definition is marked as INACTIVE
. Existing tasks and services that
reference an INACTIVE
task definition continue to run without disruption. Existing
services that reference an INACTIVE
task definition can still scale up or down
by modifying the service's desired count. If you want to delete a task definition
revision, you must first deregister the task definition revision.
You can't use an INACTIVE
task definition to run new tasks or create new services,
and you can't update an existing service to reference an INACTIVE
task definition.
However, there may be up to a 10-minute window following deregistration where these
restrictions have not yet taken effect.
At this time, INACTIVE
task definitions remain discoverable in your account
indefinitely. However, this behavior is subject to change in the future. We don't
recommend that you rely on INACTIVE
task definitions persisting beyond the
lifecycle of any associated tasks and services.
You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeregisterTaskDefinition and EndDeregisterTaskDefinition.
Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z
public virtual Task<DeregisterTaskDefinitionResponse> DeregisterTaskDefinitionAsync( DeregisterTaskDefinitionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DeregisterTaskDefinition service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
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. The following list includes additional causes for the error: The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas. |
InvalidParameterException | The specified parameter isn't valid. Review the available parameters for the API request. |
ServerException | These errors are usually caused by a server issue. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer