VPCLattice / Paginator / ListListeners
ListListeners#
- class VPCLattice.Paginator.ListListeners#
paginator = client.get_paginator('list_listeners')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
VPCLattice.Client.list_listeners()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( serviceIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
serviceIdentifier (string) –
[REQUIRED]
The ID or ARN of the service.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'port': 123, 'protocol': 'HTTP'|'HTTPS'|'TLS_PASSTHROUGH' }, ], '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.
createdAt (datetime) –
The date and time that the listener was created, in ISO-8601 format.
id (string) –
The ID of the listener.
lastUpdatedAt (datetime) –
The date and time that the listener was last updated, in ISO-8601 format.
name (string) –
The name of the listener.
port (integer) –
The listener port.
protocol (string) –
The listener protocol.
NextToken (string) –
A token to resume pagination.