ECS / Client / deregister_container_instance

deregister_container_instance

ECS.Client.deregister_container_instance(**kwargs)

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.

Note

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).

See also: AWS API Documentation

Request Syntax

response = client.deregister_container_instance(
    cluster='string',
    containerInstance='string',
    force=True|False
)

Parameters:

• cluster (string) – The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

• containerInstance (string) –

  [REQUIRED]

  The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

• force (boolean) –

  Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they’re orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

  Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

Return type:

dict

Returns:

Response Syntax

{
    'containerInstance': {
        'containerInstanceArn': 'string',
        'ec2InstanceId': 'string',
        'capacityProviderName': 'string',
        'version': 123,
        'versionInfo': {
            'agentVersion': 'string',
            'agentHash': 'string',
            'dockerVersion': 'string'
        },
        'remainingResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'registeredResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'status': 'string',
        'statusReason': 'string',
        'agentConnected': True|False,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED',
        'attributes': [
            {
                'name': 'string',
                'value': 'string',
                'targetType': 'container-instance',
                'targetId': 'string'
            },
        ],
        'registeredAt': datetime(2015, 1, 1),
        'attachments': [
            {
                'id': 'string',
                'type': 'string',
                'status': 'string',
                'details': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
        ],
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'healthStatus': {
            'overallStatus': 'OK'|'IMPAIRED'|'INSUFFICIENT_DATA'|'INITIALIZING',
            'details': [
                {
                    'type': 'CONTAINER_RUNTIME',
                    'status': 'OK'|'IMPAIRED'|'INSUFFICIENT_DATA'|'INITIALIZING',
                    'lastUpdated': datetime(2015, 1, 1),
                    'lastStatusChange': datetime(2015, 1, 1)
                },
            ]
        }
    }
}

Response Structure

• (dict) –

  • containerInstance (dict) –

    The container instance that was deregistered.

    • containerInstanceArn (string) –

      The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

    • ec2InstanceId (string) –

      The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

    • capacityProviderName (string) –

      The capacity provider that’s associated with the container instance.

    • version (integer) –

      The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you’re replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

    • versionInfo (dict) –

      The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

      • agentVersion (string) –

        The version number of the Amazon ECS container agent.

      • agentHash (string) –

        The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

      • dockerVersion (string) –

        The Docker version that’s running on the container instance.

    • remainingResources (list) –

      For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn’t already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that’s not specified here is available for new tasks.

      • (dict) –

        Describes the resources available for a container instance.

        • name (string) –

          The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

        • type (string) –

          The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.

        • doubleValue (float) –

          When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

        • longValue (integer) –

          When the longValue type is set, the value of the resource must be an extended precision floating-point type.

        • integerValue (integer) –

          When the integerValue type is set, the value of the resource must be an integer.

        • stringSetValue (list) –

          When the stringSetValue type is set, the value of the resource must be a string type.

          • (string) –

    • registeredResources (list) –

      For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

      • (dict) –

        Describes the resources available for a container instance.

        • name (string) –

          The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

        • type (string) –

          The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.

        • doubleValue (float) –

          When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

        • longValue (integer) –

          When the longValue type is set, the value of the resource must be an extended precision floating-point type.

        • integerValue (integer) –

          When the integerValue type is set, the value of the resource must be an integer.

        • stringSetValue (list) –

          When the stringSetValue type is set, the value of the resource must be a string type.

          • (string) –

    • status (string) –

      The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

      If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

      The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren’t placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container instance draining in the Amazon Elastic Container Service Developer Guide.

    • statusReason (string) –

      The reason that the container instance reached its current status.

    • agentConnected (boolean) –

      This parameter returns true if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept task placement requests.

    • runningTasksCount (integer) –

      The number of tasks on the container instance that have a desired status ( desiredStatus) of RUNNING.

    • pendingTasksCount (integer) –

      The number of tasks on the container instance that are in the PENDING status.

    • agentUpdateStatus (string) –

      The status of the most recent agent update. If an update wasn’t ever requested, this value is NULL.

    • attributes (list) –

      The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

      • (dict) –

        An attribute is a name-value pair that’s associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

        • name (string) –

          The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (), or periods (.).

        • value (string) –

          The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (), colons (:), or spaces. The value can’t start or end with a space.

        • targetType (string) –

          The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

        • targetId (string) –

          The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

    • registeredAt (datetime) –

      The Unix timestamp for the time when the container instance was registered.

    • attachments (list) –

      The resources attached to a container instance, such as an elastic network interface.

      • (dict) –

        An object representing a container instance or task attachment.

        • id (string) –

          The unique identifier for the attachment.

        • type (string) –

          The type of the attachment, such as ElasticNetworkInterface, Service Connect, and AmazonElasticBlockStorage.

        • status (string) –

          The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED, and FAILED.

        • details (list) –

          Details of the attachment.

          For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

          For Service Connect services, this includes portName, clientAliases, discoveryName, and ingressPortOverride.

          For elastic block storage, this includes roleArn, encrypted, filesystemType, iops, kmsKeyId, sizeInGiB, snapshotId, tagSpecifications, throughput, and volumeType.

          • (dict) –

            A key-value pair object.

            • name (string) –

              The name of the key-value pair. For environment variables, this is the name of the environment variable.

            • value (string) –

              The value of the key-value pair. For environment variables, this is the value of the environment variable.

    • tags (list) –

      The metadata that you apply to the container instance 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.

      • (dict) –

        The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

        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.

        • key (string) –

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value (string) –

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    • healthStatus (dict) –

      An object representing the health status of the container instance.

      • overallStatus (string) –

        The overall health status of the container instance. This is an aggregate status of all container instance health checks.

      • details (list) –

        An array of objects representing the details of the container instance health status.

        • (dict) –

          An object representing the result of a container instance health status check.

          • type (string) –

            The type of container instance health status that was verified.

          • status (string) –

            The container instance health status.

          • lastUpdated (datetime) –

            The Unix timestamp for when the container instance health status was last updated.

          • lastStatusChange (datetime) –

            The Unix timestamp for when the container instance health status last changed.

Exceptions

• ECS.Client.exceptions.ServerException

• ECS.Client.exceptions.ClientException

• ECS.Client.exceptions.InvalidParameterException

• ECS.Client.exceptions.ClusterNotFoundException

Examples

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.

response = client.deregister_container_instance(
    cluster='default',
    containerInstance='container_instance_UUID',
    force=True,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}