NetworkManager / Paginator / GetLinkAssociations

GetLinkAssociations¶

class NetworkManager.Paginator.GetLinkAssociations¶

paginator = client.get_paginator('get_link_associations')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

GlobalNetworkId (string) –
[REQUIRED]

The ID of the global network.
DeviceId (string) – The ID of the device.
LinkId (string) – The ID of the link.
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

{
    'LinkAssociations': [
        {
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],

}

Response Structure

(dict) –
- LinkAssociations (list) –
  
  The link associations.
  - (dict) –
    
    Describes the association between a device and a link.
    - GlobalNetworkId (string) –
      
      The ID of the global network.
    - DeviceId (string) –
      
      The device ID for the link association.
    - LinkId (string) –
      
      The ID of the link.
    - LinkAssociationState (string) –
      
      The state of the association.