LambdaCore / Paginator / ListNetworkConnectors

ListNetworkConnectors¶

class LambdaCore.Paginator.ListNetworkConnectors¶

paginator = client.get_paginator('list_network_connectors')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from LambdaCore.Client.list_network_connectors().

Request Syntax

response_iterator = paginator.paginate(
    State='PENDING'|'ACTIVE'|'INACTIVE'|'FAILED'|'DELETING'|'DELETE_FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

State (string) – Optional filter to return only connectors in the specified state (for example, ACTIVE or FAILED).
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

{
    'NetworkConnectors': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Id': 'string',
            'Type': 'VPC_EGRESS',
            'State': 'PENDING'|'ACTIVE'|'INACTIVE'|'FAILED'|'DELETING'|'DELETE_FAILED',
            'LastModified': datetime(2015, 1, 1),
            'LatestVersionArn': 'string',
            'LatestVersion': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- NetworkConnectors (list) –
  
  A list of network connector summaries for the current page of results.
  - (dict) –
    
    Summary information about a network connector returned by ListNetworkConnectors. Contains identifying fields and current state. To retrieve full configuration details, use GetNetworkConnector.
    - Arn (string) –
      
      The ARN of the network connector.
    - Name (string) –
      
      The name of the network connector.
    - Id (string) –
      
      The unique identifier of the network connector.
    - Type (string) –
      
      The type of the network connector ( VPC_EGRESS).
    - State (string) –
      
      The current state of the network connector.
    - LastModified (datetime) –
      
      The date and time when the connector was last modified.
    - LatestVersionArn (string) –
      
      The qualified ARN of the connector’s latest version, including the immutable version suffix.
    - LatestVersion (integer) –
      
      The version number of the connector’s latest version. Each configuration update creates a new immutable version; this attribute exposes the most recent one.
- NextToken (string) –
  
  A token to resume pagination.