aws-sdk-go: github.com/aws/aws-sdk-go/service/transfer Index | Files | Directories

package transfer

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

Package transfer provides the client and types for making API requests to AWS Transfer for SFTP.

AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and setup.

See https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05 for more information on this service.

See transfer package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/transfer/

Using the Client

To contact AWS Transfer for SFTP with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Transfer for SFTP client Transfer for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/transfer/#New

Index

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // EndpointTypePublic is a EndpointType enum value
    EndpointTypePublic = "PUBLIC"

    // EndpointTypeVpcEndpoint is a EndpointType enum value
    EndpointTypeVpcEndpoint = "VPC_ENDPOINT"
)
const (
    // IdentityProviderTypeServiceManaged is a IdentityProviderType enum value
    IdentityProviderTypeServiceManaged = "SERVICE_MANAGED"

    // IdentityProviderTypeApiGateway is a IdentityProviderType enum value
    IdentityProviderTypeApiGateway = "API_GATEWAY"
)

Returns information related to the type of user authentication that is in use for a server's users. For SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on an SFTP server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. A server can only have one method of authentication.

const (
    // StateOffline is a State enum value
    StateOffline = "OFFLINE"

    // StateOnline is a State enum value
    StateOnline = "ONLINE"

    // StateStarting is a State enum value
    StateStarting = "STARTING"

    // StateStopping is a State enum value
    StateStopping = "STOPPING"

    // StateStartFailed is a State enum value
    StateStartFailed = "START_FAILED"

    // StateStopFailed is a State enum value
    StateStopFailed = "STOP_FAILED"
)

Describes the condition of the SFTP server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

OFFLINE indicates that the SFTP server exists, but that it is not available for file operations. ONLINE indicates that the SFTP server is available to perform file operations. STARTING indicates that the SFTP server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for an SFTP server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

const (

    // ErrCodeInternalServiceError for service response error code
    // "InternalServiceError".
    //
    // This exception is thrown when an error occurs in the AWS Transfer for SFTP
    // service.
    ErrCodeInternalServiceError = "InternalServiceError"

    // ErrCodeInvalidNextTokenException for service response error code
    // "InvalidNextTokenException".
    //
    // The NextToken parameter that was passed is invalid.
    ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

    // ErrCodeInvalidRequestException for service response error code
    // "InvalidRequestException".
    //
    // This exception is thrown when the client submits a malformed request.
    ErrCodeInvalidRequestException = "InvalidRequestException"

    // ErrCodeResourceExistsException for service response error code
    // "ResourceExistsException".
    //
    // The requested resource does not exist.
    ErrCodeResourceExistsException = "ResourceExistsException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // This exception is thrown when a resource is not found by the AWS Transfer
    // for SFTP service.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeServiceUnavailableException for service response error code
    // "ServiceUnavailableException".
    //
    // The request has failed because the AWS Transfer for SFTP service is not available.
    ErrCodeServiceUnavailableException = "ServiceUnavailableException"
)
const (
    ServiceName = "Transfer" // Name of service.
    EndpointsID = "transfer" // ID to lookup a service endpoint with.
    ServiceID   = "Transfer" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type CreateServerInput Uses

type CreateServerInput struct {

    // The virtual private cloud (VPC) endpoint settings that you want to configure
    // for your SFTP server.
    EndpointDetails *EndpointDetails `type:"structure"`

    // The type of VPC endpoint that you want your SFTP server connect to. If you
    // connect to a VPC endpoint, your SFTP server isn't accessible over the public
    // internet.
    EndpointType *string `type:"string" enum:"EndpointType"`

    // The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key
    // command.
    //
    // If you aren't planning to migrate existing users from an existing SFTP server
    // to a new AWS SFTP server, don't update the host key. Accidentally changing
    // a server's host key can be disruptive. For more information, see change-host-key
    // in the AWS SFTP User Guide.
    HostKey *string `type:"string"`

    // An array containing all of the information required to call a customer-supplied
    // authentication API. This parameter is not required when the IdentityProviderType
    // value of server that is created uses the SERVICE_MANAGED authentication method.
    IdentityProviderDetails *IdentityProviderDetails `type:"structure"`

    // The mode of authentication enabled for this service. The default value is
    // SERVICE_MANAGED, which allows you to store and access SFTP user credentials
    // within the service. An IdentityProviderType value of API_GATEWAY indicates
    // that user authentication requires a call to an API Gateway endpoint URL provided
    // by you to integrate an identity provider of your choice.
    IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`

    // A value that allows the service to write your SFTP users' activity to your
    // Amazon CloudWatch logs for monitoring and auditing purposes.
    LoggingRole *string `type:"string"`

    // Key-value pairs that can be used to group and search for servers.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

func (CreateServerInput) GoString Uses

func (s CreateServerInput) GoString() string

GoString returns the string representation

func (*CreateServerInput) SetEndpointDetails Uses

func (s *CreateServerInput) SetEndpointDetails(v *EndpointDetails) *CreateServerInput

SetEndpointDetails sets the EndpointDetails field's value.

func (*CreateServerInput) SetEndpointType Uses

func (s *CreateServerInput) SetEndpointType(v string) *CreateServerInput

SetEndpointType sets the EndpointType field's value.

func (*CreateServerInput) SetHostKey Uses

func (s *CreateServerInput) SetHostKey(v string) *CreateServerInput

SetHostKey sets the HostKey field's value.

func (*CreateServerInput) SetIdentityProviderDetails Uses

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

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.

func (*CreateServerInput) SetIdentityProviderType Uses

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

SetIdentityProviderType sets the IdentityProviderType field's value.

func (*CreateServerInput) SetLoggingRole Uses

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

SetLoggingRole sets the LoggingRole field's value.

func (*CreateServerInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (CreateServerInput) String Uses

func (s CreateServerInput) String() string

String returns the string representation

func (*CreateServerInput) Validate Uses

func (s *CreateServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateServerOutput Uses

type CreateServerOutput struct {

    // The service-assigned ID of the SFTP server that is created.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateServerOutput) GoString Uses

func (s CreateServerOutput) GoString() string

GoString returns the string representation

func (*CreateServerOutput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (CreateServerOutput) String Uses

func (s CreateServerOutput) String() string

String returns the string representation

type CreateUserInput Uses

type CreateUserInput struct {

    // The landing directory (folder) for a user when they log in to the server
    // using their SFTP client. An example is /home/username .
    HomeDirectory *string `type:"string"`

    // A scope-down policy for your user so you can use the same IAM role across
    // multiple users. This policy scopes down user access to portions of their
    // Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName},
    // ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
    Policy *string `type:"string"`

    // The IAM role that controls your user's access to your Amazon S3 bucket. The
    // policies attached to this role will determine the level of access you want
    // to provide your users when transferring files into and out of your Amazon
    // S3 bucket or buckets. The IAM role should also contain a trust relationship
    // that allows the SFTP server to access your resources when servicing your
    // SFTP user's transfer requests.
    //
    // Role is a required field
    Role *string `type:"string" required:"true"`

    // A system-assigned unique identifier for an SFTP server instance. This is
    // the specific SFTP server that you added your user to.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // The public portion of the Secure Shall (SSH) key used to authenticate the
    // user to the SFTP server.
    SshPublicKeyBody *string `type:"string"`

    // Key-value pairs that can be used to group and search for users. Tags are
    // metadata attached to users for any purpose.
    Tags []*Tag `min:"1" type:"list"`

    // A unique string that identifies a user and is associated with a server as
    // specified by the ServerId. This user name must be a minimum of 3 and a maximum
    // of 32 characters long. The following are valid characters: a-z, A-Z, 0-9,
    // underscore, and hyphen. The user name can't start with a hyphen.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateUserInput) GoString Uses

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (*CreateUserInput) SetHomeDirectory Uses

func (s *CreateUserInput) SetHomeDirectory(v string) *CreateUserInput

SetHomeDirectory sets the HomeDirectory field's value.

func (*CreateUserInput) SetPolicy Uses

func (s *CreateUserInput) SetPolicy(v string) *CreateUserInput

SetPolicy sets the Policy field's value.

func (*CreateUserInput) SetRole Uses

func (s *CreateUserInput) SetRole(v string) *CreateUserInput

SetRole sets the Role field's value.

func (*CreateUserInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*CreateUserInput) SetSshPublicKeyBody Uses

func (s *CreateUserInput) SetSshPublicKeyBody(v string) *CreateUserInput

SetSshPublicKeyBody sets the SshPublicKeyBody field's value.

func (*CreateUserInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*CreateUserInput) SetUserName Uses

func (s *CreateUserInput) SetUserName(v string) *CreateUserInput

SetUserName sets the UserName field's value.

func (CreateUserInput) String Uses

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate Uses

func (s *CreateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateUserOutput Uses

type CreateUserOutput struct {

    // The ID of the SFTP server that the user is attached to.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // A unique string that identifies a user account associated with an SFTP server.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateUserOutput) GoString Uses

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (*CreateUserOutput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*CreateUserOutput) SetUserName Uses

func (s *CreateUserOutput) SetUserName(v string) *CreateUserOutput

SetUserName sets the UserName field's value.

func (CreateUserOutput) String Uses

func (s CreateUserOutput) String() string

String returns the string representation

type DeleteServerInput Uses

type DeleteServerInput struct {

    // A unique system-assigned identifier for an SFTP server instance.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteServerInput) GoString Uses

func (s DeleteServerInput) GoString() string

GoString returns the string representation

func (*DeleteServerInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (DeleteServerInput) String Uses

func (s DeleteServerInput) String() string

String returns the string representation

func (*DeleteServerInput) Validate Uses

func (s *DeleteServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteServerOutput Uses

type DeleteServerOutput struct {
    // contains filtered or unexported fields
}

func (DeleteServerOutput) GoString Uses

func (s DeleteServerOutput) GoString() string

GoString returns the string representation

func (DeleteServerOutput) String Uses

func (s DeleteServerOutput) String() string

String returns the string representation

type DeleteSshPublicKeyInput Uses

type DeleteSshPublicKeyInput struct {

    // A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP)
    // server instance that has the user assigned to it.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // A unique identifier used to reference your user's specific SSH key.
    //
    // SshPublicKeyId is a required field
    SshPublicKeyId *string `type:"string" required:"true"`

    // A unique string that identifies a user whose public key is being deleted.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteSshPublicKeyInput) GoString Uses

func (s DeleteSshPublicKeyInput) GoString() string

GoString returns the string representation

func (*DeleteSshPublicKeyInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*DeleteSshPublicKeyInput) SetSshPublicKeyId Uses

func (s *DeleteSshPublicKeyInput) SetSshPublicKeyId(v string) *DeleteSshPublicKeyInput

SetSshPublicKeyId sets the SshPublicKeyId field's value.

func (*DeleteSshPublicKeyInput) SetUserName Uses

func (s *DeleteSshPublicKeyInput) SetUserName(v string) *DeleteSshPublicKeyInput

SetUserName sets the UserName field's value.

func (DeleteSshPublicKeyInput) String Uses

func (s DeleteSshPublicKeyInput) String() string

String returns the string representation

func (*DeleteSshPublicKeyInput) Validate Uses

func (s *DeleteSshPublicKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSshPublicKeyOutput Uses

type DeleteSshPublicKeyOutput struct {
    // contains filtered or unexported fields
}

func (DeleteSshPublicKeyOutput) GoString Uses

func (s DeleteSshPublicKeyOutput) GoString() string

GoString returns the string representation

func (DeleteSshPublicKeyOutput) String Uses

func (s DeleteSshPublicKeyOutput) String() string

String returns the string representation

type DeleteUserInput Uses

type DeleteUserInput struct {

    // A system-assigned unique identifier for an SFTP server instance that has
    // the user assigned to it.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // A unique string that identifies a user that is being deleted from the server.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteUserInput) GoString Uses

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (*DeleteUserInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*DeleteUserInput) SetUserName Uses

func (s *DeleteUserInput) SetUserName(v string) *DeleteUserInput

SetUserName sets the UserName field's value.

func (DeleteUserInput) String Uses

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate Uses

func (s *DeleteUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteUserOutput Uses

type DeleteUserOutput struct {
    // contains filtered or unexported fields
}

func (DeleteUserOutput) GoString Uses

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) String Uses

func (s DeleteUserOutput) String() string

String returns the string representation

type DescribeServerInput Uses

type DescribeServerInput struct {

    // A system-assigned unique identifier for an SFTP server.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeServerInput) GoString Uses

func (s DescribeServerInput) GoString() string

GoString returns the string representation

func (*DescribeServerInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (DescribeServerInput) String Uses

func (s DescribeServerInput) String() string

String returns the string representation

func (*DescribeServerInput) Validate Uses

func (s *DescribeServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeServerOutput Uses

type DescribeServerOutput struct {

    // An array containing the properties of the server with the ServerID you specified.
    //
    // Server is a required field
    Server *DescribedServer `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeServerOutput) GoString Uses

func (s DescribeServerOutput) GoString() string

GoString returns the string representation

func (*DescribeServerOutput) SetServer Uses

func (s *DescribeServerOutput) SetServer(v *DescribedServer) *DescribeServerOutput

SetServer sets the Server field's value.

func (DescribeServerOutput) String Uses

func (s DescribeServerOutput) String() string

String returns the string representation

type DescribeUserInput Uses

type DescribeUserInput struct {

    // A system-assigned unique identifier for an SFTP server that has this user
    // assigned.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // The name of the user assigned to one or more servers. User names are part
    // of the sign-in credentials to use the AWS Transfer service and perform file
    // transfer tasks.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeUserInput) GoString Uses

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (*DescribeUserInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*DescribeUserInput) SetUserName Uses

func (s *DescribeUserInput) SetUserName(v string) *DescribeUserInput

SetUserName sets the UserName field's value.

func (DescribeUserInput) String Uses

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate Uses

func (s *DescribeUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUserOutput Uses

type DescribeUserOutput struct {

    // A system-assigned unique identifier for an SFTP server that has this user
    // assigned.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // An array containing the properties of the user account for the ServerID value
    // that you specified.
    //
    // User is a required field
    User *DescribedUser `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeUserOutput) GoString Uses

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (*DescribeUserOutput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*DescribeUserOutput) SetUser Uses

func (s *DescribeUserOutput) SetUser(v *DescribedUser) *DescribeUserOutput

SetUser sets the User field's value.

func (DescribeUserOutput) String Uses

func (s DescribeUserOutput) String() string

String returns the string representation

type DescribedServer Uses

type DescribedServer struct {

    // Specifies the unique Amazon Resource Name (ARN) for the server to be described.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // The virtual private cloud (VPC) endpoint settings that you configured for
    // your SFTP server.
    EndpointDetails *EndpointDetails `type:"structure"`

    // The type of 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.
    EndpointType *string `type:"string" enum:"EndpointType"`

    // This value contains the Message-Digest Algorithm (MD5) hash of the server's
    // host key. This value is equivalent to the output of ssh-keygen -l -E md5
    // -f my-new-server-key command.
    HostKeyFingerprint *string `type:"string"`

    // Specifies information to call a customer-supplied authentication API. This
    // field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
    IdentityProviderDetails *IdentityProviderDetails `type:"structure"`

    // 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.
    IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`

    // 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.
    LoggingRole *string `type:"string"`

    // This property is a unique system assigned identifier for the SFTP server
    // that you instantiate.
    ServerId *string `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.
    State *string `type:"string" enum:"State"`

    // 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.
    Tags []*Tag `min:"1" type:"list"`

    // The number of users that are assigned to the SFTP server you specified with
    // the ServerId.
    UserCount *int64 `type:"integer"`
    // contains filtered or unexported fields
}

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.

func (DescribedServer) GoString Uses

func (s DescribedServer) GoString() string

GoString returns the string representation

func (*DescribedServer) SetArn Uses

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

SetArn sets the Arn field's value.

func (*DescribedServer) SetEndpointDetails Uses

func (s *DescribedServer) SetEndpointDetails(v *EndpointDetails) *DescribedServer

SetEndpointDetails sets the EndpointDetails field's value.

func (*DescribedServer) SetEndpointType Uses

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

SetEndpointType sets the EndpointType field's value.

func (*DescribedServer) SetHostKeyFingerprint Uses

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

SetHostKeyFingerprint sets the HostKeyFingerprint field's value.

func (*DescribedServer) SetIdentityProviderDetails Uses

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

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.

func (*DescribedServer) SetIdentityProviderType Uses

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

SetIdentityProviderType sets the IdentityProviderType field's value.

func (*DescribedServer) SetLoggingRole Uses

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

SetLoggingRole sets the LoggingRole field's value.

func (*DescribedServer) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*DescribedServer) SetState Uses

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

SetState sets the State field's value.

func (*DescribedServer) SetTags Uses

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

SetTags sets the Tags field's value.

func (*DescribedServer) SetUserCount Uses

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

SetUserCount sets the UserCount field's value.

func (DescribedServer) String Uses

func (s DescribedServer) String() string

String returns the string representation

type DescribedUser Uses

type DescribedUser struct {

    // This property contains the unique Amazon Resource Name (ARN) for the user
    // that was requested to be described.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // This property specifies the landing directory (or folder) which is the location
    // that files are written to or read from in an Amazon S3 bucket for the described
    // user. An example would be: /bucket_name/home/username .
    HomeDirectory *string `type:"string"`

    // Specifies the name of the policy in use for the described user.
    Policy *string `type:"string"`

    // This property specifies the IAM role that controls your user's access to
    // your Amazon S3 bucket. The policies attached to this role will determine
    // the level of access you want to provide your users when transferring files
    // into and out of your Amazon S3 bucket or buckets. The IAM role should also
    // contain a trust relationship that allows the SFTP server to access your resources
    // when servicing your SFTP user's transfer requests.
    Role *string `type:"string"`

    // This property contains the public key portion of the Secure Shell (SSH) keys
    // stored for the described user.
    SshPublicKeys []*SshPublicKey `type:"list"`

    // This property contains the key-value pairs for the user requested. Tag can
    // be used to search for and group users for a variety of purposes.
    Tags []*Tag `min:"1" type:"list"`

    // This property is the name of the user that was requested to be described.
    // User names are used for authentication purposes. This is the string that
    // will be used by your user when they log in to your SFTP server.
    UserName *string `type:"string"`
    // contains filtered or unexported fields
}

Returns properties of the user that you wish to describe.

func (DescribedUser) GoString Uses

func (s DescribedUser) GoString() string

GoString returns the string representation

func (*DescribedUser) SetArn Uses

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

SetArn sets the Arn field's value.

func (*DescribedUser) SetHomeDirectory Uses

func (s *DescribedUser) SetHomeDirectory(v string) *DescribedUser

SetHomeDirectory sets the HomeDirectory field's value.

func (*DescribedUser) SetPolicy Uses

func (s *DescribedUser) SetPolicy(v string) *DescribedUser

SetPolicy sets the Policy field's value.

func (*DescribedUser) SetRole Uses

func (s *DescribedUser) SetRole(v string) *DescribedUser

SetRole sets the Role field's value.

func (*DescribedUser) SetSshPublicKeys Uses

func (s *DescribedUser) SetSshPublicKeys(v []*SshPublicKey) *DescribedUser

SetSshPublicKeys sets the SshPublicKeys field's value.

func (*DescribedUser) SetTags Uses

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

SetTags sets the Tags field's value.

func (*DescribedUser) SetUserName Uses

func (s *DescribedUser) SetUserName(v string) *DescribedUser

SetUserName sets the UserName field's value.

func (DescribedUser) String Uses

func (s DescribedUser) String() string

String returns the string representation

type EndpointDetails Uses

type EndpointDetails struct {

    // The ID of the VPC endpoint.
    VpcEndpointId *string `type:"string"`
    // contains filtered or unexported fields
}

The configuration settings for the virtual private cloud (VPC) endpoint for your SFTP server.

func (EndpointDetails) GoString Uses

func (s EndpointDetails) GoString() string

GoString returns the string representation

func (*EndpointDetails) SetVpcEndpointId Uses

func (s *EndpointDetails) SetVpcEndpointId(v string) *EndpointDetails

SetVpcEndpointId sets the VpcEndpointId field's value.

func (EndpointDetails) String Uses

func (s EndpointDetails) String() string

String returns the string representation

type IdentityProviderDetails Uses

type IdentityProviderDetails struct {

    // The Role parameter provides the type of InvocationRole used to authenticate
    // the user account.
    InvocationRole *string `type:"string"`

    // The IdentityProviderDetail parameter contains the location of the service
    // endpoint used to authenticate users.
    Url *string `type:"string"`
    // contains filtered or unexported fields
}

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.

func (IdentityProviderDetails) GoString Uses

func (s IdentityProviderDetails) GoString() string

GoString returns the string representation

func (*IdentityProviderDetails) SetInvocationRole Uses

func (s *IdentityProviderDetails) SetInvocationRole(v string) *IdentityProviderDetails

SetInvocationRole sets the InvocationRole field's value.

func (*IdentityProviderDetails) SetUrl Uses

func (s *IdentityProviderDetails) SetUrl(v string) *IdentityProviderDetails

SetUrl sets the Url field's value.

func (IdentityProviderDetails) String Uses

func (s IdentityProviderDetails) String() string

String returns the string representation

type ImportSshPublicKeyInput Uses

type ImportSshPublicKeyInput struct {

    // A system-assigned unique identifier for an SFTP server.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // The public key portion of an SSH key pair.
    //
    // SshPublicKeyBody is a required field
    SshPublicKeyBody *string `type:"string" required:"true"`

    // The name of the user account that is assigned to one or more servers.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ImportSshPublicKeyInput) GoString Uses

func (s ImportSshPublicKeyInput) GoString() string

GoString returns the string representation

func (*ImportSshPublicKeyInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*ImportSshPublicKeyInput) SetSshPublicKeyBody Uses

func (s *ImportSshPublicKeyInput) SetSshPublicKeyBody(v string) *ImportSshPublicKeyInput

SetSshPublicKeyBody sets the SshPublicKeyBody field's value.

func (*ImportSshPublicKeyInput) SetUserName Uses

func (s *ImportSshPublicKeyInput) SetUserName(v string) *ImportSshPublicKeyInput

SetUserName sets the UserName field's value.

func (ImportSshPublicKeyInput) String Uses

func (s ImportSshPublicKeyInput) String() string

String returns the string representation

func (*ImportSshPublicKeyInput) Validate Uses

func (s *ImportSshPublicKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportSshPublicKeyOutput Uses

type ImportSshPublicKeyOutput struct {

    // A system-assigned unique identifier for an SFTP server.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // This identifier is the name given to a public key by the system that was
    // imported.
    //
    // SshPublicKeyId is a required field
    SshPublicKeyId *string `type:"string" required:"true"`

    // A user name assigned to the ServerID value that you specified.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

This response identifies the user, server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associate with.

func (ImportSshPublicKeyOutput) GoString Uses

func (s ImportSshPublicKeyOutput) GoString() string

GoString returns the string representation

func (*ImportSshPublicKeyOutput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*ImportSshPublicKeyOutput) SetSshPublicKeyId Uses

func (s *ImportSshPublicKeyOutput) SetSshPublicKeyId(v string) *ImportSshPublicKeyOutput

SetSshPublicKeyId sets the SshPublicKeyId field's value.

func (*ImportSshPublicKeyOutput) SetUserName Uses

func (s *ImportSshPublicKeyOutput) SetUserName(v string) *ImportSshPublicKeyOutput

SetUserName sets the UserName field's value.

func (ImportSshPublicKeyOutput) String Uses

func (s ImportSshPublicKeyOutput) String() string

String returns the string representation

type ListServersInput Uses

type ListServersInput struct {

    // Specifies the number of servers to return as a response to the ListServers
    // query.
    MaxResults *int64 `min:"1" type:"integer"`

    // When additional results are obtained from the ListServers command, a NextToken
    // parameter is returned in the output. You can then pass the NextToken parameter
    // in a subsequent command to continue listing additional servers.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListServersInput) GoString Uses

func (s ListServersInput) GoString() string

GoString returns the string representation

func (*ListServersInput) SetMaxResults Uses

func (s *ListServersInput) SetMaxResults(v int64) *ListServersInput

SetMaxResults sets the MaxResults field's value.

func (*ListServersInput) SetNextToken Uses

func (s *ListServersInput) SetNextToken(v string) *ListServersInput

SetNextToken sets the NextToken field's value.

func (ListServersInput) String Uses

func (s ListServersInput) String() string

String returns the string representation

func (*ListServersInput) Validate Uses

func (s *ListServersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListServersOutput Uses

type ListServersOutput struct {

    // When you can get additional results from the ListServers operation, a NextToken
    // parameter is returned in the output. In a following command, you can pass
    // in the NextToken parameter to continue listing additional servers.
    NextToken *string `min:"1" type:"string"`

    // An array of servers that were listed.
    //
    // Servers is a required field
    Servers []*ListedServer `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListServersOutput) GoString Uses

func (s ListServersOutput) GoString() string

GoString returns the string representation

func (*ListServersOutput) SetNextToken Uses

func (s *ListServersOutput) SetNextToken(v string) *ListServersOutput

SetNextToken sets the NextToken field's value.

func (*ListServersOutput) SetServers Uses

func (s *ListServersOutput) SetServers(v []*ListedServer) *ListServersOutput

SetServers sets the Servers field's value.

func (ListServersOutput) String Uses

func (s ListServersOutput) String() string

String returns the string representation

type ListTagsForResourceInput Uses

type ListTagsForResourceInput struct {

    // Requests the tags associated with a particular Amazon Resource Name (ARN).
    // An ARN is an identifier for a specific AWS resource, such as a server, user,
    // or role.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // Specifies the number of tags to return as a response to the ListTagsForResource
    // request.
    MaxResults *int64 `min:"1" type:"integer"`

    // When you request additional results from the ListTagsForResource call, a
    // NextToken parameter is returned in the input. You can then pass in a subsequent
    // command the NextToken parameter to continue listing additional tags.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString Uses

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*ListTagsForResourceInput) SetMaxResults Uses

func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken Uses

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (ListTagsForResourceInput) String Uses

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate Uses

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput Uses

type ListTagsForResourceOutput struct {

    // This value is the ARN you specified to list the tags of.
    Arn *string `min:"20" type:"string"`

    // When you can get additional results from the ListTagsForResource call, a
    // NextToken parameter is returned in the output. You can then pass in a subsequent
    // command the NextToken parameter to continue listing additional tags.
    NextToken *string `min:"1" type:"string"`

    // Key-value pairs that are assigned to a resource, usually for the purpose
    // of grouping and searching for items. Tags are metadata that you define that
    // you can use for any purpose.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString Uses

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*ListTagsForResourceOutput) SetNextToken Uses

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags Uses

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String Uses

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListUsersInput Uses

type ListUsersInput struct {

    // Specifies the number of users to return as a response to the ListUsers request.
    MaxResults *int64 `min:"1" type:"integer"`

    // When you can get additional results from the ListUsers call, a NextToken
    // parameter is returned in the output. You can then pass in a subsequent command
    // the NextToken parameter to continue listing additional users.
    NextToken *string `min:"1" type:"string"`

    // A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP)
    // server that has users are assigned to it.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListUsersInput) GoString Uses

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (*ListUsersInput) SetMaxResults Uses

func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken Uses

func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput

SetNextToken sets the NextToken field's value.

func (*ListUsersInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (ListUsersInput) String Uses

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate Uses

func (s *ListUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListUsersOutput Uses

type ListUsersOutput struct {

    // When you can get additional results from the ListUsers call, a NextToken
    // parameter is returned in the output. You can then pass in a subsequent command
    // the NextToken parameter to continue listing additional users.
    NextToken *string `min:"1" type:"string"`

    // A system-assigned unique identifier for an SFTP server that the users are
    // assigned to.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // Returns the user accounts and their properties for the ServerId value that
    // you specify.
    //
    // Users is a required field
    Users []*ListedUser `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListUsersOutput) GoString Uses

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (*ListUsersOutput) SetNextToken Uses

func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*ListUsersOutput) SetUsers Uses

func (s *ListUsersOutput) SetUsers(v []*ListedUser) *ListUsersOutput

SetUsers sets the Users field's value.

func (ListUsersOutput) String Uses

func (s ListUsersOutput) String() string

String returns the string representation

type ListedServer Uses

type ListedServer struct {

    // The unique Amazon Resource Name (ARN) for the server to be listed.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // 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.
    EndpointType *string `type:"string" enum:"EndpointType"`

    // 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.
    IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`

    // The AWS Identity and Access Management entity that allows the server to turn
    // on Amazon CloudWatch logging.
    LoggingRole *string `type:"string"`

    // This value is the unique system assigned identifier for the SFTP servers
    // that were listed.
    ServerId *string `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.
    State *string `type:"string" enum:"State"`

    // This property is a numeric value that indicates the number of users that
    // are assigned to the SFTP server you specified with the ServerId.
    UserCount *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Returns properties of the server that was specified.

func (ListedServer) GoString Uses

func (s ListedServer) GoString() string

GoString returns the string representation

func (*ListedServer) SetArn Uses

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

SetArn sets the Arn field's value.

func (*ListedServer) SetEndpointType Uses

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

SetEndpointType sets the EndpointType field's value.

func (*ListedServer) SetIdentityProviderType Uses

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

SetIdentityProviderType sets the IdentityProviderType field's value.

func (*ListedServer) SetLoggingRole Uses

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

SetLoggingRole sets the LoggingRole field's value.

func (*ListedServer) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*ListedServer) SetState Uses

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

SetState sets the State field's value.

func (*ListedServer) SetUserCount Uses

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

SetUserCount sets the UserCount field's value.

func (ListedServer) String Uses

func (s ListedServer) String() string

String returns the string representation

type ListedUser Uses

type ListedUser struct {

    // This property is the unique Amazon Resource Name (ARN) for the user that
    // you wish to learn about.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // This value specifies the location that files are written to or read from
    // an Amazon S3 bucket for the user you specify by their ARN.
    HomeDirectory *string `type:"string"`

    // The role in use by this user. A role is an AWS Identity and Access Management
    // (IAM) entity that in this case allows the SFTP server to act on a user's
    // behalf. It allows the server to inherit the trust relationship that enables
    // that user to perform file operations to their Amazon S3 bucket.
    Role *string `type:"string"`

    // This value is the number of SSH public keys stored for the user you specified.
    SshPublicKeyCount *int64 `type:"integer"`

    // The name of the user whose ARN was specified. User names are used for authentication
    // purposes.
    UserName *string `type:"string"`
    // contains filtered or unexported fields
}

Returns properties of the user that you specify.

func (ListedUser) GoString Uses

func (s ListedUser) GoString() string

GoString returns the string representation

func (*ListedUser) SetArn Uses

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

SetArn sets the Arn field's value.

func (*ListedUser) SetHomeDirectory Uses

func (s *ListedUser) SetHomeDirectory(v string) *ListedUser

SetHomeDirectory sets the HomeDirectory field's value.

func (*ListedUser) SetRole Uses

func (s *ListedUser) SetRole(v string) *ListedUser

SetRole sets the Role field's value.

func (*ListedUser) SetSshPublicKeyCount Uses

func (s *ListedUser) SetSshPublicKeyCount(v int64) *ListedUser

SetSshPublicKeyCount sets the SshPublicKeyCount field's value.

func (*ListedUser) SetUserName Uses

func (s *ListedUser) SetUserName(v string) *ListedUser

SetUserName sets the UserName field's value.

func (ListedUser) String Uses

func (s ListedUser) String() string

String returns the string representation

type SshPublicKey Uses

type SshPublicKey struct {

    // The date that the public key was added to the user account.
    //
    // DateImported is a required field
    DateImported *time.Time `type:"timestamp" required:"true"`

    // The content of the SSH public key as specified by the PublicKeyId.
    //
    // SshPublicKeyBody is a required field
    SshPublicKeyBody *string `type:"string" required:"true"`

    // The SshPublicKeyId parameter contains the identifier of the public key.
    //
    // SshPublicKeyId is a required field
    SshPublicKeyId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides information about the public Secure Shell (SSH) key that is associated with a user account for a specific server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific SFTP server.

func (SshPublicKey) GoString Uses

func (s SshPublicKey) GoString() string

GoString returns the string representation

func (*SshPublicKey) SetDateImported Uses

func (s *SshPublicKey) SetDateImported(v time.Time) *SshPublicKey

SetDateImported sets the DateImported field's value.

func (*SshPublicKey) SetSshPublicKeyBody Uses

func (s *SshPublicKey) SetSshPublicKeyBody(v string) *SshPublicKey

SetSshPublicKeyBody sets the SshPublicKeyBody field's value.

func (*SshPublicKey) SetSshPublicKeyId Uses

func (s *SshPublicKey) SetSshPublicKeyId(v string) *SshPublicKey

SetSshPublicKeyId sets the SshPublicKeyId field's value.

func (SshPublicKey) String Uses

func (s SshPublicKey) String() string

String returns the string representation

type StartServerInput Uses

type StartServerInput struct {

    // A system-assigned unique identifier for an SFTP server that you start.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (StartServerInput) GoString Uses

func (s StartServerInput) GoString() string

GoString returns the string representation

func (*StartServerInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (StartServerInput) String Uses

func (s StartServerInput) String() string

String returns the string representation

func (*StartServerInput) Validate Uses

func (s *StartServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartServerOutput Uses

type StartServerOutput struct {
    // contains filtered or unexported fields
}

func (StartServerOutput) GoString Uses

func (s StartServerOutput) GoString() string

GoString returns the string representation

func (StartServerOutput) String Uses

func (s StartServerOutput) String() string

String returns the string representation

type StopServerInput Uses

type StopServerInput struct {

    // A system-assigned unique identifier for an SFTP server that you stopped.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (StopServerInput) GoString Uses

func (s StopServerInput) GoString() string

GoString returns the string representation

func (*StopServerInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (StopServerInput) String Uses

func (s StopServerInput) String() string

String returns the string representation

func (*StopServerInput) Validate Uses

func (s *StopServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopServerOutput Uses

type StopServerOutput struct {
    // contains filtered or unexported fields
}

func (StopServerOutput) GoString Uses

func (s StopServerOutput) GoString() string

GoString returns the string representation

func (StopServerOutput) String Uses

func (s StopServerOutput) String() string

String returns the string representation

type Tag Uses

type Tag struct {

    // The name assigned to the tag that you create.
    //
    // Key is a required field
    Key *string `type:"string" required:"true"`

    // This property contains one or more values that you assigned to the key name
    // you create.
    //
    // Value is a required field
    Value *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

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.

func (Tag) GoString Uses

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey Uses

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue Uses

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String Uses

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate Uses

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput Uses

type TagResourceInput struct {

    // An Amazon Resource Name (ARN) for a specific AWS resource, such as a server,
    // user, or role.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // Key-value pairs assigned to ARNs that you can use to group and search for
    // resources by type. You can attach this metadata to user accounts for any
    // purpose.
    //
    // Tags is a required field
    Tags []*Tag `min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString Uses

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*TagResourceInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (TagResourceInput) String Uses

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate Uses

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput Uses

type TagResourceOutput struct {
    // contains filtered or unexported fields
}

func (TagResourceOutput) GoString Uses

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String Uses

func (s TagResourceOutput) String() string

String returns the string representation

type TestIdentityProviderInput Uses

type TestIdentityProviderInput struct {

    // A system assigned identifier for a specific server. That server's user authentication
    // method is tested with a user name and password.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // This request parameter is name of the user account to be tested.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`

    // The password of the user account to be tested.
    UserPassword *string `type:"string"`
    // contains filtered or unexported fields
}

func (TestIdentityProviderInput) GoString Uses

func (s TestIdentityProviderInput) GoString() string

GoString returns the string representation

func (*TestIdentityProviderInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*TestIdentityProviderInput) SetUserName Uses

func (s *TestIdentityProviderInput) SetUserName(v string) *TestIdentityProviderInput

SetUserName sets the UserName field's value.

func (*TestIdentityProviderInput) SetUserPassword Uses

func (s *TestIdentityProviderInput) SetUserPassword(v string) *TestIdentityProviderInput

SetUserPassword sets the UserPassword field's value.

func (TestIdentityProviderInput) String Uses

func (s TestIdentityProviderInput) String() string

String returns the string representation

func (*TestIdentityProviderInput) Validate Uses

func (s *TestIdentityProviderInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestIdentityProviderOutput Uses

type TestIdentityProviderOutput struct {

    // The result of the authorization test as a message.
    Message *string `type:"string"`

    // The HTTP status code that is the response from your API Gateway.
    //
    // StatusCode is a required field
    StatusCode *int64 `type:"integer" required:"true"`

    // The endpoint of the service used to authenticate a user.
    //
    // Url is a required field
    Url *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (TestIdentityProviderOutput) GoString Uses

func (s TestIdentityProviderOutput) GoString() string

GoString returns the string representation

func (*TestIdentityProviderOutput) SetMessage Uses

func (s *TestIdentityProviderOutput) SetMessage(v string) *TestIdentityProviderOutput

SetMessage sets the Message field's value.

func (*TestIdentityProviderOutput) SetStatusCode Uses

func (s *TestIdentityProviderOutput) SetStatusCode(v int64) *TestIdentityProviderOutput

SetStatusCode sets the StatusCode field's value.

func (*TestIdentityProviderOutput) SetUrl Uses

func (s *TestIdentityProviderOutput) SetUrl(v string) *TestIdentityProviderOutput

SetUrl sets the Url field's value.

func (TestIdentityProviderOutput) String Uses

func (s TestIdentityProviderOutput) String() string

String returns the string representation

type Transfer Uses

type Transfer struct {
    *client.Client
}

Transfer provides the API operation methods for making requests to AWS Transfer for SFTP. See this package's package overview docs for details on the service.

Transfer methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Transfer

New creates a new instance of the Transfer client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a Transfer client from just a session.
svc := transfer.New(mySession)

// Create a Transfer client with additional configuration
svc := transfer.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Transfer) CreateServer Uses

func (c *Transfer) CreateServer(input *CreateServerInput) (*CreateServerOutput, error)

CreateServer API operation for AWS Transfer for SFTP.

Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the ServerId property assigned by the service to the newly created server. Reference this ServerId property when you make updates to your server, or work with users.

The response returns the ServerId value for the newly created server.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation CreateServer for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceExistsException "ResourceExistsException"
The requested resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServer

func (*Transfer) CreateServerRequest Uses

func (c *Transfer) CreateServerRequest(input *CreateServerInput) (req *request.Request, output *CreateServerOutput)

CreateServerRequest generates a "aws/request.Request" representing the client's request for the CreateServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateServer for more information on using the CreateServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateServerRequest method.
req, resp := client.CreateServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServer

func (*Transfer) CreateServerWithContext Uses

func (c *Transfer) CreateServerWithContext(ctx aws.Context, input *CreateServerInput, opts ...request.Option) (*CreateServerOutput, error)

CreateServerWithContext is the same as CreateServer with the addition of the ability to pass a context and additional request options.

See CreateServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) CreateUser Uses

func (c *Transfer) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for AWS Transfer for SFTP.

Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

The response returns the UserName and ServerId values of the new user for that server.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation CreateUser for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceExistsException "ResourceExistsException"
The requested resource does not exist.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUser

func (*Transfer) CreateUserRequest Uses

func (c *Transfer) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUser for more information on using the CreateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateUserRequest method.
req, resp := client.CreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUser

func (*Transfer) CreateUserWithContext Uses

func (c *Transfer) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.

See CreateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) DeleteServer Uses

func (c *Transfer) DeleteServer(input *DeleteServerInput) (*DeleteServerOutput, error)

DeleteServer API operation for AWS Transfer for SFTP.

Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used SERVICE_MANAGED as your IdentityProviderType, you need to delete all users associated with this server before deleting the server itself

No response returns from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DeleteServer for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServer

func (*Transfer) DeleteServerRequest Uses

func (c *Transfer) DeleteServerRequest(input *DeleteServerInput) (req *request.Request, output *DeleteServerOutput)

DeleteServerRequest generates a "aws/request.Request" representing the client's request for the DeleteServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteServer for more information on using the DeleteServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteServerRequest method.
req, resp := client.DeleteServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServer

func (*Transfer) DeleteServerWithContext Uses

func (c *Transfer) DeleteServerWithContext(ctx aws.Context, input *DeleteServerInput, opts ...request.Option) (*DeleteServerOutput, error)

DeleteServerWithContext is the same as DeleteServer with the addition of the ability to pass a context and additional request options.

See DeleteServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) DeleteSshPublicKey Uses

func (c *Transfer) DeleteSshPublicKey(input *DeleteSshPublicKeyInput) (*DeleteSshPublicKeyOutput, error)

DeleteSshPublicKey API operation for AWS Transfer for SFTP.

Deletes a user's Secure Shell (SSH) public key.

No response is returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DeleteSshPublicKey for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKey

func (*Transfer) DeleteSshPublicKeyRequest Uses

func (c *Transfer) DeleteSshPublicKeyRequest(input *DeleteSshPublicKeyInput) (req *request.Request, output *DeleteSshPublicKeyOutput)

DeleteSshPublicKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteSshPublicKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSshPublicKey for more information on using the DeleteSshPublicKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSshPublicKeyRequest method.
req, resp := client.DeleteSshPublicKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKey

func (*Transfer) DeleteSshPublicKeyWithContext Uses

func (c *Transfer) DeleteSshPublicKeyWithContext(ctx aws.Context, input *DeleteSshPublicKeyInput, opts ...request.Option) (*DeleteSshPublicKeyOutput, error)

DeleteSshPublicKeyWithContext is the same as DeleteSshPublicKey with the addition of the ability to pass a context and additional request options.

See DeleteSshPublicKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) DeleteUser Uses

func (c *Transfer) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for AWS Transfer for SFTP.

Deletes the user belonging to the server you specify.

No response returns from this call.

When you delete a user from a server, the user's information is lost.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DeleteUser for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUser

func (*Transfer) DeleteUserRequest Uses

func (c *Transfer) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUser for more information on using the DeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUser

func (*Transfer) DeleteUserWithContext Uses

func (c *Transfer) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) DescribeServer Uses

func (c *Transfer) DescribeServer(input *DescribeServerInput) (*DescribeServerOutput, error)

DescribeServer API operation for AWS Transfer for SFTP.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DescribeServer for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer

func (*Transfer) DescribeServerRequest Uses

func (c *Transfer) DescribeServerRequest(input *DescribeServerInput) (req *request.Request, output *DescribeServerOutput)

DescribeServerRequest generates a "aws/request.Request" representing the client's request for the DescribeServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeServer for more information on using the DescribeServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeServerRequest method.
req, resp := client.DescribeServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer

func (*Transfer) DescribeServerWithContext Uses

func (c *Transfer) DescribeServerWithContext(ctx aws.Context, input *DescribeServerInput, opts ...request.Option) (*DescribeServerOutput, error)

DescribeServerWithContext is the same as DescribeServer with the addition of the ability to pass a context and additional request options.

See DescribeServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) DescribeUser Uses

func (c *Transfer) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)

DescribeUser API operation for AWS Transfer for SFTP.

Describes the user assigned to a specific server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DescribeUser for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUser

func (*Transfer) DescribeUserRequest Uses

func (c *Transfer) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)

