API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see

We welcome your feedback on this new version of the documentation. Send your comments to


import ""

type DescribedServer struct { Arn *string `min:"20" type:"string" required:"true"` IdentityProviderDetails *IdentityProviderDetails `type:"structure"` IdentityProviderType *string `type:"string" enum:"IdentityProviderType"` LoggingRole *string `type:"string"` ServerId *string `type:"string"` State *string `type:"string" enum:"State"` Tags []*Tag `min:"1" type:"list"` UserCount *int64 `type:"integer"` }

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.


Type: *string

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

Arn is a required field


Returns information related to the type of user authentication that is in use for a server's users. A server can only have one method of authentication.


Type: *string

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

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

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


Type: *string

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.


Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.


Type: *int64

The number of users that are assigned to the SFTP server you specified with the ServerId.



func (s DescribedServer) GoString() string

GoString returns the string representation


func (s *DescribedServer) SetArn(v string) *DescribedServer

SetArn sets the Arn field's value.


func (s *DescribedServer) SetIdentityProviderDetails(v *IdentityProviderDetails) *DescribedServer

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.


func (s *DescribedServer) SetIdentityProviderType(v string) *DescribedServer

SetIdentityProviderType sets the IdentityProviderType field's value.


func (s *DescribedServer) SetLoggingRole(v string) *DescribedServer

SetLoggingRole sets the LoggingRole field's value.


func (s *DescribedServer) SetServerId(v string) *DescribedServer

SetServerId sets the ServerId field's value.


func (s *DescribedServer) SetState(v string) *DescribedServer

SetState sets the State field's value.


func (s *DescribedServer) SetTags(v []*Tag) *DescribedServer

SetTags sets the Tags field's value.


func (s *DescribedServer) SetUserCount(v int64) *DescribedServer

SetUserCount sets the UserCount field's value.


func (s DescribedServer) String() string

String returns the string representation

On this page: