:doc:`Transfer <../../transfer>` / Client / list_connectors

***************
list_connectors
***************



.. py:method:: Transfer.Client.list_connectors(**kwargs)

  

  Lists the connectors for the specified Region.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListConnectors>`_  


  **Request Syntax**
  ::

    response = client.list_connectors(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of items to return.

    

  
  :type NextToken: string
  :param NextToken: 

    When you can get additional results from the ``ListConnectors`` call, a ``NextToken`` parameter is returned in the output. You can then pass in a subsequent command to the ``NextToken`` parameter to continue listing additional connectors.

    

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

    
    ::

      {
          'NextToken': 'string',
          'Connectors': [
              {
                  'Arn': 'string',
                  'ConnectorId': 'string',
                  'Url': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        Returns a token that you can use to call ``ListConnectors`` again and receive additional results, if there are any.

        
      

      - **Connectors** *(list) --* 

        Returns an array, where each item contains the details of a connector.

        
        

        - *(dict) --* 

          Returns details of the connector that is specified.

          
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the specified connector.

            
          

          - **ConnectorId** *(string) --* 

            The unique identifier for the connector.

            
          

          - **Url** *(string) --* 

            The URL of the partner's AS2 or SFTP endpoint.

             

            When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Transfer.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Transfer.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Transfer.Client.exceptions.InternalServiceError`

  
  *   :py:class:`Transfer.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`Transfer.Client.exceptions.InvalidNextTokenException`

  