ListServers
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
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
-
Specifies the number of servers to return as a response to the
ListServersquery.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
When additional results are obtained from the
ListServerscommand, aNextTokenparameter is returned in the output. You can then pass theNextTokenparameter in a subsequent command to continue listing additional servers.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Required: No
Response Syntax
{
"NextToken": "string",
"Servers": [
{
"Arn": "string",
"Domain": "string",
"EndpointType": "string",
"IdentityProviderType": "string",
"LoggingRole": "string",
"ServerId": "string",
"State": "string",
"UserCount": number
}
]
}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.
- NextToken
-
When you can get additional results from the
ListServersoperation, aNextTokenparameter is returned in the output. In a following command, you can pass in theNextTokenparameter to continue listing additional servers.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
- Servers
-
An array of servers that were listed.
Type: Array of ListedServer objects
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
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
Examples
Example
The following example lists the servers that exist in your AWS account.
Note that the example NextToken values are not real: they are meant to indicate
how to use the parameter.
Sample Request
{
"MaxResults": 1,
"NextToken": "token-from-previous-API-call"
}Sample Response
{
"NextToken": "another-token-to-continue-listing",
"Servers": [
{
"Arn": "arn:aws:transfer:us-east-1:111112222222:server/s-01234567890abcdef",
"Domain": "S3",
"IdentityProviderType": "SERVICE_MANAGED",
"EndpointType": "PUBLIC",
"LoggingRole": "arn:aws:iam::111112222222:role/my-role",
"ServerId": "s-01234567890abcdef",
"State": "ONLINE",
"UserCount": 3
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
