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

UpdateCustomRoutingListener

Update a listener for a custom routing accelerator.

Request Syntax


{
   "ListenerArn": "string",
   "PortRanges": [ 
      { 
         "FromPort": number,
         "ToPort": number
      }
   ]
}

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 to update.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

PortRanges

The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails.

Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

Type: Array of PortRange objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax


{
   "Listener": { 
      "ListenerArn": "string",
      "PortRanges": [ 
         { 
            "FromPort": number,
            "ToPort": 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.

Listener

Information for the updated listener for a custom routing accelerator.

Type: CustomRoutingListener object

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

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
    --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",
    }
}