RemoveEndpoints
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
UpdateEndpointGroupAPI 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
UpdateEndpointGroupAPI operation, Global Accelerator must resolve all of the endpoints that remain in the group.
Request Syntax
{
"EndpointGroupArn": "string",
"EndpointIdentifiers": [
{
"ClientIPPreservationEnabled": boolean,
"EndpointId": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- EndpointGroupArn
-
The Amazon Resource Name (ARN) of the endpoint group.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
- EndpointIdentifiers
-
The identifiers of the endpoints that you want to remove.
Type: Array of EndpointIdentifier objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access permission.
HTTP Status Code: 400
- EndpointGroupNotFoundException
-
The endpoint group that you specified doesn't exist.
HTTP Status Code: 400
- InternalServiceErrorException
-
There was an internal error for AWS Global Accelerator.
HTTP Status Code: 400
- InvalidArgumentException
-
An argument that you specified is invalid.
HTTP Status Code: 400
- TransactionInProgressException
-
There's already a transaction in progress. Another transaction can't be processed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
