Transfer / Client / list_connectors

list_connectors#

Transfer.Client.list_connectors(**kwargs)#

Lists the connectors for the specified Region.

Request Syntax

response = client.list_connectors(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The maximum number of connectors to return.
NextToken (string) – 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.

Return type:

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.

Exceptions

Transfer.Client.exceptions.ServiceUnavailableException
Transfer.Client.exceptions.InternalServiceError
Transfer.Client.exceptions.InvalidNextTokenException
Transfer.Client.exceptions.InvalidRequestException
Transfer.Client.exceptions.ResourceNotFoundException