ElasticLoadBalancing / Client / disable_availability_zones_for_load_balancer

disable_availability_zones_for_load_balancer#

ElasticLoadBalancing.Client.disable_availability_zones_for_load_balancer(**kwargs)#

Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.

There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.

For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.

See also: AWS API Documentation

Request Syntax

response = client.disable_availability_zones_for_load_balancer(
    LoadBalancerName='string',
    AvailabilityZones=[
        'string',
    ]
)
Parameters:

  • LoadBalancerName (string) –

    [REQUIRED]

    The name of the load balancer.

  • AvailabilityZones (list) –

    [REQUIRED]

    The Availability Zones.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AvailabilityZones': [
        'string',
    ]
}

Response Structure

  • (dict) –

    Contains the output for DisableAvailabilityZonesForLoadBalancer.

    • AvailabilityZones (list) –

      The remaining Availability Zones for the load balancer.

      • (string) –

Exceptions

  • ElasticLoadBalancing.Client.exceptions.AccessPointNotFoundException

  • ElasticLoadBalancing.Client.exceptions.InvalidConfigurationRequestException

Examples

This example removes the specified Availability Zone from the set of Availability Zones for the specified load balancer.

response = client.disable_availability_zones_for_load_balancer(
    AvailabilityZones=[
        'us-west-2a',
    ],
    LoadBalancerName='my-load-balancer',
)

print(response)

Expected Output:

{
    'AvailabilityZones': [
        'us-west-2b',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}