GlobalAccelerator / Client / list_endpoint_groups

list_endpoint_groups#

GlobalAccelerator.Client.list_endpoint_groups(**kwargs)#

List the endpoint groups that are associated with a listener.

Request Syntax

response = client.list_endpoint_groups(
    ListenerArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

ListenerArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the listener.
MaxResults (integer) – The number of endpoint group objects that you want to return with this call. The default value is 10.
NextToken (string) – The token for the next set of results. You receive this token from a previous call.

Return type:

dict

Returns:

Response Syntax

{
    'EndpointGroups': [
        {
            'EndpointGroupArn': 'string',
            'EndpointGroupRegion': 'string',
            'EndpointDescriptions': [
                {
                    'EndpointId': 'string',
                    'Weight': 123,
                    'HealthState': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
                    'HealthReason': 'string',
                    'ClientIPPreservationEnabled': True|False
                },
            ],
            'TrafficDialPercentage': ...,
            'HealthCheckPort': 123,
            'HealthCheckProtocol': 'TCP'|'HTTP'|'HTTPS',
            'HealthCheckPath': 'string',
            'HealthCheckIntervalSeconds': 123,
            'ThresholdCount': 123,
            'PortOverrides': [
                {
                    'ListenerPort': 123,
                    'EndpointPort': 123
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- EndpointGroups (list) –
  
  The list of the endpoint groups associated with a listener.
  - (dict) –
    
    A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.
    - EndpointGroupArn (string) –
      
      The Amazon Resource Name (ARN) of the endpoint group.
    - EndpointGroupRegion (string) –
      
      The Amazon Web Services Region where the endpoint group is located.
    - EndpointDescriptions (list) –
      
      The list of endpoint objects.
      - (dict) –
        
        A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
        
        EndpointId (string) –
        
        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.
        
        Weight (integer) –
        
        The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint weights in the Global Accelerator Developer Guide.
        
        HealthState (string) –
        
        The health status of the endpoint.
        
        HealthReason (string) –
        
        Returns a null result.
        
        ClientIPPreservationEnabled (boolean) –
        
        Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for new accelerators.
        
        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.
        
        Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.
        
        For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
    - TrafficDialPercentage (float) –
      
      The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.
      
      Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
      
      The default value is 100.
    - HealthCheckPort (integer) –
      
      The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
      
      The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
    - HealthCheckProtocol (string) –
      
      The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
    - HealthCheckPath (string) –
      
      If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
    - HealthCheckIntervalSeconds (integer) –
      
      The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
    - ThresholdCount (integer) –
      
      The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
    - PortOverrides (list) –
      
      Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.
      - (dict) –
        
        Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
        
        For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
        
        ListenerPort (integer) –
        
        The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
        
        EndpointPort (integer) –
        
        The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
- NextToken (string) –
  
  The token for the next set of results. You receive this token from a previous call.

Exceptions

GlobalAccelerator.Client.exceptions.ListenerNotFoundException
GlobalAccelerator.Client.exceptions.InvalidNextTokenException
GlobalAccelerator.Client.exceptions.InvalidArgumentException
GlobalAccelerator.Client.exceptions.InternalServiceErrorException