transfer

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 31

Documentation

Overview

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

AWS Transfer Family is a fully managed service that enables the transfer of files over the the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family 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 Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.

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 use AWS Transfer 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 client 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 (
	ServiceName = "AWS Transfer" // Service's name
	ServiceID   = "Transfer"     // Service's identifier
	EndpointsID = "transfer"     // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// This exception is thrown when the UpdatServer is called for a file transfer
	// protocol-enabled server that has VPC as the endpoint type and the server's
	// VpcEndpointID is not in the available state.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServiceError for service response error code
	// "InternalServiceError".
	//
	// This exception is thrown when an error occurs in the AWS Transfer Family
	// 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
	// Family service.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The request has failed because the AWS Transfer Family service is not available.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	//
	// HTTP Status Code: 400
	ErrCodeThrottlingException = "ThrottlingException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

The client's 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) *Client

New creates a new instance of the client from the provided Config.

Example: 

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

func (*Client) CreateServerRequest added in v0.9.0 

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

CreateServerRequest returns a request value for making API operation for AWS Transfer Family.

Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. 

// Example sending a request using CreateServerRequest.
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 (*Client) CreateUserRequest added in v0.9.0 

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

CreateUserRequest returns a request value for making API operation for AWS Transfer Family.

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. 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. 

// Example sending a request using CreateUserRequest.
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 (*Client) DeleteServerRequest added in v0.9.0 

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

DeleteServerRequest returns a request value for making API operation for AWS Transfer Family.

Deletes the file transfer protocol-enabled server that you specify.

No response returns from this operation. 

// Example sending a request using DeleteServerRequest.
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 (*Client) DeleteSshPublicKeyRequest added in v0.9.0 

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

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

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

No response is returned from this operation. 

// Example sending a request using DeleteSshPublicKeyRequest.
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 (*Client) DeleteUserRequest added in v0.9.0 

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

DeleteUserRequest returns a request value for making API operation for AWS Transfer Family.

Deletes the user belonging to a file transfer protocol-enabled server you specify.

No response returns from this operation.

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

// Example sending a request using DeleteUserRequest.
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 (*Client) DescribeServerRequest added in v0.9.0 

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

DescribeServerRequest returns a request value for making API operation for AWS Transfer Family.

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails. 

// Example sending a request using DescribeServerRequest.
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 (*Client) DescribeUserRequest added in v0.9.0 

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

DescribeUserRequest returns a request value for making API operation for AWS Transfer Family.

Describes the user assigned to the specific file transfer protocol-enabled 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 DescribeUserRequest.
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 (*Client) ImportSshPublicKeyRequest added in v0.9.0 

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

ImportSshPublicKeyRequest returns a request value for making API operation for AWS Transfer Family.

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

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

// Example sending a request using ImportSshPublicKeyRequest.
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 (*Client) ListServersRequest added in v0.9.0 

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

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

Lists the file transfer protocol-enabled servers that are associated with your AWS account. 

// Example sending a request using ListServersRequest.
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 (*Client) ListTagsForResourceRequest added in v0.9.0 

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

ListTagsForResourceRequest returns a request value for making API operation for AWS Transfer Family.

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 ListTagsForResourceRequest.
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 (*Client) ListUsersRequest added in v0.9.0 

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

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

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter. 

// Example sending a request using ListUsersRequest.
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 (*Client) StartServerRequest added in v0.9.0 

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

StartServerRequest returns a request value for making API operation for AWS Transfer Family.

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a 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 StartServerRequest.
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 (*Client) StopServerRequest added in v0.9.0 

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

StopServerRequest returns a request value for making API operation for AWS Transfer Family.

Changes the state of a file transfer protocol-enabled 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 the server will not reduce or impact your file transfer protocol endpoint billing.

The state 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 StopServerRequest.
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 (*Client) TagResourceRequest added in v0.9.0 

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

TagResourceRequest returns a request value for making API operation for AWS Transfer Family.

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 TagResourceRequest.
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 (*Client) TestIdentityProviderRequest added in v0.9.0 

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

TestIdentityProviderRequest returns a request value for making API operation for AWS Transfer Family.

If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation 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 TestIdentityProviderRequest.
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 (*Client) UntagResourceRequest added in v0.9.0 

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

UntagResourceRequest returns a request value for making API operation for AWS Transfer Family.

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 UntagResourceRequest.
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 (*Client) UpdateServerRequest added in v0.9.0 

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

UpdateServerRequest returns a request value for making API operation for AWS Transfer Family.

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated. 

// Example sending a request using UpdateServerRequest.
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 (*Client) UpdateUserRequest added in v0.9.0 

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

UpdateUserRequest returns a request value for making API operation for AWS Transfer Family.

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

type CreateServerInput struct {

	// The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
	// Required when Protocols is set to FTPS.
	//
	// To request a new public certificate, see Request a public certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html)
	// in the AWS Certificate Manager User Guide.
	//
	// To import an existing certificate into ACM, see Importing certificates into
	// ACM (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)
	// in the AWS Certificate Manager User Guide.
	//
	// To request a private certificate to use FTPS through private IP addresses,
	// see Request a private certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html)
	// in the AWS Certificate Manager User Guide.
	//
	// Certificates with the following cryptographic algorithms and key sizes are
	// supported:
	//
	//    * 2048-bit RSA (RSA_2048)
	//
	//    * 4096-bit RSA (RSA_4096)
	//
	//    * Elliptic Prime Curve 256 bit (EC_prime256v1)
	//
	//    * Elliptic Prime Curve 384 bit (EC_secp384r1)
	//
	//    * Elliptic Prime Curve 521 bit (EC_secp521r1)
	//
	// The certificate must be a valid SSL/TLS X.509 version 3 certificate with
	// FQDN or IP address specified and information about the issuer.
	Certificate *string `type:"string"`

	// The virtual private cloud (VPC) endpoint settings that are configured for
	// your file transfer protocol-enabled server. When you host your endpoint within
	// your VPC, you can make it accessible only to resources within your VPC, or
	// you can attach Elastic IPs and make it accessible to clients over the internet.
	// Your VPC's default security groups are automatically assigned to your endpoint.
	EndpointDetails *EndpointDetails `type:"structure"`

	// The type of VPC endpoint that you want your file transfer protocol-enabled
	// server to connect to. You can choose to connect to the public internet or
	// a VPC endpoint. With a VPC endpoint, you can restrict access to your server
	// and resources only within your VPC.
	//
	// It is recommended that you use VPC as the EndpointType. With this endpoint
	// type, you have the option to directly associate up to three Elastic IPv4
	// addresses (BYO IP included) with your server's endpoint and use VPC security
	// groups to restrict traffic by the client's public IP address. This is not
	// possible with EndpointType set to VPC_ENDPOINT.
	EndpointType EndpointType `type:"string" enum:"true"`

	// The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key
	// command.
	//
	// If you aren't planning to migrate existing users from an existing SFTP-enabled
	// server to a new server, don't update the host key. Accidentally changing
	// a server's host key can be disruptive.
	//
	// For more information, see Change the host key for your SFTP-enabled server
	// (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key)
	// in the AWS Transfer Family User Guide.
	HostKey *string `type:"string" sensitive:"true"`

	// Required when IdentityProviderType is set to API_GATEWAY. Accepts an array
	// containing all of the information required to call a customer-supplied authentication
	// API, including the API Gateway URL. Not required when IdentityProviderType
	// is set to SERVICE_MANAGED.
	IdentityProviderDetails *IdentityProviderDetails `type:"structure"`

	// Specifies the mode of authentication for a file transfer protocol-enabled
	// server. The default value is SERVICE_MANAGED, which allows you to store and
	// access user credentials within the AWS Transfer Family service. Use the API_GATEWAY
	// value to integrate with an identity provider of your choosing. The API_GATEWAY
	// setting requires you to provide an API Gateway endpoint URL to call for authentication
	// using the IdentityProviderDetails parameter.
	IdentityProviderType IdentityProviderType `type:"string" enum:"true"`

	// Allows the service to write your users' activity to your Amazon CloudWatch
	// logs for monitoring and auditing purposes.
	LoggingRole *string `min:"20" type:"string"`

	// Specifies the file transfer protocol or protocols over which your file transfer
	// protocol client can connect to your server's endpoint. The available protocols
	// are:
	//
	//    * SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over
	//    SSH
	//
	//    * FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
	//
	//    * FTP (File Transfer Protocol): Unencrypted file transfer
	//
	// If you select FTPS, you must choose a certificate stored in AWS Certificate
	// Manager (ACM) which will be used to identify your server when clients connect
	// to it over FTPS.
	//
	// If Protocol includes either FTP or FTPS, then the EndpointType must be VPC
	// and the IdentityProviderType must be API_GATEWAY.
	//
	// If Protocol includes FTP, then AddressAllocationIds cannot be associated.
	//
	// If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and
	// the IdentityProviderType can be set to SERVICE_MANAGED.
	Protocols []Protocol `min:"1" type:"list"`

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

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 file transfer protocol-enabled server that
	// is created.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 the request type for the CreateServer API operation.

func (CreateServerRequest) Send 

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

Send marshals and sends the CreateServer API request.

type CreateServerResponse added in v0.9.0 

type CreateServerResponse struct {
	*CreateServerOutput
	// contains filtered or unexported fields
}

CreateServerResponse is the response type for the CreateServer API operation.

func (*CreateServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateServer request.

type CreateUserInput 

type CreateUserInput struct {

	// The landing directory (folder) for a user when they log in to the file transfer
	// protocol-enabled server using the client.
	//
	// An example is your-Amazon-S3-bucket-name>/home/username .
	HomeDirectory *string `type:"string"`

	// Logical directory mappings that specify what Amazon S3 paths and keys should
	// be visible to your user and how you want to make them visible. You will need
	// to specify the "Entry" and "Target" pair, where Entry shows how the path
	// is made visible and Target is the actual Amazon S3 path. If you only specify
	// a target, it will be displayed as is. You will need to also make sure that
	// your IAM role provides access to paths in Target. The following is an example.
	//
	// '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target":
	// "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'
	//
	// In most cases, you can use this value instead of the scope-down policy to
	// lock your user down to the designated home directory ("chroot"). To do this,
	// you can set Entry to '/' and set Target to the HomeDirectory parameter value.
	//
	// If the target of a logical directory entry does not exist in Amazon S3, the
	// entry will be ignored. As a workaround, you can use the Amazon S3 api to
	// create 0 byte objects as place holders for your directory. If using the CLI,
	// use the s3api call instead of s3 so you can use the put-object operation.
	// For example, you use the following: aws s3api put-object --bucket bucketname
	// --key path/to/folder/. Make sure that the end of the key name ends in a '/'
	// for it to be considered a folder.
	HomeDirectoryMappings []HomeDirectoryMapEntry `min:"1" type:"list"`

	// The type of landing directory (folder) you want your users' home directory
	// to be when they log into the file transfer protocol-enabled server. If you
	// set it to PATH, the user will see the absolute Amazon S3 bucket paths as
	// is in their file transfer protocol clients. If you set it LOGICAL, you will
	// need to provide mappings in the HomeDirectoryMappings for how you want to
	// make Amazon S3 paths visible to your users.
	HomeDirectoryType HomeDirectoryType `type:"string" enum:"true"`

	// 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 that you can use inside this policy include ${Transfer:UserName},
	// ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
	//
	// For scope-down policies, AWS Transfer Family stores the policy as a JSON
	// blob, instead of the Amazon Resource Name (ARN) of the policy. You save the
	// policy as a JSON blob and pass it in the Policy argument.
	//
	// For an example of a scope-down policy, see Creating a scope-down policy (https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down).
	//
	// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
	// in the AWS Security Token Service API Reference.
	Policy *string `type:"string"`

	// The IAM role that controls your users' 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 file transfer protocol-enabled server to access your resources
	// when servicing your users' transfer requests.
	//
	// Role is a required field
	Role *string `min:"20" type:"string" required:"true"`

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

	// The public portion of the Secure Shell (SSH) key used to authenticate the
	// user to the file transfer protocol-enabled 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 file transfer
	// protocol-enabled 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 `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 file transfer protocol-enabled server that the user is attached
	// to.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`

	// A unique string that identifies a user account associated with a file transfer
	// protocol-enabled server.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 the request type for the CreateUser API operation.

func (CreateUserRequest) Send 

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

Send marshals and sends the CreateUser API request.

type CreateUserResponse added in v0.9.0 

type CreateUserResponse struct {
	*CreateUserOutput
	// contains filtered or unexported fields
}

CreateUserResponse is the response type for the CreateUser API operation.

func (*CreateUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateUser request.

type DeleteServerInput 

type DeleteServerInput struct {

	// A unique system-assigned identifier for a file transfer protocol-enabled
	// server instance.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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
}

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 the request type for the DeleteServer API operation.

func (DeleteServerRequest) Send 

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

Send marshals and sends the DeleteServer API request.

type DeleteServerResponse added in v0.9.0 

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

DeleteServerResponse is the response type for the DeleteServer API operation.

func (*DeleteServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteServer request.

type DeleteSshPublicKeyInput 

type DeleteSshPublicKeyInput struct {

	// A system-assigned unique identifier for a file transfer protocol-enabled
	// server instance that has the user assigned to it.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`

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

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

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
}

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 the request type for the DeleteSshPublicKey API operation.

func (DeleteSshPublicKeyRequest) Send 

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

Send marshals and sends the DeleteSshPublicKey API request.

type DeleteSshPublicKeyResponse added in v0.9.0 

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

DeleteSshPublicKeyResponse is the response type for the DeleteSshPublicKey API operation.

func (*DeleteSshPublicKeyResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteSshPublicKeyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSshPublicKey request.

type DeleteUserInput 

type DeleteUserInput struct {

	// A system-assigned unique identifier for a file transfer protocol-enabled
	// server instance that has the user assigned to it.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`

	// A unique string that identifies a user that is being deleted from a file
	// transfer protocol-enabled server.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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
}

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 the request type for the DeleteUser API operation.

func (DeleteUserRequest) Send 

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

Send marshals and sends the DeleteUser API request.

type DeleteUserResponse added in v0.9.0 

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

DeleteUserResponse is the response type for the DeleteUser API operation.

func (*DeleteUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteUser request.

type DescribeServerInput 

type DescribeServerInput struct {

	// A system-assigned unique identifier for a file transfer protocol-enabled
	// server.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 a file transfer protocol-enabled server
	// with the ServerID you specified.
	//
	// Server is a required field
	Server *DescribedServer `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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 the request type for the DescribeServer API operation.

func (DescribeServerRequest) Send 

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

Send marshals and sends the DescribeServer API request.

type DescribeServerResponse added in v0.9.0 

type DescribeServerResponse struct {
	*DescribeServerOutput
	// contains filtered or unexported fields
}

DescribeServerResponse is the response type for the DescribeServer API operation.

func (*DescribeServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeServer request.

type DescribeUserInput 

type DescribeUserInput struct {

	// A system-assigned unique identifier for a file transfer protocol-enabled
	// server that has this user assigned.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`

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

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 a file transfer protocol-enabled
	// server that has this user assigned.
	//
	// ServerId is a required field
	ServerId *string `min:"19" 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) 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 the request type for the DescribeUser API operation.

func (DescribeUserRequest) Send 

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

Send marshals and sends the DescribeUser API request.

type DescribeUserResponse added in v0.9.0 

type DescribeUserResponse struct {
	*DescribeUserOutput
	// contains filtered or unexported fields
}

DescribeUserResponse is the response type for the DescribeUser API operation.

func (*DescribeUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeUser request.

type DescribedServer 

type DescribedServer struct {

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

	// Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
	// when Protocols is set to FTPS.
	Certificate *string `type:"string"`

	// Specifies the virtual private cloud (VPC) endpoint settings that you configured
	// for your file transfer protocol-enabled server.
	EndpointDetails *EndpointDetails `type:"structure"`

	// Defines the type of endpoint that your file transfer protocol-enabled server
	// is connected to. If your server is connected to a VPC endpoint, your server
	// isn't accessible over the public internet.
	EndpointType EndpointType `type:"string" enum:"true"`

	// Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
	// This value is equivalent to the output of the ssh-keygen -l -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 a file transfer protocol-enabled
	// server is SERVICE_MANAGED.
	IdentityProviderDetails *IdentityProviderDetails `type:"structure"`

	// Specifies the mode of authentication method enabled for this service. A value
	// of SERVICE_MANAGED means that you are using this file transfer protocol-enabled
	// server to store and access 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"`

	// Specifies the AWS Identity and Access Management (IAM) role that allows a
	// file transfer protocol-enabled server to turn on Amazon CloudWatch logging
	// for Amazon S3 events. When set, user activity can be viewed in your CloudWatch
	// logs.
	LoggingRole *string `min:"20" type:"string"`

	// Specifies the file transfer protocol or protocols over which your file transfer
	// protocol client can connect to your server's endpoint. The available protocols
	// are:
	//
	//    * SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over
	//    SSH
	//
	//    * FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
	//
	//    * FTP (File Transfer Protocol): Unencrypted file transfer
	Protocols []Protocol `min:"1" type:"list"`

	// Specifies the unique system-assigned identifier for a file transfer protocol-enabled
	// server that you instantiate.
	ServerId *string `min:"19" type:"string"`

	// Specifies the condition of a file transfer protocol-enabled 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 indicate 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"`

	// Specifies the key-value pairs that you can use to search for and group file
	// transfer protocol-enabled servers that were assigned to the server that was
	// described.
	Tags []Tag `min:"1" type:"list"`

	// Specifies the number of users that are assigned to a file transfer protocol-enabled
	// server you specified with the ServerId.
	UserCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Describes the properties of a file transfer protocol-enabled server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the certificate ARN (if the FTPS protocol was selected), the endpoint type and details, the authentication configuration and type, the logging role, the file transfer protocol or protocols, the server ID and state, and assigned tags or metadata.

func (DescribedServer) String 

func (s DescribedServer) String() string

String returns the string representation

type DescribedUser 

type DescribedUser struct {

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

	// 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 is your-Amazon-S3-bucket-name>/home/username .
	HomeDirectory *string `type:"string"`

	// Specifies the logical directory mappings that specify what Amazon S3 paths
	// and keys should be visible to your user and how you want to make them visible.
	// You will need to specify the "Entry" and "Target" pair, where Entry shows
	// how the path is made visible and Target is the actual Amazon S3 path. If
	// you only specify a target, it will be displayed as is. You will need to also
	// make sure that your AWS Identity and Access Management (IAM) role provides
	// access to paths in Target.
	//
	// In most cases, you can use this value instead of the scope-down policy to
	// lock your user down to the designated home directory ("chroot"). To do this,
	// you can set Entry to '/' and set Target to the HomeDirectory parameter value.
	HomeDirectoryMappings []HomeDirectoryMapEntry `min:"1" type:"list"`

	// Specifies the type of landing directory (folder) you mapped for your users
	// to see when they log into the file transfer protocol-enabled server. If you
	// set it to PATH, the user will see the absolute Amazon S3 bucket paths as
	// is in their file transfer protocol clients. If you set it LOGICAL, you will
	// need to provide mappings in the HomeDirectoryMappings for how you want to
	// make Amazon S3 paths visible to your users.
	HomeDirectoryType HomeDirectoryType `type:"string" enum:"true"`

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

	// Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your resources
	// when servicing your users' transfer requests.
	Role *string `min:"20" type:"string"`

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

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

	// Specifies 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 file transfer protocol-enabled server.
	UserName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Returns properties of the user that you want to describe.

func (DescribedUser) String 

func (s DescribedUser) String() string

String returns the string representation

type EndpointDetails added in v0.8.0 

type EndpointDetails struct {

	// A list of address allocation IDs that are required to attach an Elastic IP
	// address to your file transfer protocol-enabled server's endpoint. This is
	// only valid in the UpdateServer API.
	//
	// This property can only be use when EndpointType is set to VPC.
	AddressAllocationIds []string `type:"list"`

	// A list of subnet IDs that are required to host your file transfer protocol-enabled
	// server endpoint in your VPC.
	//
	// This property can only be used when EndpointType is set to VPC.
	SubnetIds []string `type:"list"`

	// The ID of the VPC endpoint.
	//
	// This property can only be used when EndpointType is set to VPC_ENDPOINT.
	VpcEndpointId *string `min:"22" type:"string"`

	// The VPC ID of the VPC in which a file transfer protocol-enabled server's
	// endpoint will be hosted.
	//
	// This property can only be used when EndpointType is set to VPC.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.

func (EndpointDetails) String added in v0.8.0 

func (s EndpointDetails) String() string

String returns the string representation

func (*EndpointDetails) Validate added in v0.16.0 

func (s *EndpointDetails) Validate() error

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

type EndpointType added in v0.8.0 

type EndpointType string
const (
	EndpointTypePublic      EndpointType = "PUBLIC"
	EndpointTypeVpc         EndpointType = "VPC"
	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 HomeDirectoryMapEntry added in v0.16.0 

type HomeDirectoryMapEntry struct {

	// Represents an entry and a target for HomeDirectoryMappings.
	//
	// Entry is a required field
	Entry *string `type:"string" required:"true"`

	// Represents the map target that is used in a HomeDirectorymapEntry.
	//
	// Target is a required field
	Target *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents an object that contains entries and a targets for HomeDirectoryMappings.

func (HomeDirectoryMapEntry) String added in v0.16.0 

func (s HomeDirectoryMapEntry) String() string

String returns the string representation

func (*HomeDirectoryMapEntry) Validate added in v0.16.0 

func (s *HomeDirectoryMapEntry) Validate() error

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

type HomeDirectoryType added in v0.16.0 

type HomeDirectoryType string
const (
	HomeDirectoryTypePath    HomeDirectoryType = "PATH"
	HomeDirectoryTypeLogical HomeDirectoryType = "LOGICAL"
)

Enum values for HomeDirectoryType

func (HomeDirectoryType) MarshalValue added in v0.16.0 

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

func (HomeDirectoryType) MarshalValueBuf added in v0.16.0 

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

type IdentityProviderDetails 

type IdentityProviderDetails struct {

	// Provides the type of InvocationRole used to authenticate the user account.
	InvocationRole *string `min:"20" type:"string"`

	// Provides 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 file transfer protocol-enabled server's users. A server can have only one method of authentication.

func (IdentityProviderDetails) String 

func (s IdentityProviderDetails) String() string

String returns the string representation

func (*IdentityProviderDetails) Validate added in v0.16.0 

func (s *IdentityProviderDetails) Validate() error

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

type IdentityProviderType 

type IdentityProviderType string

Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. For SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on the server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. The server can have only 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 a file transfer protocol-enabled
	// server.
	//
	// ServerId is a required field
	ServerId *string `min:"19" 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 file transfer
	// protocol-enabled servers.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 a file transfer protocol-enabled
	// server.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`

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

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

Identifies the user, the file transfer protocol-enabled 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 associated with.

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 the request type for the ImportSshPublicKey API operation.

func (ImportSshPublicKeyRequest) Send 

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

Send marshals and sends the ImportSshPublicKey API request.

type ImportSshPublicKeyResponse added in v0.9.0 

type ImportSshPublicKeyResponse struct {
	*ImportSshPublicKeyOutput
	// contains filtered or unexported fields
}

ImportSshPublicKeyResponse is the response type for the ImportSshPublicKey API operation.

func (*ImportSshPublicKeyResponse) SDKResponseMetdata added in v0.9.0 

func (r *ImportSshPublicKeyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ImportSshPublicKey request.

type ListServersInput 

type ListServersInput struct {

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

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

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 file transfer protocol-enabled
	// servers.
	NextToken *string `min:"1" type:"string"`

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

func (ListServersOutput) String 

func (s ListServersOutput) String() string

String returns the string representation

type ListServersPaginator added in v0.9.0 

type ListServersPaginator struct {
	aws.Pager
}

ListServersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListServersPaginator added in v0.9.0 

func NewListServersPaginator(req ListServersRequest) ListServersPaginator

NewListServersRequestPaginator returns a paginator for ListServers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListServersRequest(input)
p := transfer.NewListServersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListServersPaginator) CurrentPage added in v0.9.0 

func (p *ListServersPaginator) CurrentPage() *ListServersOutput

type ListServersRequest 

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

ListServersRequest is the request type for the ListServers API operation.

func (ListServersRequest) Send 

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

Send marshals and sends the ListServers API request.

type ListServersResponse added in v0.9.0 

type ListServersResponse struct {
	*ListServersOutput
	// contains filtered or unexported fields
}

ListServersResponse is the response type for the ListServers API operation.

func (*ListServersResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListServersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListServers 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 operation,
	// a NextToken parameter is returned in the input. You can then pass in a subsequent
	// command to the NextToken parameter to continue listing additional tags.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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 {

	// 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 to 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.
	Tags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourcePaginator added in v0.9.0 

type ListTagsForResourcePaginator struct {
	aws.Pager
}

ListTagsForResourcePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTagsForResourcePaginator added in v0.9.0 

func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator

NewListTagsForResourceRequestPaginator returns a paginator for ListTagsForResource. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListTagsForResourceRequest(input)
p := transfer.NewListTagsForResourceRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTagsForResourcePaginator) CurrentPage added in v0.9.0 

func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput

type ListTagsForResourceRequest 

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

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

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

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource 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
	// to the NextToken parameter to continue listing additional users.
	NextToken *string `min:"1" type:"string"`

	// A system-assigned unique identifier for a file transfer protocol-enabled
	// server that has users assigned to it.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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
	// to the NextToken parameter to continue listing additional users.
	NextToken *string `min:"1" type:"string"`

	// A system-assigned unique identifier for a file transfer protocol-enabled
	// server that the users are assigned to.
	//
	// ServerId is a required field
	ServerId *string `min:"19" 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) String 

func (s ListUsersOutput) String() string

String returns the string representation

type ListUsersPaginator added in v0.9.0 

type ListUsersPaginator struct {
	aws.Pager
}

ListUsersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListUsersPaginator added in v0.9.0 

func NewListUsersPaginator(req ListUsersRequest) ListUsersPaginator

NewListUsersRequestPaginator returns a paginator for ListUsers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListUsersRequest(input)
p := transfer.NewListUsersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListUsersPaginator) CurrentPage added in v0.9.0 

func (p *ListUsersPaginator) CurrentPage() *ListUsersOutput

type ListUsersRequest 

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

ListUsersRequest is the request type for the ListUsers API operation.

func (ListUsersRequest) Send 

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

Send marshals and sends the ListUsers API request.

type ListUsersResponse added in v0.9.0 

type ListUsersResponse struct {
	*ListUsersOutput
	// contains filtered or unexported fields
}

ListUsersResponse is the response type for the ListUsers API operation.

func (*ListUsersResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListUsersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListUsers request.

type ListedServer 

type ListedServer struct {

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

	// Specifies the type of VPC endpoint that your file transfer protocol-enabled
	// server is connected to. If your server is connected to a VPC endpoint, your
	// server isn't accessible over the public internet.
	EndpointType EndpointType `type:"string" enum:"true"`

	// Specifies the authentication method used to validate a user for a file transfer
	// protocol-enabled server that was specified. 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"`

	// Specifies the AWS Identity and Access Management (IAM) role that allows a
	// file transfer protocol-enabled server to turn on Amazon CloudWatch logging.
	LoggingRole *string `min:"20" type:"string"`

	// Specifies the unique system assigned identifier for a file transfer protocol-enabled
	// servers that were listed.
	ServerId *string `min:"19" type:"string"`

	// Specifies the condition of a file transfer protocol-enabled 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 indicate 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"`

	// Specifies the number of users that are assigned to a file transfer protocol-enabled
	// server you specified with the ServerId.
	UserCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Returns properties of a file transfer protocol-enabled server that was specified.

func (ListedServer) String 

func (s ListedServer) String() string

String returns the string representation

type ListedUser 

type ListedUser struct {

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

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

	// Specifies the type of landing directory (folder) you mapped for your users'
	// home directory. If you set it to PATH, the user will see the absolute Amazon
	// S3 bucket paths as is in their file transfer protocol clients. If you set
	// it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings
	// for how you want to make Amazon S3 paths visible to your users.
	HomeDirectoryType HomeDirectoryType `type:"string" enum:"true"`

	// Specifies the role that is in use by this user. A role is an AWS Identity
	// and Access Management (IAM) entity that, in this case, allows a file transfer
	// protocol-enabled 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 `min:"20" type:"string"`

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

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

Returns properties of the user that you specify.

func (ListedUser) String 

func (s ListedUser) String() string

String returns the string representation

type Protocol added in v0.22.0 

type Protocol string
const (
	ProtocolSftp Protocol = "SFTP"
	ProtocolFtp  Protocol = "FTP"
	ProtocolFtps Protocol = "FTPS"
)

Enum values for Protocol

func (Protocol) MarshalValue added in v0.22.0 

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

func (Protocol) MarshalValueBuf added in v0.22.0 

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

type SshPublicKey 

type SshPublicKey struct {

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

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

	// Specifies the SshPublicKeyId parameter contains the identifier of the public
	// key.
	//
	// SshPublicKeyId is a required field
	SshPublicKeyId *string `min:"21" 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 the specific file transfer protocol-enabled 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 server.

func (SshPublicKey) String 

func (s SshPublicKey) String() string

String returns the string representation

type StartServerInput 

type StartServerInput struct {

	// A system-assigned unique identifier for a file transfer protocol-enabled
	// server that you start.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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
}

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 the request type for the StartServer API operation.

func (StartServerRequest) Send 

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

Send marshals and sends the StartServer API request.

type StartServerResponse added in v0.9.0 

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

StartServerResponse is the response type for the StartServer API operation.

func (*StartServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartServer request.

type State 

type State string

Describes the condition of a file transfer protocol-enabled 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 server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the 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 the 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 a file transfer protocol-enabled
	// server that you stopped.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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
}

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 the request type for the StopServer API operation.

func (StopServerRequest) Send 

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

Send marshals and sends the StopServer API request.

type StopServerResponse added in v0.9.0 

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

StopServerResponse is the response type for the StopServer API operation.

func (*StopServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *StopServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopServer 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"`

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

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
}

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 the request type for the TagResource API operation.

func (TagResourceRequest) Send 

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

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type TestIdentityProviderInput 

type TestIdentityProviderInput struct {

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

	// The type of file transfer protocol to be tested.
	//
	// The available protocols are:
	//
	//    * Secure Shell (SSH) File Transfer Protocol (SFTP)
	//
	//    * File Transfer Protocol Secure (FTPS)
	//
	//    * File Transfer Protocol (FTP)
	ServerProtocol Protocol `type:"string" enum:"true"`

	// The source IP address of the user account to be tested.
	SourceIp *string `type:"string"`

	// The name of the user account to be tested.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`

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

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 {

	// A message that indicates whether the test was successful or not.
	Message *string `type:"string"`

	// The response that is returned from your API Gateway.
	Response *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) 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 the request type for the TestIdentityProvider API operation.

func (TestIdentityProviderRequest) Send 

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

Send marshals and sends the TestIdentityProvider API request.

type TestIdentityProviderResponse added in v0.9.0 

type TestIdentityProviderResponse struct {
	*TestIdentityProviderOutput
	// contains filtered or unexported fields
}

TestIdentityProviderResponse is the response type for the TestIdentityProvider API operation.

func (*TestIdentityProviderResponse) SDKResponseMetdata added in v0.9.0 

func (r *TestIdentityProviderResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TestIdentityProvider request.

type UntagResourceInput 

type UntagResourceInput struct {

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

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 the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

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

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateServerInput 

type UpdateServerInput struct {

	// The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
	// Required when Protocols is set to FTPS.
	//
	// To request a new public certificate, see Request a public certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html)
	// in the AWS Certificate Manager User Guide.
	//
	// To import an existing certificate into ACM, see Importing certificates into
	// ACM (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)
	// in the AWS Certificate Manager User Guide.
	//
	// To request a private certificate to use FTPS through private IP addresses,
	// see Request a private certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html)
	// in the AWS Certificate Manager User Guide.
	//
	// Certificates with the following cryptographic algorithms and key sizes are
	// supported:
	//
	//    * 2048-bit RSA (RSA_2048)
	//
	//    * 4096-bit RSA (RSA_4096)
	//
	//    * Elliptic Prime Curve 256 bit (EC_prime256v1)
	//
	//    * Elliptic Prime Curve 384 bit (EC_secp384r1)
	//
	//    * Elliptic Prime Curve 521 bit (EC_secp521r1)
	//
	// The certificate must be a valid SSL/TLS X.509 version 3 certificate with
	// FQDN or IP address specified and information about the issuer.
	Certificate *string `type:"string"`

	// The virtual private cloud (VPC) endpoint settings that are configured for
	// your file transfer protocol-enabled server. With a VPC endpoint, you can
	// restrict access to your server to resources only within your VPC. To control
	// incoming internet traffic, you will need to associate one or more Elastic
	// IP addresses with your server's endpoint.
	EndpointDetails *EndpointDetails `type:"structure"`

	// The type of endpoint that you want your file transfer protocol-enabled server
	// to connect to. You can choose to connect to the public internet or a VPC
	// endpoint. With a VPC endpoint, you can restrict access to your server and
	// resources only within your VPC.
	//
	// It is recommended that you use VPC as the EndpointType. With this endpoint
	// type, you have the option to directly associate up to three Elastic IPv4
	// addresses (BYO IP included) with your server's endpoint and use VPC security
	// groups to restrict traffic by the client's public IP address. This is not
	// possible with EndpointType set to VPC_ENDPOINT.
	EndpointType EndpointType `type:"string" enum:"true"`

	// The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.
	//
	// If you aren't planning to migrate existing users from an existing file transfer
	// protocol-enabled server to a new server, don't update the host key. Accidentally
	// changing a server's host key can be disruptive.
	//
	// For more information, see Change the host key for your SFTP-enabled server
	// (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key)
	// in the AWS Transfer Family User Guide.
	HostKey *string `type:"string" sensitive:"true"`

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

	// Specifies the file transfer protocol or protocols over which your file transfer
	// protocol client can connect to your server's endpoint. The available protocols
	// are:
	//
	//    * Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over
	//    SSH
	//
	//    * File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
	//
	//    * File Transfer Protocol (FTP): Unencrypted file transfer
	//
	// If you select FTPS, you must choose a certificate stored in AWS Certificate
	// Manager (ACM) which will be used to identify your server when clients connect
	// to it over FTPS.
	//
	// If Protocol includes either FTP or FTPS, then the EndpointType must be VPC
	// and the IdentityProviderType must be API_GATEWAY.
	//
	// If Protocol includes FTP, then AddressAllocationIds cannot be associated.
	//
	// If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and
	// the IdentityProviderType can be set to SERVICE_MANAGED.
	Protocols []Protocol `min:"1" type:"list"`

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

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 a file transfer protocol-enabled
	// server that the user account is assigned to.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 the request type for the UpdateServer API operation.

func (UpdateServerRequest) Send 

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

Send marshals and sends the UpdateServer API request.

type UpdateServerResponse added in v0.9.0 

type UpdateServerResponse struct {
	*UpdateServerOutput
	// contains filtered or unexported fields
}

UpdateServerResponse is the response type for the UpdateServer API operation.

func (*UpdateServerResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateServerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateServer request.

type UpdateUserInput 

type UpdateUserInput struct {

	// Specifies the landing directory (folder) for a user when they log in to the
	// file transfer protocol-enabled server using their file transfer protocol
	// client.
	//
	// An example is your-Amazon-S3-bucket-name>/home/username.
	HomeDirectory *string `type:"string"`

	// Logical directory mappings that specify what Amazon S3 paths and keys should
	// be visible to your user and how you want to make them visible. You will need
	// to specify the "Entry" and "Target" pair, where Entry shows how the path
	// is made visible and Target is the actual Amazon S3 path. If you only specify
	// a target, it will be displayed as is. You will need to also make sure that
	// your IAM role provides access to paths in Target. The following is an example.
	//
	// '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target":
	// "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'
	//
	// In most cases, you can use this value instead of the scope-down policy to
	// lock your user down to the designated home directory ("chroot"). To do this,
	// you can set Entry to '/' and set Target to the HomeDirectory parameter value.
	//
	// If the target of a logical directory entry does not exist in Amazon S3, the
	// entry will be ignored. As a workaround, you can use the Amazon S3 api to
	// create 0 byte objects as place holders for your directory. If using the CLI,
	// use the s3api call instead of s3 so you can use the put-object operation.
	// For example, you use the following: aws s3api put-object --bucket bucketname
	// --key path/to/folder/. Make sure that the end of the key name ends in a /
	// for it to be considered a folder.
	HomeDirectoryMappings []HomeDirectoryMapEntry `min:"1" type:"list"`

	// The type of landing directory (folder) you want your users' home directory
	// to be when they log into the file transfer protocol-enabled server. If you
	// set it to PATH, the user will see the absolute Amazon S3 bucket paths as
	// is in their file transfer protocol clients. If you set it LOGICAL, you will
	// need to provide mappings in the HomeDirectoryMappings for how you want to
	// make Amazon S3 paths visible to your users.
	HomeDirectoryType HomeDirectoryType `type:"string" enum:"true"`

	// Allows you to supply a scope-down policy for your user so you can use the
	// same IAM role across multiple users. The policy scopes down user access to
	// portions of your Amazon S3 bucket. Variables you can use inside this policy
	// include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
	//
	// For scope-down policies, AWS Transfer Family stores the policy as a JSON
	// blob, instead of the Amazon Resource Name (ARN) of the policy. You save the
	// policy as a JSON blob and pass it in the Policy argument.
	//
	// For an example of a scope-down policy, see Creating a scope-down policy (https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down).
	//
	// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
	// in the AWS Security Token Service API Reference.
	Policy *string `type:"string"`

	// The IAM role that controls your users' 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 file transfer protocol-enabled server to access your resources
	// when servicing your users' transfer requests.
	Role *string `min:"20" type:"string"`

	// A system-assigned unique identifier for a file transfer protocol-enabled
	// server instance that the user account is assigned to.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`

	// A unique string that identifies a user and is associated with a file transfer
	// protocol-enabled server as specified by the ServerId. This is the string
	// that will be used by your user when they log in to your 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 `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 a file transfer protocol-enabled
	// server instance that the user account is assigned to.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`

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

UpdateUserResponse returns the user name and file transfer protocol-enabled server identifier for the request to update a user's properties.

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 the request type for the UpdateUser API operation.

func (UpdateUserRequest) Send 

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

Send marshals and sends the UpdateUser API request.

type UpdateUserResponse added in v0.9.0 

type UpdateUserResponse struct {
	*UpdateUserOutput
	// contains filtered or unexported fields
}

UpdateUserResponse is the response type for the UpdateUser API operation.

func (*UpdateUserResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateUserResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateUser request.

Source Files

View all Source files

Directories

Path Synopsis
Package transferiface provides an interface to enable mocking the AWS Transfer Family service client for testing your code.
 Package transferiface provides an interface to enable mocking the AWS Transfer Family 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.