AWS Transfer for SFTP
User Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeServer

Describes the server that you specify by passing the ServerId parameter.

The response contains a description of the server's properties.

Request Syntax

{ "ServerId": "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.

ServerId

A system-assigned unique identifier for an SFTP server.

Type: String

Pattern: ^s-([0-9a-f]{17})$

Required: Yes

Response Syntax

{ "Server": { "Arn": "string", "EndpointDetails": { "VpcEndpointId": "string" }, "EndpointType": "string", "HostKeyFingerprint": "string", "IdentityProviderDetails": { "InvocationRole": "string", "Url": "string" }, "IdentityProviderType": "string", "LoggingRole": "string", "ServerId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "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.

Server

An array containing the properties of the server with the ServerID you specified.

Type: DescribedServer object

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 for SFTP service.

HTTP Status Code: 500

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 AWS Transfer for SFTP service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWS Transfer for SFTP service is not available.

HTTP Status Code: 500

Examples

Example

The following example returns the properties assigned to a Secure File Transfer Protocol (SFTP) server.

Sample Request

{ "ServerId": "s-01234567890abcdef" }

Example

Sample Response

{ "Server": { "Arn": "arn:aws:trasfer:us-east-1:176354371281:server/s-01234567890abcdef", "IdentityProviderDetails": "MyIdentityProvider", "IdentityProviderType": "SERVICE_MANAGED" "InvocationRole": "MyRole, "LoggingRole": "CloudWatchLoggingRole", "ServerId": "s-01234567890abcdef", "State": "ONLINE", "Tags": [ { "Key": "Name", "Value": "MySFTPServer" } ] } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: