ListConnectors
Lists the connectors for the specified Region.
Request Syntax
{
"MaxResults": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of items to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
When you can get additional results from the
ListConnectorscall, aNextTokenparameter is returned in the output. You can then pass in a subsequent command to theNextTokenparameter to continue listing additional connectors.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Required: No
Response Syntax
{
"Connectors": [
{
"Arn": "string",
"ConnectorId": "string",
"Url": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Connectors
-
Returns an array, where each item contains the details of a connector.
Type: Array of ListedConnector objects
- NextToken
-
Returns a token that you can use to call
ListConnectorsagain and receive additional results, if there are any.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
This exception is thrown when an error occurs in the AWS Transfer Family service.
HTTP Status Code: 500
- InvalidNextTokenException
-
The
NextTokenparameter that was passed is invalid.HTTP Status Code: 400
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when a resource is not found by the AWSTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