DescribeUserRequest generates a "aws/request.Request" representing the client's request for the DescribeUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUser for more information on using the DescribeUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeUserRequest method.
req, resp := client.DescribeUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUser

func (*Transfer) DescribeUserWithContext Uses

func (c *Transfer) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)

DescribeUserWithContext is the same as DescribeUser with the addition of the ability to pass a context and additional request options.

See DescribeUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) ImportSshPublicKey Uses

func (c *Transfer) ImportSshPublicKey(input *ImportSshPublicKeyInput) (*ImportSshPublicKeyOutput, error)

ImportSshPublicKey API operation for AWS Transfer for SFTP.

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation ImportSshPublicKey for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceExistsException "ResourceExistsException"
The requested resource does not exist.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKey

func (*Transfer) ImportSshPublicKeyRequest Uses

func (c *Transfer) ImportSshPublicKeyRequest(input *ImportSshPublicKeyInput) (req *request.Request, output *ImportSshPublicKeyOutput)

ImportSshPublicKeyRequest generates a "aws/request.Request" representing the client's request for the ImportSshPublicKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportSshPublicKey for more information on using the ImportSshPublicKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ImportSshPublicKeyRequest method.
req, resp := client.ImportSshPublicKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKey

func (*Transfer) ImportSshPublicKeyWithContext Uses

