VPCLattice / Client / list_listeners

list_listeners¶

VPCLattice.Client.list_listeners(**kwargs)¶

Lists the listeners for the specified service.

Request Syntax

response = client.list_listeners(
    serviceIdentifier='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

serviceIdentifier (string) –
[REQUIRED]

The ID or ARN of the service.
maxResults (integer) – The maximum number of results to return.
nextToken (string) – A pagination token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'protocol': 'HTTP'|'HTTPS'|'TLS_PASSTHROUGH',
            'port': 123,
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  Information about the listeners.
  - (dict) –
    
    Summary information about a listener.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the listener.
    - id (string) –
      
      The ID of the listener.
    - name (string) –
      
      The name of the listener.
    - protocol (string) –
      
      The listener protocol.
    - port (integer) –
      
      The listener port.
    - createdAt (datetime) –
      
      The date and time that the listener was created, in ISO-8601 format.
    - lastUpdatedAt (datetime) –
      
      The date and time that the listener was last updated, in ISO-8601 format.
- nextToken (string) –
  
  If there are additional results, a pagination token for the next page of results.

Exceptions

VPCLattice.Client.exceptions.ValidationException
VPCLattice.Client.exceptions.AccessDeniedException
VPCLattice.Client.exceptions.ResourceNotFoundException
VPCLattice.Client.exceptions.ThrottlingException
VPCLattice.Client.exceptions.InternalServerException