:doc:`NetworkManager <../../networkmanager>` / Paginator / GetConnections

**************
GetConnections
**************



.. py:class:: NetworkManager.Paginator.GetConnections

  ::

    
    paginator = client.get_paginator('get_connections')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`NetworkManager.Client.get_connections`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkmanager-2019-07-05/GetConnections>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          GlobalNetworkId='string',
          ConnectionIds=[
              'string',
          ],
          DeviceId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type GlobalNetworkId: string
    :param GlobalNetworkId: **[REQUIRED]** 

      The ID of the global network.

      

    
    :type ConnectionIds: list
    :param ConnectionIds: 

      One or more connection IDs.

      

    
      - *(string) --* 

      
  
    :type DeviceId: string
    :param DeviceId: 

      The ID of the device.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Connections': [
                {
                    'ConnectionId': 'string',
                    'ConnectionArn': 'string',
                    'GlobalNetworkId': 'string',
                    'DeviceId': 'string',
                    'ConnectedDeviceId': 'string',
                    'LinkId': 'string',
                    'ConnectedLinkId': 'string',
                    'Description': 'string',
                    'CreatedAt': datetime(2015, 1, 1),
                    'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Connections** *(list) --* 

          Information about the connections.

          
          

          - *(dict) --* 

            Describes a connection.

            
            

            - **ConnectionId** *(string) --* 

              The ID of the connection.

              
            

            - **ConnectionArn** *(string) --* 

              The Amazon Resource Name (ARN) of the connection.

              
            

            - **GlobalNetworkId** *(string) --* 

              The ID of the global network.

              
            

            - **DeviceId** *(string) --* 

              The ID of the first device in the connection.

              
            

            - **ConnectedDeviceId** *(string) --* 

              The ID of the second device in the connection.

              
            

            - **LinkId** *(string) --* 

              The ID of the link for the first device in the connection.

              
            

            - **ConnectedLinkId** *(string) --* 

              The ID of the link for the second device in the connection.

              
            

            - **Description** *(string) --* 

              The description of the connection.

              
            

            - **CreatedAt** *(datetime) --* 

              The date and time that the connection was created.

              
            

            - **State** *(string) --* 

              The state of the connection.

              
            

            - **Tags** *(list) --* 

              The tags for the connection.

              
              

              - *(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.

                  
            
          
        
      
    