func (c *Transfer) ImportSshPublicKeyWithContext(ctx aws.Context, input *ImportSshPublicKeyInput, opts ...request.Option) (*ImportSshPublicKeyOutput, error)

ImportSshPublicKeyWithContext is the same as ImportSshPublicKey with the addition of the ability to pass a context and additional request options.

See ImportSshPublicKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) ListServers Uses

func (c *Transfer) ListServers(input *ListServersInput) (*ListServersOutput, error)

ListServers API operation for AWS Transfer for SFTP.

Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation ListServers for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The NextToken parameter that was passed is invalid.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServers

func (*Transfer) ListServersPages Uses

func (c *Transfer) ListServersPages(input *ListServersInput, fn func(*ListServersOutput, bool) bool) error

ListServersPages iterates over the pages of a ListServers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListServers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListServers operation.
pageNum := 0
err := client.ListServersPages(params,
    func(page *transfer.ListServersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Transfer) ListServersPagesWithContext Uses

func (c *Transfer) ListServersPagesWithContext(ctx aws.Context, input *ListServersInput, fn func(*ListServersOutput, bool) bool, opts ...request.Option) error

ListServersPagesWithContext same as ListServersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) ListServersRequest Uses

func (c *Transfer) ListServersRequest(input *ListServersInput) (req *request.Request, output *ListServersOutput)

ListServersRequest generates a "aws/request.Request" representing the client's request for the ListServers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListServers for more information on using the ListServers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListServersRequest method.
req, resp := client.ListServersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServers

func (*Transfer) ListServersWithContext Uses

func (c *Transfer) ListServersWithContext(ctx aws.Context, input *ListServersInput, opts ...request.Option) (*ListServersOutput, error)

ListServersWithContext is the same as ListServers with the addition of the ability to pass a context and additional request options.

See ListServers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) ListTagsForResource Uses

func (c *Transfer) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Transfer for SFTP.

Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The NextToken parameter that was passed is invalid.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResource

func (*Transfer) ListTagsForResourcePages Uses

func (c *Transfer) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *transfer.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Transfer) ListTagsForResourcePagesWithContext Uses

func (c *Transfer) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) ListTagsForResourceRequest Uses

func (c *Transfer) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResource

func (*Transfer) ListTagsForResourceWithContext Uses

func (c *Transfer) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) ListUsers Uses

func (c *Transfer) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)

ListUsers API operation for AWS Transfer for SFTP.

Lists the users for the server that you specify by passing the ServerId parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation ListUsers for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The NextToken parameter that was passed is invalid.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsers

func (*Transfer) ListUsersPages Uses

func (c *Transfer) ListUsersPages(input *ListUsersInput, fn func(*ListUsersOutput, bool) bool) error

ListUsersPages iterates over the pages of a ListUsers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListUsers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListUsers operation.
pageNum := 0
err := client.ListUsersPages(params,
    func(page *transfer.ListUsersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Transfer) ListUsersPagesWithContext Uses

func (c *Transfer) ListUsersPagesWithContext(ctx aws.Context, input *ListUsersInput, fn func(*ListUsersOutput, bool) bool, opts ...request.Option) error

ListUsersPagesWithContext same as ListUsersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) ListUsersRequest Uses

func (c *Transfer) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)

ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListUsers for more information on using the ListUsers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListUsersRequest method.
req, resp := client.ListUsersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsers

func (*Transfer) ListUsersWithContext Uses

func (c *Transfer) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)

ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.

See ListUsers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) StartServer Uses

func (c *Transfer) StartServer(input *StartServerInput) (*StartServerOutput, error)

StartServer API operation for AWS Transfer for SFTP.

Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation StartServer for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServer

func (*Transfer) StartServerRequest Uses

func (c *Transfer) StartServerRequest(input *StartServerInput) (req *request.Request, output *StartServerOutput)

StartServerRequest generates a "aws/request.Request" representing the client's request for the StartServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartServer for more information on using the StartServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartServerRequest method.
req, resp := client.StartServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServer

func (*Transfer) StartServerWithContext Uses

func (c *Transfer) StartServerWithContext(ctx aws.Context, input *StartServerInput, opts ...request.Option) (*StartServerOutput, error)

StartServerWithContext is the same as StartServer with the addition of the ability to pass a context and additional request options.

See StartServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) StopServer Uses

func (c *Transfer) StopServer(input *StopServerInput) (*StopServerOutput, error)

StopServer API operation for AWS Transfer for SFTP.

Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

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

No response is returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation StopServer for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServer

func (*Transfer) StopServerRequest Uses

func (c *Transfer) StopServerRequest(input *StopServerInput) (req *request.Request, output *StopServerOutput)

StopServerRequest generates a "aws/request.Request" representing the client's request for the StopServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopServer for more information on using the StopServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopServerRequest method.
req, resp := client.StopServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServer

func (*Transfer) StopServerWithContext Uses

func (c *Transfer) StopServerWithContext(ctx aws.Context, input *StopServerInput, opts ...request.Option) (*StopServerOutput, error)

StopServerWithContext is the same as StopServer with the addition of the ability to pass a context and additional request options.

See StopServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) TagResource Uses

func (c *Transfer) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Transfer for SFTP.

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation TagResource for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResource

func (*Transfer) TagResourceRequest Uses

func (c *Transfer) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResource

func (*Transfer) TagResourceWithContext Uses

func (c *Transfer) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) TestIdentityProvider Uses

func (c *Transfer) TestIdentityProvider(input *TestIdentityProviderInput) (*TestIdentityProviderOutput, error)

TestIdentityProvider API operation for AWS Transfer for SFTP.

If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this method to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation TestIdentityProvider for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProvider

func (*Transfer) TestIdentityProviderRequest Uses

func (c *Transfer) TestIdentityProviderRequest(input *TestIdentityProviderInput) (req *request.Request, output *TestIdentityProviderOutput)

TestIdentityProviderRequest generates a "aws/request.Request" representing the client's request for the TestIdentityProvider operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestIdentityProvider for more information on using the TestIdentityProvider API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TestIdentityProviderRequest method.
req, resp := client.TestIdentityProviderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProvider

func (*Transfer) TestIdentityProviderWithContext Uses

func (c *Transfer) TestIdentityProviderWithContext(ctx aws.Context, input *TestIdentityProviderInput, opts ...request.Option) (*TestIdentityProviderOutput, error)

TestIdentityProviderWithContext is the same as TestIdentityProvider with the addition of the ability to pass a context and additional request options.

See TestIdentityProvider for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) UntagResource Uses

func (c *Transfer) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Transfer for SFTP.

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation UntagResource for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResource

func (*Transfer) UntagResourceRequest Uses

func (c *Transfer) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResource

func (*Transfer) UntagResourceWithContext Uses

func (c *Transfer) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) UpdateServer Uses

func (c *Transfer) UpdateServer(input *UpdateServerInput) (*UpdateServerOutput, error)

UpdateServer API operation for AWS Transfer for SFTP.

Updates the server properties after that server has been created.

The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation UpdateServer for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServer

func (*Transfer) UpdateServerRequest Uses

func (c *Transfer) UpdateServerRequest(input *UpdateServerInput) (req *request.Request, output *UpdateServerOutput)

UpdateServerRequest generates a "aws/request.Request" representing the client's request for the UpdateServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateServer for more information on using the UpdateServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateServerRequest method.
req, resp := client.UpdateServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServer

func (*Transfer) UpdateServerWithContext Uses

func (c *Transfer) UpdateServerWithContext(ctx aws.Context, input *UpdateServerInput, opts ...request.Option) (*UpdateServerOutput, error)

UpdateServerWithContext is the same as UpdateServer with the addition of the ability to pass a context and additional request options.

See UpdateServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Transfer) UpdateUser Uses

func (c *Transfer) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateUser API operation for AWS Transfer for SFTP.

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation UpdateUser for usage and error information.

Returned Error Codes:

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The request has failed because the AWS Transfer for SFTP service is not available.

* ErrCodeInternalServiceError "InternalServiceError"
This exception is thrown when an error occurs in the AWS Transfer for SFTP
service.

