AWS Global Accelerator
API Reference (API Version 2018-08-08)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Describe an endpoint group.

Request Syntax

{ "EndpointGroupArn": "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.


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

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax

{ "EndpointGroup": { "EndpointDescriptions": [ { "ClientIPPreservationEnabled": boolean, "EndpointId": "string", "HealthReason": "string", "HealthState": "string", "Weight": number } ], "EndpointGroupArn": "string", "EndpointGroupRegion": "string", "HealthCheckIntervalSeconds": number, "HealthCheckPath": "string", "HealthCheckPort": number, "HealthCheckProtocol": "string", "ThresholdCount": number, "TrafficDialPercentage": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The description of an endpoint group.

Type: EndpointGroup object


For information about the errors that are common to all actions, see Common Errors.


The endpoint group that you specified doesn't exist.

HTTP Status Code: 400


There was an internal error for AWS Global Accelerator.

HTTP Status Code: 400


An argument that you specified is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: