deregisterInstancesFromLoadBalancer method

Future<DeregisterEndPointsOutput> deregisterInstancesFromLoadBalancer({
  1. required List<Instance> instances,
  2. required String loadBalancerName,
})

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.

May throw AccessPointNotFoundException. May throw InvalidEndPointException.

Parameter instances : The IDs of the instances.

Parameter loadBalancerName : The name of the load balancer.

Implementation

Future<DeregisterEndPointsOutput> deregisterInstancesFromLoadBalancer({
  required List<Instance> instances,
  required String loadBalancerName,
}) async {
  ArgumentError.checkNotNull(instances, 'instances');
  ArgumentError.checkNotNull(loadBalancerName, 'loadBalancerName');
  final $request = <String, dynamic>{};
  $request['Instances'] = instances;
  $request['LoadBalancerName'] = loadBalancerName;
  final $result = await _protocol.send(
    $request,
    action: 'DeregisterInstancesFromLoadBalancer',
    version: '2012-06-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DeregisterEndPointsInput'],
    shapes: shapes,
    resultWrapper: 'DeregisterInstancesFromLoadBalancerResult',
  );
  return DeregisterEndPointsOutput.fromXml($result);
}