AWS Transfer for SFTP
User Guide

ListedServer

Returns properties of the server that was specified.

Contents

Arn

The unique Amazon Resource Name (ARN) for the server to be listed.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Required: Yes

EndpointType

The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.

Type: String

Valid Values: PUBLIC | VPC_ENDPOINT

Required: No

IdentityProviderType

The authentication method used to validate a user for the server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

Type: String

Valid Values: SERVICE_MANAGED | API_GATEWAY

Required: No

LoggingRole

The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.

Type: String

Pattern: arn:.*role/.*

Required: No

ServerId

This value is the unique system assigned identifier for the SFTP servers that were listed.

Type: String

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

Required: No

State

This property describes the condition of the SFTP server for the server that was described. A value of ONLINE> indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

Type: String

Valid Values: OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

Required: No

UserCount

This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId.

Type: Integer

Required: No

See Also

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

On this page: