ElasticLoadBalancing / Client / deregister_instances_from_load_balancer

deregister_instances_from_load_balancer

ElasticLoadBalancing.Client.deregister_instances_from_load_balancer(**kwargs)

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.

See also: AWS API Documentation

Request Syntax

response = client.deregister_instances_from_load_balancer(
    LoadBalancerName='string',
    Instances=[
        {
            'InstanceId': 'string'
        },
    ]
)

Parameters:

• LoadBalancerName (string) –

  [REQUIRED]

  The name of the load balancer.

• Instances (list) –

  [REQUIRED]

  The IDs of the instances.

  • (dict) –

    The ID of an EC2 instance.

    • InstanceId (string) –

      The instance ID.

Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'InstanceId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  Contains the output of DeregisterInstancesFromLoadBalancer.

  • Instances (list) –

    The remaining instances registered with the load balancer.

    • (dict) –

      The ID of an EC2 instance.

      • InstanceId (string) –

        The instance ID.

Exceptions

• ElasticLoadBalancing.Client.exceptions.AccessPointNotFoundException

• ElasticLoadBalancing.Client.exceptions.InvalidEndPointException

Examples

This example deregisters the specified instance from the specified load balancer.

response = client.deregister_instances_from_load_balancer(
    Instances=[
        {
            'InstanceId': 'i-d6f6fae3',
        },
    ],
    LoadBalancerName='my-load-balancer',
)

print(response)

Expected Output:

{
    'Instances': [
        {
            'InstanceId': 'i-207d9717',
        },
        {
            'InstanceId': 'i-afefb49b',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}