:doc:`NetworkManager <../../networkmanager>` / Client / list_connect_peers

******************
list_connect_peers
******************



.. py:method:: NetworkManager.Client.list_connect_peers(**kwargs)

  

  Returns a list of core network Connect peers.

  

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


  **Request Syntax**
  ::

    response = client.list_connect_peers(
        CoreNetworkId='string',
        ConnectAttachmentId='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type CoreNetworkId: string
  :param CoreNetworkId: 

    The ID of a core network.

    

  
  :type ConnectAttachmentId: string
  :param ConnectAttachmentId: 

    The ID of the attachment.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next page of results.

    

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

    
    ::

      {
          'ConnectPeers': [
              {
                  'CoreNetworkId': 'string',
                  'ConnectAttachmentId': 'string',
                  'ConnectPeerId': 'string',
                  'EdgeLocation': 'string',
                  'ConnectPeerState': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
                  'CreatedAt': datetime(2015, 1, 1),
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ],
                  'SubnetArn': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ConnectPeers** *(list) --* 

        Describes the Connect peers.

        
        

        - *(dict) --* 

          Summary description of a Connect peer.

          
          

          - **CoreNetworkId** *(string) --* 

            The ID of a core network.

            
          

          - **ConnectAttachmentId** *(string) --* 

            The ID of a Connect peer attachment.

            
          

          - **ConnectPeerId** *(string) --* 

            The ID of a Connect peer.

            
          

          - **EdgeLocation** *(string) --* 

            The Region where the edge is located.

            
          

          - **ConnectPeerState** *(string) --* 

            The state of a Connect peer.

            
          

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

            The timestamp when a Connect peer was created.

            
          

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

            The list of key-value tags associated with the Connect peer 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.

                
          
        
          

          - **SubnetArn** *(string) --* 

            The subnet ARN for the Connect peer summary.

            
      
    
      

      - **NextToken** *(string) --* 

        The token for the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`NetworkManager.Client.exceptions.ValidationException`

  
  *   :py:class:`NetworkManager.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ThrottlingException`

  
  *   :py:class:`NetworkManager.Client.exceptions.InternalServerException`

  