AWS Transfer for SFTP
User Guide

DescribedServer

Describe the properties of the server that was specified. Information returned includes: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, server Id and state, and assigned tags or metadata.

Contents

Arn

Specifies the unique Amazon Resource Name (ARN) for the server to be described.

Type: String

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

Required: Yes

IdentityProviderDetails

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.

Type: IdentityProviderDetails object

Required: No

IdentityProviderType

This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED, means that you are using this Server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Type: String

Valid Values: SERVICE_MANAGED | API_GATEWAY

Required: No

LoggingRole

This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.

Type: String

Pattern: arn:.*role/.*

Required: No

ServerId

This property is a unique system assigned identifier for the SFTP server that you instantiate.

Type: String

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

Required: No

State

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 indicated 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

Tags

This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

UserCount

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: