remove_endpoints

GlobalAccelerator.Client.remove_endpoints(**kwargs)

Remove endpoints from an endpoint group.

The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead:

• It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group.
• It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.

See also: AWS API Documentation

Request Syntax

response = client.remove_endpoints(
    EndpointIdentifiers=[
        {
            'EndpointId': 'string',
            'ClientIPPreservationEnabled': True|False
        },
    ],
    EndpointGroupArn='string'
)

Parameters

• EndpointIdentifiers (list) --

  [REQUIRED]

  The identifiers of the endpoints that you want to remove.

  • (dict) --

    A complex type for an endpoint. Specifies information about the endpoint to remove from the endpoint group.

    • EndpointId (string) -- [REQUIRED]

      An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

      An Application Load Balancer can be either internal or internet-facing.

    • ClientIPPreservationEnabled (boolean) --

      Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.

      If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.

• EndpointGroupArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the endpoint group.

Returns

None

Exceptions

• GlobalAccelerator.Client.exceptions.EndpointGroupNotFoundException
• GlobalAccelerator.Client.exceptions.InternalServiceErrorException
• GlobalAccelerator.Client.exceptions.InvalidArgumentException
• GlobalAccelerator.Client.exceptions.AccessDeniedException
• GlobalAccelerator.Client.exceptions.TransactionInProgressException