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 an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).
For .NET Core this operation is only available in asynchronous form. Please refer to DeregisterContainerInstanceAsync.
Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z
public virtual DeregisterContainerInstanceResponse DeregisterContainerInstance( DeregisterContainerInstanceRequest request )
Container for the necessary parameters to execute the DeregisterContainerInstance service method.
| 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. |
| ClusterNotFoundException | The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. |
| 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. |
This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.
var client = new AmazonECSClient();
var response = client.DeregisterContainerInstance(new DeregisterContainerInstanceRequest
{
Cluster = "default",
ContainerInstance = "container_instance_UUID",
Force = true
});
.NET Framework:
Supported in: 4.5, 4.0, 3.5