NetworkManager / Paginator / ListCoreNetworks

ListCoreNetworks#

class NetworkManager.Paginator.ListCoreNetworks#

paginator = client.get_paginator('list_core_networks')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from NetworkManager.Client.list_core_networks().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'CoreNetworks': [
        {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'GlobalNetworkId': 'string',
            'OwnerAccountId': 'string',
            'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING',
            'Description': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

(dict) –
- CoreNetworks (list) –
  
  Describes the list of core networks.
  - (dict) –
    
    Returns summary information about a core network.
    - CoreNetworkId (string) –
      
      The ID of a core network.
    - CoreNetworkArn (string) –
      
      a core network ARN.
    - GlobalNetworkId (string) –
      
      The global network ID.
    - OwnerAccountId (string) –
      
      The ID of the account owner.
    - State (string) –
      
      The state of a core network.
    - Description (string) –
      
      The description of a core network.
    - Tags (list) –
      
      The key-value tags associated with a core network summary.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) –
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.