ListListeners
List the listeners for an accelerator.
Request Syntax
{
"AcceleratorArn": "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.
- AcceleratorArn
-
The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
- MaxResults
-
The number of listener 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
{
"Listeners": [
{
"ClientAffinity": "string",
"ListenerArn": "string",
"PortRanges": [
{
"FromPort": number,
"ToPort": number
}
],
"Protocol": "string"
}
],
"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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AcceleratorNotFoundException
-
The accelerator 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
- InvalidNextTokenException
-
There isn't another item to return.
HTTP Status Code: 400
Examples
List listeners
The following is an example for listing the listeners for an accelerator, and the response.
aws globalaccelerator list-listeners --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh --region us-west-2
{
"Listeners": [
{
"ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234",
"PortRanges": [
{
"FromPort": 80,
"ToPort": 80
}
],
"Protocol": "TCP",
"ClientAffinity": "NONE"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