* ErrCodeInvalidRequestException "InvalidRequestException"
This exception is thrown when the client submits a malformed request.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when a resource is not found by the AWS Transfer
for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUser

func (*Transfer) UpdateUserRequest Uses

func (c *Transfer) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput)

UpdateUserRequest generates a "aws/request.Request" representing the client's request for the UpdateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUser for more information on using the UpdateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateUserRequest method.
req, resp := client.UpdateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUser

func (*Transfer) UpdateUserWithContext Uses

func (c *Transfer) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error)

UpdateUserWithContext is the same as UpdateUser with the addition of the ability to pass a context and additional request options.

See UpdateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type UntagResourceInput Uses

type UntagResourceInput struct {

    // This is the value of the resource that will have the tag removed. An Amazon
    // Resource Name (ARN) is an identifier for a specific AWS resource, such as
    // a server, user, or role.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // TagKeys are key-value pairs assigned to ARNs that can be used to group and
    // search for resources by type. This metadata can be attached to resources
    // for any purpose.
    //
    // TagKeys is a required field
    TagKeys []*string `min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) GoString Uses

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*UntagResourceInput) SetTagKeys Uses

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String Uses

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate Uses

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput Uses

type UntagResourceOutput struct {
    // contains filtered or unexported fields
}

func (UntagResourceOutput) GoString Uses

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String Uses

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateServerInput Uses

type UpdateServerInput struct {

    // The virtual private cloud (VPC) endpoint settings that are configured for
    // your SFTP server. With a VPC endpoint, your SFTP server isn't accessible
    // over the public internet.
    EndpointDetails *EndpointDetails `type:"structure"`

    // The type of endpoint that you want your SFTP server to connect to. You can
    // choose to connect to the public internet or a virtual private cloud (VPC)
    // endpoint. With a VPC endpoint, your SFTP server isn't accessible over the
    // public internet.
    EndpointType *string `type:"string" enum:"EndpointType"`

    // The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.
    //
    // If you aren't planning to migrate existing users from an existing SFTP server
    // to a new AWS SFTP server, don't update the host key. Accidentally changing
    // a server's host key can be disruptive. For more information, see change-host-key
    // in the AWS SFTP User Guide.
    HostKey *string `type:"string"`

    // This response parameter is an array containing all of the information required
    // to call a customer's authentication API method.
    IdentityProviderDetails *IdentityProviderDetails `type:"structure"`

    // A value that changes the AWS Identity and Access Management (IAM) role that
    // allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging
    // on or off.
    LoggingRole *string `type:"string"`

    // A system-assigned unique identifier for an SFTP server instance that the
    // user account is assigned to.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (UpdateServerInput) GoString Uses

func (s UpdateServerInput) GoString() string

GoString returns the string representation

func (*UpdateServerInput) SetEndpointDetails Uses

func (s *UpdateServerInput) SetEndpointDetails(v *EndpointDetails) *UpdateServerInput

SetEndpointDetails sets the EndpointDetails field's value.

func (*UpdateServerInput) SetEndpointType Uses

func (s *UpdateServerInput) SetEndpointType(v string) *UpdateServerInput

SetEndpointType sets the EndpointType field's value.

func (*UpdateServerInput) SetHostKey Uses

func (s *UpdateServerInput) SetHostKey(v string) *UpdateServerInput

SetHostKey sets the HostKey field's value.

func (*UpdateServerInput) SetIdentityProviderDetails Uses

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

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.

func (*UpdateServerInput) SetLoggingRole Uses

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

SetLoggingRole sets the LoggingRole field's value.

func (*UpdateServerInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (UpdateServerInput) String Uses

func (s UpdateServerInput) String() string

String returns the string representation

func (*UpdateServerInput) Validate Uses

func (s *UpdateServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateServerOutput Uses

type UpdateServerOutput struct {

    // A system-assigned unique identifier for an SFTP server that the user account
    // is assigned to.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (UpdateServerOutput) GoString Uses

func (s UpdateServerOutput) GoString() string

GoString returns the string representation

func (*UpdateServerOutput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (UpdateServerOutput) String Uses

func (s UpdateServerOutput) String() string

String returns the string representation

type UpdateUserInput Uses

type UpdateUserInput struct {

    // The HomeDirectory parameter specifies the landing directory (folder) for
    // a user when they log in to the server using their client. An example would
    // be: /home/username .
    HomeDirectory *string `type:"string"`

    // Allows you to supply a scope-down policy for your user so you can use the
    // same AWS Identity and Access Management (IAM) role across multiple users.
    // The policy scopes down users access to portions of your Amazon S3 bucket.
    // Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory},
    // and ${Transfer:HomeBucket}.
    Policy *string `type:"string"`

    // The IAM role that controls your user's access to your Amazon S3 bucket. The
    // policies attached to this role will determine the level of access you want
    // to provide your users when transferring files into and out of your Amazon
    // S3 bucket or buckets. The IAM role should also contain a trust relationship
    // that allows the Secure File Transfer Protocol (SFTP) server to access your
    // resources when servicing your SFTP user's transfer requests.
    Role *string `type:"string"`

    // A system-assigned unique identifier for an SFTP server instance that the
    // user account is assigned to.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // A unique string that identifies a user and is associated with a server as
    // specified by the ServerId. This is the string that will be used by your user
    // when they log in to your SFTP server. This user name is a minimum of 3 and
    // a maximum of 32 characters long. The following are valid characters: a-z,
    // A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (UpdateUserInput) GoString Uses

func (s UpdateUserInput) GoString() string

GoString returns the string representation

func (*UpdateUserInput) SetHomeDirectory Uses

func (s *UpdateUserInput) SetHomeDirectory(v string) *UpdateUserInput

SetHomeDirectory sets the HomeDirectory field's value.

func (*UpdateUserInput) SetPolicy Uses

func (s *UpdateUserInput) SetPolicy(v string) *UpdateUserInput

SetPolicy sets the Policy field's value.

func (*UpdateUserInput) SetRole Uses

func (s *UpdateUserInput) SetRole(v string) *UpdateUserInput

SetRole sets the Role field's value.

func (*UpdateUserInput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*UpdateUserInput) SetUserName Uses

func (s *UpdateUserInput) SetUserName(v string) *UpdateUserInput

SetUserName sets the UserName field's value.

func (UpdateUserInput) String Uses

func (s UpdateUserInput) String() string

String returns the string representation

func (*UpdateUserInput) Validate Uses

func (s *UpdateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateUserOutput Uses

type UpdateUserOutput struct {

    // A system-assigned unique identifier for an SFTP server instance that the
    // user account is assigned to.
    //
    // ServerId is a required field
    ServerId *string `type:"string" required:"true"`

    // The unique identifier for a user that is assigned to the SFTP server instance
    // that was specified in the request.
    //
    // UserName is a required field
    UserName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

UpdateUserResponse returns the user name and server identifier for the request to update a user's properties.

func (UpdateUserOutput) GoString Uses

func (s UpdateUserOutput) GoString() string

GoString returns the string representation

func (*UpdateUserOutput) SetServerId Uses

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

SetServerId sets the ServerId field's value.

func (*UpdateUserOutput) SetUserName Uses

func (s *UpdateUserOutput) SetUserName(v string) *UpdateUserOutput

SetUserName sets the UserName field's value.

func (UpdateUserOutput) String Uses

func (s UpdateUserOutput) String() string

String returns the string representation

Directories

PathSynopsis
transferifacePackage transferiface provides an interface to enable mocking the AWS Transfer for SFTP service client for testing your code.

Package transfer imports 10 packages (graph) and is imported by 13 packages. Updated 2019-06-04. Refresh now. Tools for package owners.