transfer

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2019 License: Apache-2.0 Imports: 8 Imported by: 31

Documentation

Overview

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

Constants

View Source 
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"
)
View Source 
const (
	ServiceName = "transfer"  // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateServerInput 

type CreateServerInput struct {
	EndpointDetails *EndpointDetails `type:"structure"`

	EndpointType EndpointType `type:"string" enum:"true"`

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

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerRequest

func (CreateServerInput) GoString 

func (s CreateServerInput) GoString() string

GoString returns the string representation

func (CreateServerInput) String 

func (s CreateServerInput) String() string

String returns the string representation

func (*CreateServerInput) Validate 

func (s *CreateServerInput) Validate() error

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

type CreateServerOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerResponse

func (CreateServerOutput) GoString 

func (s CreateServerOutput) GoString() string

GoString returns the string representation

func (CreateServerOutput) SDKResponseMetadata 

func (s CreateServerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateServerOutput) String 

func (s CreateServerOutput) String() string

String returns the string representation

type CreateServerRequest 

type CreateServerRequest struct {
	*aws.Request
	Input *CreateServerInput
	Copy  func(*CreateServerInput) CreateServerRequest
}

CreateServerRequest is a API request type for the CreateServer API operation.

func (CreateServerRequest) Send 

func (r CreateServerRequest) Send(ctx context.Context) (*CreateServerOutput, error)

Send marshals and sends the CreateServer API request.

type CreateUserInput 

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.
	//
	// UserName is a required field
	UserName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserRequest

func (CreateUserInput) GoString 

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (CreateUserInput) String 

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate 

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserResponse

func (CreateUserOutput) GoString 

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (CreateUserOutput) SDKResponseMetadata 

func (s CreateUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateUserOutput) String 

func (s CreateUserOutput) String() string

String returns the string representation

type CreateUserRequest 

type CreateUserRequest struct {
	*aws.Request
	Input *CreateUserInput
	Copy  func(*CreateUserInput) CreateUserRequest
}

CreateUserRequest is a API request type for the CreateUser API operation.

func (CreateUserRequest) Send 

func (r CreateUserRequest) Send(ctx context.Context) (*CreateUserOutput, error)

Send marshals and sends the CreateUser API request.

type DeleteServerInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServerRequest

func (DeleteServerInput) GoString 

func (s DeleteServerInput) GoString() string

GoString returns the string representation

func (DeleteServerInput) String 

func (s DeleteServerInput) String() string

String returns the string representation

func (*DeleteServerInput) Validate 

func (s *DeleteServerInput) Validate() error

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

type DeleteServerOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServerOutput

func (DeleteServerOutput) GoString 

func (s DeleteServerOutput) GoString() string

GoString returns the string representation

func (DeleteServerOutput) SDKResponseMetadata 

func (s DeleteServerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteServerOutput) String 

func (s DeleteServerOutput) String() string

String returns the string representation

type DeleteServerRequest 

type DeleteServerRequest struct {
	*aws.Request
	Input *DeleteServerInput
	Copy  func(*DeleteServerInput) DeleteServerRequest
}

DeleteServerRequest is a API request type for the DeleteServer API operation.

func (DeleteServerRequest) Send 

func (r DeleteServerRequest) Send(ctx context.Context) (*DeleteServerOutput, error)

Send marshals and sends the DeleteServer API request.

type DeleteSshPublicKeyInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKeyRequest

func (DeleteSshPublicKeyInput) GoString 

func (s DeleteSshPublicKeyInput) GoString() string

GoString returns the string representation

func (DeleteSshPublicKeyInput) String 

func (s DeleteSshPublicKeyInput) String() string

String returns the string representation

func (*DeleteSshPublicKeyInput) Validate 

func (s *DeleteSshPublicKeyInput) Validate() error

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

type DeleteSshPublicKeyOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKeyOutput

func (DeleteSshPublicKeyOutput) GoString 

func (s DeleteSshPublicKeyOutput) GoString() string

GoString returns the string representation

func (DeleteSshPublicKeyOutput) SDKResponseMetadata 

func (s DeleteSshPublicKeyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteSshPublicKeyOutput) String 

func (s DeleteSshPublicKeyOutput) String() string

String returns the string representation

type DeleteSshPublicKeyRequest 

type DeleteSshPublicKeyRequest struct {
	*aws.Request
	Input *DeleteSshPublicKeyInput
	Copy  func(*DeleteSshPublicKeyInput) DeleteSshPublicKeyRequest
}

DeleteSshPublicKeyRequest is a API request type for the DeleteSshPublicKey API operation.

func (DeleteSshPublicKeyRequest) Send 

func (r DeleteSshPublicKeyRequest) Send(ctx context.Context) (*DeleteSshPublicKeyOutput, error)

Send marshals and sends the DeleteSshPublicKey API request.

type DeleteUserInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUserRequest

func (DeleteUserInput) GoString 

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (DeleteUserInput) String 

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate 

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUserOutput

func (DeleteUserOutput) GoString 

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) SDKResponseMetadata 

func (s DeleteUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation

type DeleteUserRequest 

type DeleteUserRequest struct {
	*aws.Request
	Input *DeleteUserInput
	Copy  func(*DeleteUserInput) DeleteUserRequest
}

DeleteUserRequest is a API request type for the DeleteUser API operation.

func (DeleteUserRequest) Send 

func (r DeleteUserRequest) Send(ctx context.Context) (*DeleteUserOutput, error)

Send marshals and sends the DeleteUser API request.

type DescribeServerInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServerRequest

func (DescribeServerInput) GoString 

func (s DescribeServerInput) GoString() string

GoString returns the string representation

func (DescribeServerInput) String 

func (s DescribeServerInput) String() string

String returns the string representation

func (*DescribeServerInput) Validate 

func (s *DescribeServerInput) Validate() error

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

type DescribeServerOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServerResponse

func (DescribeServerOutput) GoString 

func (s DescribeServerOutput) GoString() string

GoString returns the string representation

func (DescribeServerOutput) SDKResponseMetadata 

func (s DescribeServerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeServerOutput) String 

func (s DescribeServerOutput) String() string

String returns the string representation

type DescribeServerRequest 

type DescribeServerRequest struct {
	*aws.Request
	Input *DescribeServerInput
	Copy  func(*DescribeServerInput) DescribeServerRequest
}

DescribeServerRequest is a API request type for the DescribeServer API operation.

func (DescribeServerRequest) Send 

func (r DescribeServerRequest) Send(ctx context.Context) (*DescribeServerOutput, error)

Send marshals and sends the DescribeServer API request.

type DescribeUserInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUserRequest

func (DescribeUserInput) GoString 

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (DescribeUserInput) String 

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate 

func (s *DescribeUserInput) Validate() error

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

type DescribeUserOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUserResponse

func (DescribeUserOutput) GoString 

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (DescribeUserOutput) SDKResponseMetadata 

func (s DescribeUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeUserOutput) String 

func (s DescribeUserOutput) String() string

String returns the string representation

type DescribeUserRequest 

type DescribeUserRequest struct {
	*aws.Request
	Input *DescribeUserInput
	Copy  func(*DescribeUserInput) DescribeUserRequest
}

DescribeUserRequest is a API request type for the DescribeUser API operation.

func (DescribeUserRequest) Send 

func (r DescribeUserRequest) Send(ctx context.Context) (*DescribeUserOutput, error)

Send marshals and sends the DescribeUser API request.

type DescribedServer 

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"`

	EndpointDetails *EndpointDetails `type:"structure"`

	EndpointType EndpointType `type:"string" enum:"true"`

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

	// 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 State `type:"string" enum:"true"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedServer

func (DescribedServer) GoString 

func (s DescribedServer) GoString() string

GoString returns the string representation

func (DescribedServer) String 

func (s DescribedServer) String() string

String returns the string representation

type DescribedUser 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedUser

func (DescribedUser) GoString 

func (s DescribedUser) GoString() string

GoString returns the string representation

func (DescribedUser) String 

func (s DescribedUser) String() string

String returns the string representation

type EndpointDetails added in v0.8.0 

type EndpointDetails struct {
	VpcEndpointId *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/EndpointDetails

func (EndpointDetails) GoString added in v0.8.0 

func (s EndpointDetails) GoString() string

GoString returns the string representation

func (EndpointDetails) String added in v0.8.0 

func (s EndpointDetails) String() string

String returns the string representation

type EndpointType added in v0.8.0 

type EndpointType string
const (
	EndpointTypePublic      EndpointType = "PUBLIC"
	EndpointTypeVpcEndpoint EndpointType = "VPC_ENDPOINT"
)

Enum values for EndpointType

func (EndpointType) MarshalValue added in v0.8.0 

func (enum EndpointType) MarshalValue() (string, error)

func (EndpointType) MarshalValueBuf added in v0.8.0 

func (enum EndpointType) MarshalValueBuf(b []byte) ([]byte, error)

type IdentityProviderDetails 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/IdentityProviderDetails

func (IdentityProviderDetails) GoString 

func (s IdentityProviderDetails) GoString() string

GoString returns the string representation

func (IdentityProviderDetails) String 

func (s IdentityProviderDetails) String() string

String returns the string representation

type IdentityProviderType 

type IdentityProviderType string

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 (
	IdentityProviderTypeServiceManaged IdentityProviderType = "SERVICE_MANAGED"
	IdentityProviderTypeApiGateway     IdentityProviderType = "API_GATEWAY"
)

Enum values for IdentityProviderType

func (IdentityProviderType) MarshalValue 

func (enum IdentityProviderType) MarshalValue() (string, error)

func (IdentityProviderType) MarshalValueBuf 

func (enum IdentityProviderType) MarshalValueBuf(b []byte) ([]byte, error)

type ImportSshPublicKeyInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKeyRequest

func (ImportSshPublicKeyInput) GoString 

func (s ImportSshPublicKeyInput) GoString() string

GoString returns the string representation

func (ImportSshPublicKeyInput) String 

func (s ImportSshPublicKeyInput) String() string

String returns the string representation

func (*ImportSshPublicKeyInput) Validate 

func (s *ImportSshPublicKeyInput) Validate() error

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

type ImportSshPublicKeyOutput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKeyResponse

func (ImportSshPublicKeyOutput) GoString 

func (s ImportSshPublicKeyOutput) GoString() string

GoString returns the string representation

func (ImportSshPublicKeyOutput) SDKResponseMetadata 

func (s ImportSshPublicKeyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ImportSshPublicKeyOutput) String 

func (s ImportSshPublicKeyOutput) String() string

String returns the string representation

type ImportSshPublicKeyRequest 

type ImportSshPublicKeyRequest struct {
	*aws.Request
	Input *ImportSshPublicKeyInput
	Copy  func(*ImportSshPublicKeyInput) ImportSshPublicKeyRequest
}

ImportSshPublicKeyRequest is a API request type for the ImportSshPublicKey API operation.

func (ImportSshPublicKeyRequest) Send 

func (r ImportSshPublicKeyRequest) Send(ctx context.Context) (*ImportSshPublicKeyOutput, error)

Send marshals and sends the ImportSshPublicKey API request.

type ListServersInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServersRequest

func (ListServersInput) GoString 

func (s ListServersInput) GoString() string

GoString returns the string representation

func (ListServersInput) String 

func (s ListServersInput) String() string

String returns the string representation

func (*ListServersInput) Validate 

func (s *ListServersInput) Validate() error

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

type ListServersOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServersResponse

func (ListServersOutput) GoString 

func (s ListServersOutput) GoString() string

GoString returns the string representation

func (ListServersOutput) SDKResponseMetadata 

func (s ListServersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListServersOutput) String 

func (s ListServersOutput) String() string

String returns the string representation

type ListServersRequest 

type ListServersRequest struct {
	*aws.Request
	Input *ListServersInput
	Copy  func(*ListServersInput) ListServersRequest
}

ListServersRequest is a API request type for the ListServers API operation.

func (ListServersRequest) Send 

func (r ListServersRequest) Send(ctx context.Context) (*ListServersOutput, error)

Send marshals and sends the ListServers API request.

type ListTagsForResourceInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResourceRequest

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResourceResponse

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (ListTagsForResourceOutput) SDKResponseMetadata 

func (s ListTagsForResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is a API request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceOutput, error)

Send marshals and sends the ListTagsForResource API request.

type ListUsersInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsersRequest

func (ListUsersInput) GoString 

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (ListUsersInput) String 

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate 

func (s *ListUsersInput) Validate() error

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

type ListUsersOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsersResponse

func (ListUsersOutput) GoString 

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (ListUsersOutput) SDKResponseMetadata 

func (s ListUsersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListUsersOutput) String 

func (s ListUsersOutput) String() string

String returns the string representation

type ListUsersRequest 

type ListUsersRequest struct {
	*aws.Request
	Input *ListUsersInput
	Copy  func(*ListUsersInput) ListUsersRequest
}

ListUsersRequest is a API request type for the ListUsers API operation.

func (ListUsersRequest) Send 

func (r ListUsersRequest) Send(ctx context.Context) (*ListUsersOutput, error)

Send marshals and sends the ListUsers API request.

type ListedServer 

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"`

	EndpointType EndpointType `type:"string" enum:"true"`

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

	// 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 State `type:"string" enum:"true"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedServer

func (ListedServer) GoString 

func (s ListedServer) GoString() string

GoString returns the string representation

func (ListedServer) String 

func (s ListedServer) String() string

String returns the string representation

type ListedUser 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedUser

func (ListedUser) GoString 

func (s ListedUser) GoString() string

GoString returns the string representation

func (ListedUser) String 

func (s ListedUser) String() string

String returns the string representation

type SshPublicKey 

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" timestampFormat:"unix" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/SshPublicKey

func (SshPublicKey) GoString 

func (s SshPublicKey) GoString() string

GoString returns the string representation

func (SshPublicKey) String 

func (s SshPublicKey) String() string

String returns the string representation

type StartServerInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServerRequest

func (StartServerInput) GoString 

func (s StartServerInput) GoString() string

GoString returns the string representation

func (StartServerInput) String 

func (s StartServerInput) String() string

String returns the string representation

func (*StartServerInput) Validate 

func (s *StartServerInput) Validate() error

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

type StartServerOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServerOutput

func (StartServerOutput) GoString 

func (s StartServerOutput) GoString() string

GoString returns the string representation

func (StartServerOutput) SDKResponseMetadata 

func (s StartServerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (StartServerOutput) String 

func (s StartServerOutput) String() string

String returns the string representation

type StartServerRequest 

type StartServerRequest struct {
	*aws.Request
	Input *StartServerInput
	Copy  func(*StartServerInput) StartServerRequest
}

StartServerRequest is a API request type for the StartServer API operation.

func (StartServerRequest) Send 

func (r StartServerRequest) Send(ctx context.Context) (*StartServerOutput, error)

Send marshals and sends the StartServer API request.

type State 

type State string

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 (
	StateOffline     State = "OFFLINE"
	StateOnline      State = "ONLINE"
	StateStarting    State = "STARTING"
	StateStopping    State = "STOPPING"
	StateStartFailed State = "START_FAILED"
	StateStopFailed  State = "STOP_FAILED"
)

Enum values for State

func (State) MarshalValue 

func (enum State) MarshalValue() (string, error)

func (State) MarshalValueBuf 

func (enum State) MarshalValueBuf(b []byte) ([]byte, error)

type StopServerInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServerRequest

func (StopServerInput) GoString 

func (s StopServerInput) GoString() string

GoString returns the string representation

func (StopServerInput) String 

func (s StopServerInput) String() string

String returns the string representation

func (*StopServerInput) Validate 

func (s *StopServerInput) Validate() error

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

type StopServerOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServerOutput

func (StopServerOutput) GoString 

func (s StopServerOutput) GoString() string

GoString returns the string representation

func (StopServerOutput) SDKResponseMetadata 

func (s StopServerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (StopServerOutput) String 

func (s StopServerOutput) String() string

String returns the string representation

type StopServerRequest 

type StopServerRequest struct {
	*aws.Request
	Input *StopServerInput
	Copy  func(*StopServerInput) StopServerRequest
}

StopServerRequest is a API request type for the StopServer API operation.

func (StopServerRequest) Send 

func (r StopServerRequest) Send(ctx context.Context) (*StopServerOutput, error)

Send marshals and sends the StopServer API request.

type Tag 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/Tag

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type TagResourceInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResourceRequest

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResourceOutput

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) SDKResponseMetadata 

func (s TagResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is a API request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceOutput, error)

Send marshals and sends the TagResource API request.

type TestIdentityProviderInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProviderRequest

func (TestIdentityProviderInput) GoString 

func (s TestIdentityProviderInput) GoString() string

GoString returns the string representation

func (TestIdentityProviderInput) String 

func (s TestIdentityProviderInput) String() string

String returns the string representation

func (*TestIdentityProviderInput) Validate 

func (s *TestIdentityProviderInput) Validate() error

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

type TestIdentityProviderOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProviderResponse

func (TestIdentityProviderOutput) GoString 

func (s TestIdentityProviderOutput) GoString() string

GoString returns the string representation

func (TestIdentityProviderOutput) SDKResponseMetadata 

func (s TestIdentityProviderOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (TestIdentityProviderOutput) String 

func (s TestIdentityProviderOutput) String() string

String returns the string representation

type TestIdentityProviderRequest 

type TestIdentityProviderRequest struct {
	*aws.Request
	Input *TestIdentityProviderInput
	Copy  func(*TestIdentityProviderInput) TestIdentityProviderRequest
}

TestIdentityProviderRequest is a API request type for the TestIdentityProvider API operation.

func (TestIdentityProviderRequest) Send 

func (r TestIdentityProviderRequest) Send(ctx context.Context) (*TestIdentityProviderOutput, error)

Send marshals and sends the TestIdentityProvider API request.

type Transfer 

type Transfer struct {
	*aws.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 

func New(config aws.Config) *Transfer

New creates a new instance of the Transfer client with a config.

Example: 

// Create a Transfer client from just a config.
svc := transfer.New(myConfig)

func (*Transfer) CreateServerRequest 

func (c *Transfer) CreateServerRequest(input *CreateServerInput) CreateServerRequest

CreateServerRequest returns a request value for making 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. 

// Example sending a request using the CreateServerRequest method.
req := client.CreateServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) CreateUserRequest 

func (c *Transfer) CreateUserRequest(input *CreateUserInput) CreateUserRequest

CreateUserRequest returns a request value for making 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. 

// Example sending a request using the CreateUserRequest method.
req := client.CreateUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) DeleteServerRequest 

func (c *Transfer) DeleteServerRequest(input *DeleteServerInput) DeleteServerRequest

DeleteServerRequest returns a request value for making 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. 

// Example sending a request using the DeleteServerRequest method.
req := client.DeleteServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) DeleteSshPublicKeyRequest 

func (c *Transfer) DeleteSshPublicKeyRequest(input *DeleteSshPublicKeyInput) DeleteSshPublicKeyRequest

DeleteSshPublicKeyRequest returns a request value for making API operation for AWS Transfer for SFTP.

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

No response is returned from this call. 

// Example sending a request using the DeleteSshPublicKeyRequest method.
req := client.DeleteSshPublicKeyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) DeleteUserRequest 

func (c *Transfer) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest

DeleteUserRequest returns a request value for making 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. 

// Example sending a request using the DeleteUserRequest method.
req := client.DeleteUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) DescribeServerRequest 

func (c *Transfer) DescribeServerRequest(input *DescribeServerInput) DescribeServerRequest

DescribeServerRequest returns a request value for making 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. 

// Example sending a request using the DescribeServerRequest method.
req := client.DescribeServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) DescribeUserRequest 

func (c *Transfer) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest

DescribeUserRequest returns a request value for making 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. 

// Example sending a request using the DescribeUserRequest method.
req := client.DescribeUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) ImportSshPublicKeyRequest 

func (c *Transfer) ImportSshPublicKeyRequest(input *ImportSshPublicKeyInput) ImportSshPublicKeyRequest

ImportSshPublicKeyRequest returns a request value for making 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. 

// Example sending a request using the ImportSshPublicKeyRequest method.
req := client.ImportSshPublicKeyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) ListServersRequest 

func (c *Transfer) ListServersRequest(input *ListServersInput) ListServersRequest

ListServersRequest returns a request value for making API operation for AWS Transfer for SFTP.

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

// Example sending a request using the ListServersRequest method.
req := client.ListServersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) ListTagsForResourceRequest 

func (c *Transfer) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making 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. 

// Example sending a request using the ListTagsForResourceRequest method.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) ListUsersRequest 

func (c *Transfer) ListUsersRequest(input *ListUsersInput) ListUsersRequest

ListUsersRequest returns a request value for making API operation for AWS Transfer for SFTP.

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

// Example sending a request using the ListUsersRequest method.
req := client.ListUsersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) StartServerRequest 

func (c *Transfer) StartServerRequest(input *StartServerInput) StartServerRequest

StartServerRequest returns a request value for making 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. 

// Example sending a request using the StartServerRequest method.
req := client.StartServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) StopServerRequest 

func (c *Transfer) StopServerRequest(input *StopServerInput) StopServerRequest

StopServerRequest returns a request value for making 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. 

// Example sending a request using the StopServerRequest method.
req := client.StopServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) TagResourceRequest 

func (c *Transfer) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making 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. 

// Example sending a request using the TagResourceRequest method.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) TestIdentityProviderRequest 

func (c *Transfer) TestIdentityProviderRequest(input *TestIdentityProviderInput) TestIdentityProviderRequest

TestIdentityProviderRequest returns a request value for making 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. 

// Example sending a request using the TestIdentityProviderRequest method.
req := client.TestIdentityProviderRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) UntagResourceRequest 

func (c *Transfer) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making 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. 

// Example sending a request using the UntagResourceRequest method.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) UpdateServerRequest 

func (c *Transfer) UpdateServerRequest(input *UpdateServerInput) UpdateServerRequest

UpdateServerRequest returns a request value for making 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. 

// Example sending a request using the UpdateServerRequest method.
req := client.UpdateServerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Transfer) UpdateUserRequest 

func (c *Transfer) UpdateUserRequest(input *UpdateUserInput) UpdateUserRequest

UpdateUserRequest returns a request value for making 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. 

// Example sending a request using the UpdateUserRequest method.
req := client.UpdateUserRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type UntagResourceInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResourceRequest

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResourceOutput

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) SDKResponseMetadata 

func (s UntagResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is a API request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceOutput, error)

Send marshals and sends the UntagResource API request.

type UpdateServerInput 

type UpdateServerInput struct {
	EndpointDetails *EndpointDetails `type:"structure"`

	EndpointType EndpointType `type:"string" enum:"true"`

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

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerRequest

func (UpdateServerInput) GoString 

func (s UpdateServerInput) GoString() string

GoString returns the string representation

func (UpdateServerInput) String 

func (s UpdateServerInput) String() string

String returns the string representation

func (*UpdateServerInput) Validate 

func (s *UpdateServerInput) Validate() error

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

type UpdateServerOutput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerResponse

func (UpdateServerOutput) GoString 

func (s UpdateServerOutput) GoString() string

GoString returns the string representation

func (UpdateServerOutput) SDKResponseMetadata 

func (s UpdateServerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateServerOutput) String 

func (s UpdateServerOutput) String() string

String returns the string representation

type UpdateServerRequest 

type UpdateServerRequest struct {
	*aws.Request
	Input *UpdateServerInput
	Copy  func(*UpdateServerInput) UpdateServerRequest
}

UpdateServerRequest is a API request type for the UpdateServer API operation.

func (UpdateServerRequest) Send 

func (r UpdateServerRequest) Send(ctx context.Context) (*UpdateServerOutput, error)

Send marshals and sends the UpdateServer API request.

type UpdateUserInput 

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.
	//
	// UserName is a required field
	UserName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUserRequest

func (UpdateUserInput) GoString 

func (s UpdateUserInput) GoString() string

GoString returns the string representation

func (UpdateUserInput) String 

func (s UpdateUserInput) String() string

String returns the string representation

func (*UpdateUserInput) Validate 

func (s *UpdateUserInput) Validate() error

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

type UpdateUserOutput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUserResponse

func (UpdateUserOutput) GoString 

func (s UpdateUserOutput) GoString() string

GoString returns the string representation

func (UpdateUserOutput) SDKResponseMetadata 

func (s UpdateUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateUserOutput) String 

func (s UpdateUserOutput) String() string

String returns the string representation

type UpdateUserRequest 

type UpdateUserRequest struct {
	*aws.Request
	Input *UpdateUserInput
	Copy  func(*UpdateUserInput) UpdateUserRequest
}

UpdateUserRequest is a API request type for the UpdateUser API operation.

func (UpdateUserRequest) Send 

func (r UpdateUserRequest) Send(ctx context.Context) (*UpdateUserOutput, error)

Send marshals and sends the UpdateUser API request.

Source Files

View all Source files

Directories

Path Synopsis
Package transferiface provides an interface to enable mocking the AWS Transfer for SFTP service client for testing your code.
 Package transferiface provides an interface to enable mocking the AWS Transfer for SFTP service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.