Describe a listener.
Request Syntax
{
"ListenerArn": "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 to describe.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
Response Syntax
{
"Listener": {
"ClientAffinity": "string",
"ListenerArn": "string",
"PortRanges": [
{
"FromPort": number,
"ToPort": number
}
],
"Protocol": "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.
- 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
- ListenerNotFoundException
-
The listener that you specified doesn't exist.
HTTP Status Code: 400
Examples
Describe a listener
The following is an example for describing a listener, and the response.
aws globalaccelerator describe-listener --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 --region us-west-2
{
"Listener": {
"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:
