Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListEndpointGroups

List the endpoint groups that are associated with a listener.

Request Syntax


{
   "ListenerArn": "string",
   "MaxResults": number,
   "NextToken": "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.

ListenerArn

The Amazon Resource Name (ARN) of the listener.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

MaxResults

The number of endpoint group objects that you want to return with this call. The default value is 10.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token for the next set of results. You receive this token from a previous call.

Type: String

Length Constraints: Maximum length of 255.

Required: No

Response Syntax


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

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.

EndpointGroups

The list of the endpoint groups associated with a listener.

Type: Array of EndpointGroup objects

NextToken

The token for the next set of results. You receive this token from a previous call.

Type: String

Length Constraints: Maximum length of 255.

Errors

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

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

InvalidNextTokenException

There isn't another item to return.

HTTP Status Code: 400

ListenerNotFoundException

The listener that you specified doesn't exist.

HTTP Status Code: 400

Examples

List endpoint groups

The following is an example for listing the endpoint groups for listener, and the response.


aws globalaccelerator list-endpoint-groups 
         --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234
         --region us-west-2


{
    "EndpointGroups": [
        {
            "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab88888example",
            "EndpointGroupRegion": "eu-central-1",
            "EndpointDescriptions": [],
            "TrafficDialPercentage": 100.0,
            "HealthCheckPort": 80,
            "HealthCheckProtocol": "TCP",
            "HealthCheckIntervalSeconds": 30,
            "ThresholdCount": 3
        }
        {
            "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234/endpoint-group/ab99999example",
            "EndpointGroupRegion": "us-east-1",
            "EndpointDescriptions": [],
            "TrafficDialPercentage": 50.0,
            "HealthCheckPort": 80,
            "HealthCheckProtocol": "TCP",
            "HealthCheckIntervalSeconds": 30,
            "ThresholdCount": 3
        }
    ]
}