}}
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.
Listener (p. 134)
Information for the updated listener for a custom routing accelerator.
Type: CustomRoutingListener (p. 165) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 186).
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 InvalidPortRangeException
The port numbers that you specified are not valid numbers or are not unique for this accelerator.
HTTP Status Code: 400 LimitExceededException
Processing your request would cause you to exceed an AWS Global Accelerator limit.
HTTP Status Code: 400 ListenerNotFoundException
The listener that you specified doesn't exist.
HTTP Status Code: 400
Examples
Update a listener for a custom routing accelerator
The following is an example of updating the port range for a listener for a custom routing accelerator, and the response.
aws globalaccelerator update-custom-routing-listener API Version 2018-08-08
135
See Also
--listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz
--port-ranges FromPort=5000,ToPort=10000
{ "Listener": {
"ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz
"PortRanges": [ {
"FromPort": 5000, "ToPort": 10000 }
],
"Protocol": "TCP", }
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateEndpointGroup
Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
Request Syntax
{ "EndpointConfigurations": [ {
"ClientIPPreservationEnabled": boolean, "EndpointId": "string",
"Weight": number }
],
"EndpointGroupArn": "string",
"HealthCheckIntervalSeconds": number, "HealthCheckPath": "string",
"HealthCheckPort": number, "HealthCheckProtocol": "string", "PortOverrides": [
"ThresholdCount": number, "TrafficDialPercentage": number }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 184).
The request accepts the following data in JSON format.
EndpointConfigurations (p. 137)
The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
Type: Array of EndpointConfiguration (p. 168) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
EndpointGroupArn (p. 137)
The Amazon Resource Name (ARN) of the endpoint group.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
HealthCheckIntervalSeconds (p. 137)
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
API Version 2018-08-08 137
Request Parameters
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 30.
Required: No
HealthCheckPath (p. 137)
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets.
The default value is slash (/).
Type: String
Length Constraints: Maximum length of 255.
Pattern: ^/[-a-zA-Z0-9@:%_\\+.~#?&/=]*$
Required: No
HealthCheckPort (p. 137)
The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
HealthCheckProtocol (p. 137)
The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
Type: String
Valid Values: TCP | HTTP | HTTPS Required: No
PortOverrides (p. 137)
Override specific listener ports used to route traffic to endpoints that are part of this 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 Port overrides in the AWS Global Accelerator Developer Guide.
Type: Array of PortOverride (p. 180) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No ThresholdCount (p. 137)
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
TrafficDialPercentage (p. 137)
The percentage of traffic to send to an AWS 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.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
"EndpointGroupArn": "string", "EndpointGroupRegion": "string", "HealthCheckIntervalSeconds": number, "HealthCheckPath": "string",
"HealthCheckPort": number, "HealthCheckProtocol": "string", "PortOverrides": [
"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.
EndpointGroup (p. 139)
The information about the endpoint group that was updated.
Type: EndpointGroup (p. 172) object
API Version 2018-08-08 139
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 186).
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 LimitExceededException
Processing your request would cause you to exceed an AWS Global Accelerator limit.
HTTP Status Code: 400