AWS SDK for Go (PILOT)
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 https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ListedServer

import "github.com/aws/aws-sdk-go/service/transfer"

type ListedServer struct { Arn *string `min:"20" type:"string" required:"true"` IdentityProviderType *string `type:"string" enum:"IdentityProviderType"` LoggingRole *string `type:"string"` ServerId *string `type:"string"` State *string `type:"string" enum:"State"` UserCount *int64 `type:"integer"` }

Returns properties of the server that was specified.

Arn

Type: *string

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

Arn is a required field

IdentityProviderType

Type: *string

The authentication method used to validate a user for the server that was specified. listed. 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.

LoggingRole

Type: *string

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

ServerId

Type: *string

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

State

Type: *string

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

UserCount

Type: *int64

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

Method

GoString

func (s ListedServer) GoString() string

GoString returns the string representation

SetArn

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

SetArn sets the Arn field's value.

SetIdentityProviderType

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

SetIdentityProviderType sets the IdentityProviderType field's value.

SetLoggingRole

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

SetLoggingRole sets the LoggingRole field's value.

SetServerId

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

SetServerId sets the ServerId field's value.

SetState

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

SetState sets the State field's value.

SetUserCount

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

SetUserCount sets the UserCount field's value.

String

func (s ListedServer) String() string

String returns the string representation

On this page: