transfer

package
v1.40.52 Latest Latest
Warning

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

 Go to latest Published: Sep 29, 2021 License: Apache-2.0 Imports: 10 Imported by: 56

Documentation

Overview

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

Amazon Web Services Transfer Family is a fully managed service that enables the transfer of files over 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). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services 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 Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Amazon Web Services 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 contact AWS Transfer Family 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 Family client Transfer for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/transfer/#New

Index

Constants

View Source 
const (
	// CustomStepStatusSuccess is a CustomStepStatus enum value
	CustomStepStatusSuccess = "SUCCESS"

	// CustomStepStatusFailure is a CustomStepStatus enum value
	CustomStepStatusFailure = "FAILURE"
)
View Source 
const (
	// DomainS3 is a Domain enum value
	DomainS3 = "S3"

	// DomainEfs is a Domain enum value
	DomainEfs = "EFS"
)
View Source 
const (
	// EndpointTypePublic is a EndpointType enum value
	EndpointTypePublic = "PUBLIC"

	// EndpointTypeVpc is a EndpointType enum value
	EndpointTypeVpc = "VPC"

	// EndpointTypeVpcEndpoint is a EndpointType enum value
	EndpointTypeVpcEndpoint = "VPC_ENDPOINT"
)
View Source 
const (
	// ExecutionStatusInProgress is a ExecutionStatus enum value
	ExecutionStatusInProgress = "IN_PROGRESS"

	// ExecutionStatusCompleted is a ExecutionStatus enum value
	ExecutionStatusCompleted = "COMPLETED"

	// ExecutionStatusException is a ExecutionStatus enum value
	ExecutionStatusException = "EXCEPTION"

	// ExecutionStatusHandlingException is a ExecutionStatus enum value
	ExecutionStatusHandlingException = "HANDLING_EXCEPTION"
)
View Source 
const (
	// HomeDirectoryTypePath is a HomeDirectoryType enum value
	HomeDirectoryTypePath = "PATH"

	// HomeDirectoryTypeLogical is a HomeDirectoryType enum value
	HomeDirectoryTypeLogical = "LOGICAL"
)
View Source 
const (
	// IdentityProviderTypeServiceManaged is a IdentityProviderType enum value
	IdentityProviderTypeServiceManaged = "SERVICE_MANAGED"

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

	// IdentityProviderTypeAwsDirectoryService is a IdentityProviderType enum value
	IdentityProviderTypeAwsDirectoryService = "AWS_DIRECTORY_SERVICE"
)

Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. For AWS_DIRECTORY_SERVICE or 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.

View Source 
const (
	// OverwriteExistingTrue is a OverwriteExisting enum value
	OverwriteExistingTrue = "TRUE"

	// OverwriteExistingFalse is a OverwriteExisting enum value
	OverwriteExistingFalse = "FALSE"
)
View Source 
const (
	// ProtocolSftp is a Protocol enum value
	ProtocolSftp = "SFTP"

	// ProtocolFtp is a Protocol enum value
	ProtocolFtp = "FTP"

	// ProtocolFtps is a Protocol enum value
	ProtocolFtps = "FTPS"
)
View Source 
const (
	// StateOffline is a State enum value
	StateOffline = "OFFLINE"

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

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

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

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

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

Describes the condition of 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.

View Source 
const (
	// WorkflowStepTypeCopy is a WorkflowStepType enum value
	WorkflowStepTypeCopy = "COPY"

	// WorkflowStepTypeCustom is a WorkflowStepType enum value
	WorkflowStepTypeCustom = "CUSTOM"

	// WorkflowStepTypeTag is a WorkflowStepType enum value
	WorkflowStepTypeTag = "TAG"

	// WorkflowStepTypeDelete is a WorkflowStepType enum value
	WorkflowStepTypeDelete = "DELETE"
)
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 UpdateServer 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 Amazon Web ServicesTransfer
	// 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 Amazon Web ServicesTransfer
	// Family service.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The request has failed because the Amazon Web ServicesTransfer 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"
)
View Source 
const (
	ServiceName = "Transfer" // Name of service.
	EndpointsID = "transfer" // ID to lookup a service endpoint with.
	ServiceID   = "Transfer" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ExecutionErrorTypePermissionDenied is a ExecutionErrorType enum value
	ExecutionErrorTypePermissionDenied = "PERMISSION_DENIED"
)

Variables

This section is empty.

Functions

func CustomStepStatus_Values added in v1.40.36 

func CustomStepStatus_Values() []string

CustomStepStatus_Values returns all elements of the CustomStepStatus enum

func Domain_Values added in v1.36.22 

func Domain_Values() []string

Domain_Values returns all elements of the Domain enum

func EndpointType_Values added in v1.34.3 

func EndpointType_Values() []string

EndpointType_Values returns all elements of the EndpointType enum

func ExecutionErrorType_Values added in v1.40.36 

func ExecutionErrorType_Values() []string

ExecutionErrorType_Values returns all elements of the ExecutionErrorType enum

func ExecutionStatus_Values added in v1.40.36 

func ExecutionStatus_Values() []string

ExecutionStatus_Values returns all elements of the ExecutionStatus enum

func HomeDirectoryType_Values added in v1.34.3 

func HomeDirectoryType_Values() []string

HomeDirectoryType_Values returns all elements of the HomeDirectoryType enum

func IdentityProviderType_Values added in v1.34.3 

func IdentityProviderType_Values() []string

IdentityProviderType_Values returns all elements of the IdentityProviderType enum

func OverwriteExisting_Values added in v1.40.36 

func OverwriteExisting_Values() []string

OverwriteExisting_Values returns all elements of the OverwriteExisting enum

func Protocol_Values added in v1.34.3 

func Protocol_Values() []string

Protocol_Values returns all elements of the Protocol enum

func State_Values added in v1.34.3 

func State_Values() []string

State_Values returns all elements of the State enum

func WorkflowStepType_Values added in v1.40.36 

func WorkflowStepType_Values() []string

WorkflowStepType_Values returns all elements of the WorkflowStepType enum

Types

type AccessDeniedException added in v1.30.13 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code added in v1.30.13 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.30.13 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.30.13 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.30.13 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.30.13 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.30.13 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.30.13 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.30.13 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException added in v1.28.0 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

This exception is thrown when the UpdateServer 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.

func (*ConflictException) Code added in v1.28.0 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.28.0 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.28.0 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.28.0 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.28.0 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopyStepDetails added in v1.40.36 

type CopyStepDetails struct {

	// Specifies the location for the file being copied. Only applicable for the
	// Copy type of workflow steps.
	DestinationFileLocation *InputFileLocation `type:"structure"`

	// The name of the step, used as an identifier.
	Name *string `type:"string"`

	// A flag that indicates whether or not to overwrite an existing file of the
	// same name. The default is FALSE.
	OverwriteExisting *string `type:"string" enum:"OverwriteExisting"`
	// contains filtered or unexported fields
}

Each step type has its own StepDetails structure.

func (CopyStepDetails) GoString added in v1.40.36 

func (s CopyStepDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyStepDetails) SetDestinationFileLocation added in v1.40.36 

func (s *CopyStepDetails) SetDestinationFileLocation(v *InputFileLocation) *CopyStepDetails

SetDestinationFileLocation sets the DestinationFileLocation field's value.

func (*CopyStepDetails) SetName added in v1.40.36 

func (s *CopyStepDetails) SetName(v string) *CopyStepDetails

SetName sets the Name field's value.

func (*CopyStepDetails) SetOverwriteExisting added in v1.40.36 

func (s *CopyStepDetails) SetOverwriteExisting(v string) *CopyStepDetails

SetOverwriteExisting sets the OverwriteExisting field's value.

func (CopyStepDetails) String added in v1.40.36 

func (s CopyStepDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyStepDetails) Validate added in v1.40.36 

func (s *CopyStepDetails) Validate() error

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

type CreateAccessInput added in v1.38.47 

type CreateAccessInput struct {

	// A unique identifier that is required to identify specific groups within your
	// directory. The users of the group that you associate have access to your
	// Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
	// Web Services Transfer Family. If you know the group name, you can view the
	// SID values by running the following command using Windows PowerShell.
	//
	// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
	// | Select SamAccountName,ObjectSid
	//
	// In that command, replace YourGroupName with the name of your Active Directory
	// group.
	//
	// The regex used to validate this parameter is a string of characters consisting
	// of uppercase and lowercase alphanumeric characters with no spaces. You can
	// also include underscores or any of the following characters: =,.@:/-
	//
	// ExternalId is a required field
	ExternalId *string `min:"1" type:"string" required:"true"`

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

	// Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
	// and keys should be visible to your user and how you want to make them visible.
	// You must specify the Entry and Target pair, where Entry shows how the path
	// is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
	// you only specify a target, it is displayed as is. You also must ensure that
	// your Amazon Web Services Identity and Access Management (IAM) role provides
	// access to paths in Target. This value can only be set when HomeDirectoryType
	// is set to LOGICAL.
	//
	// The following is an Entry and Target pair example.
	//
	// [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
	//
	// In most cases, you can use this value instead of the session policy to lock
	// down your user to the designated home directory ("chroot"). To do this, you
	// can set Entry to / and set Target to the HomeDirectory parameter value.
	//
	// The following is an Entry and Target pair example for chroot.
	//
	// [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
	//
	// If the target of a logical directory entry does not exist in Amazon S3 or
	// EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
	// or EFS API to create 0 byte objects as place holders for your directory.
	// If using the CLI, use the s3api or efsapi call instead of s3 or efs 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 server. If you set it to PATH, the user will
	// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
	// protocol clients. If you set it LOGICAL, you need to provide mappings in
	// the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths
	// visible to your users.
	HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"`

	// A session policy for your user so that 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}.
	//
	// This only applies when the domain of ServerId is S3. EFS does not use session
	// policies.
	//
	// For session policies, Amazon Web Services 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 session policy, see Example session policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html).
	//
	// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
	// in the Amazon Web Services Security Token Service API Reference.
	Policy *string `type:"string"`

	// The full POSIX identity, including user ID (Uid), group ID (Gid), and any
	// secondary groups IDs (SecondaryGids), that controls your users' access to
	// your Amazon EFS file systems. The POSIX permissions that are set on files
	// and directories in your file system determine the level of access your users
	// get when transferring files into and out of your Amazon EFS file systems.
	PosixProfile *PosixProfile `type:"structure"`

	// Specifies the Amazon Resource Name (ARN) of the IAM role that controls your
	// users' access to your Amazon S3 bucket or EFS file system. The policies attached
	// to this role determine the level of access that you want to provide your
	// users when transferring files into and out of your Amazon S3 bucket or EFS
	// file system. The IAM role should also contain a trust relationship that allows
	// the 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 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"`
	// contains filtered or unexported fields
}

func (CreateAccessInput) GoString added in v1.38.47 

func (s CreateAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessInput) SetExternalId added in v1.38.47 

func (s *CreateAccessInput) SetExternalId(v string) *CreateAccessInput

SetExternalId sets the ExternalId field's value.

func (*CreateAccessInput) SetHomeDirectory added in v1.38.47 

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

SetHomeDirectory sets the HomeDirectory field's value.

func (*CreateAccessInput) SetHomeDirectoryMappings added in v1.38.47 

func (s *CreateAccessInput) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *CreateAccessInput

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*CreateAccessInput) SetHomeDirectoryType added in v1.38.47 

func (s *CreateAccessInput) SetHomeDirectoryType(v string) *CreateAccessInput

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*CreateAccessInput) SetPolicy added in v1.38.47 

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

SetPolicy sets the Policy field's value.

func (*CreateAccessInput) SetPosixProfile added in v1.38.47 

func (s *CreateAccessInput) SetPosixProfile(v *PosixProfile) *CreateAccessInput

SetPosixProfile sets the PosixProfile field's value.

func (*CreateAccessInput) SetRole added in v1.38.47 

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

SetRole sets the Role field's value.

func (*CreateAccessInput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (CreateAccessInput) String added in v1.38.47 

func (s CreateAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessInput) Validate added in v1.38.47 

func (s *CreateAccessInput) Validate() error

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

type CreateAccessOutput added in v1.38.47 

type CreateAccessOutput struct {

	// The external ID of the group whose users have access to your Amazon S3 or
	// Amazon EFS resources over the enabled protocols using Amazon Web Services
	// Transfer Family.
	//
	// ExternalId is a required field
	ExternalId *string `min:"1" type:"string" required:"true"`

	// The ID of the server that the user is attached to.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAccessOutput) GoString added in v1.38.47 

func (s CreateAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessOutput) SetExternalId added in v1.38.47 

func (s *CreateAccessOutput) SetExternalId(v string) *CreateAccessOutput

SetExternalId sets the ExternalId field's value.

func (*CreateAccessOutput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (CreateAccessOutput) String added in v1.38.47 

func (s CreateAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateServerInput 

type CreateServerInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 domain of the storage system that is used for file transfers. There are
	// two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon
	// Elastic File System (Amazon EFS). The default value is S3.
	//
	// After the server is created, the domain cannot be changed.
	Domain *string `type:"string" enum:"Domain"`

	// The virtual private cloud (VPC) endpoint settings that are configured for
	// your 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 IP
	// addresses 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 endpoint that you want your server to use. You can choose to
	// make your server's endpoint publicly accessible (PUBLIC) or host it inside
	// your VPC. With an endpoint that is hosted in a VPC, you can restrict access
	// to your server and resources only within your VPC or choose to make it internet
	// facing by attaching Elastic IP addresses directly to it.
	//
	// After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
	// in your Amazon Web Services account if your account hasn't already done so
	// before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
	// in your Amazon Web Services account on or before May 19, 2021, you will not
	// be affected. After this date, use EndpointType=VPC.
	//
	// For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
	//
	// 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 *string `type:"string" enum:"EndpointType"`

	// 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 Amazon Web Services Transfer Family User Guide.
	//
	// HostKey is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateServerInput's
	// String and GoString methods.
	HostKey *string `type:"string" sensitive:"true"`

	// Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY.
	// Accepts an array containing all of the information required to use a directory
	// in AWS_DIRECTORY_SERVICE or invoke 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 server. The default value is SERVICE_MANAGED,
	// which allows you to store and access user credentials within the Amazon Web
	// Services Transfer Family service.
	//
	// Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in
	// Amazon Web Services Managed Active Directory or Microsoft Active Directory
	// in your on-premises environment or in Amazon Web Services using AD Connectors.
	// This option also requires you to provide a Directory ID using the IdentityProviderDetails
	// parameter.
	//
	// 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 *string `type:"string" enum:"IdentityProviderType"`

	// Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
	// and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
	// logging for Amazon S3 or Amazon EFS 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
	//
	// If you select FTPS, you must choose a certificate stored in Amazon Web Services
	// Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 []*string `min:"1" type:"list"`

	// Specifies the name of the security policy that is attached to the server.
	SecurityPolicyName *string `type:"string"`

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

	// Specifies the workflow ID for the workflow to assign and the execution role
	// used for executing the workflow.
	WorkflowDetails *WorkflowDetails `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateServerInput) GoString 

func (s CreateServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateServerInput) SetCertificate added in v1.30.13 

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

SetCertificate sets the Certificate field's value.

func (*CreateServerInput) SetDomain added in v1.36.22 

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

SetDomain sets the Domain field's value.

func (*CreateServerInput) SetEndpointDetails added in v1.19.3 

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

SetEndpointDetails sets the EndpointDetails field's value.

func (*CreateServerInput) SetEndpointType added in v1.19.3 

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

SetEndpointType sets the EndpointType field's value.

func (*CreateServerInput) SetHostKey added in v1.19.20 

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

SetHostKey sets the HostKey field's value.

func (*CreateServerInput) SetIdentityProviderDetails 

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

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.

func (*CreateServerInput) SetIdentityProviderType 

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

SetIdentityProviderType sets the IdentityProviderType field's value.

func (*CreateServerInput) SetLoggingRole 

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

SetLoggingRole sets the LoggingRole field's value.

func (*CreateServerInput) SetProtocols added in v1.30.13 

func (s *CreateServerInput) SetProtocols(v []*string) *CreateServerInput

SetProtocols sets the Protocols field's value.

func (*CreateServerInput) SetSecurityPolicyName added in v1.34.3 

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

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*CreateServerInput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreateServerInput) SetWorkflowDetails added in v1.40.36 

func (s *CreateServerInput) SetWorkflowDetails(v *WorkflowDetails) *CreateServerInput

SetWorkflowDetails sets the WorkflowDetails field's value.

func (CreateServerInput) String 

func (s CreateServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (CreateServerOutput) GoString 

func (s CreateServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateServerOutput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (CreateServerOutput) String 

func (s CreateServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateUserInput 

type CreateUserInput struct {

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

	// Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
	// and keys should be visible to your user and how you want to make them visible.
	// You must specify the Entry and Target pair, where Entry shows how the path
	// is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
	// you only specify a target, it is displayed as is. You also must ensure that
	// your Amazon Web Services Identity and Access Management (IAM) role provides
	// access to paths in Target. This value can only be set when HomeDirectoryType
	// is set to LOGICAL.
	//
	// The following is an Entry and Target pair example.
	//
	// [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
	//
	// In most cases, you can use this value instead of the session 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.
	//
	// The following is an Entry and Target pair example for chroot.
	//
	// [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
	//
	// If the target of a logical directory entry does not exist in Amazon S3 or
	// EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
	// or EFS API to create 0 byte objects as place holders for your directory.
	// If using the CLI, use the s3api or efsapi call instead of s3 or efs 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 server. If you set it to PATH, the user will
	// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
	// protocol clients. If you set it LOGICAL, you need to provide mappings in
	// the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths
	// visible to your users.
	HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"`

	// A session policy for your user so that 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}.
	//
	// This only applies when the domain of ServerId is S3. EFS does not use session
	// policies.
	//
	// For session policies, Amazon Web Services 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 session policy, see Example session policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html).
	//
	// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
	// in the Amazon Web Services Security Token Service API Reference.
	Policy *string `type:"string"`

	// Specifies the full POSIX identity, including user ID (Uid), group ID (Gid),
	// and any secondary groups IDs (SecondaryGids), that controls your users' access
	// to your Amazon EFS file systems. The POSIX permissions that are set on files
	// and directories in Amazon EFS determine the level of access your users get
	// when transferring files into and out of your Amazon EFS file systems.
	PosixProfile *PosixProfile `type:"structure"`

	// Specifies the Amazon Resource Name (ARN) of the IAM role that controls your
	// users' access to your Amazon S3 bucket or EFS file system. The policies attached
	// to this role determine the level of access that you want to provide your
	// users when transferring files into and out of your Amazon S3 bucket or EFS
	// file system. The IAM role should also contain a trust relationship that allows
	// the 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 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 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 ServerId.
	// This user name must be a minimum of 3 and a maximum of 100 characters long.
	// The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
	// '-', period '.', and at sign '@'. The user name can't start with a hyphen,
	// period, or at sign.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateUserInput) GoString 

func (s CreateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserInput) SetHomeDirectory 

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

SetHomeDirectory sets the HomeDirectory field's value.

func (*CreateUserInput) SetHomeDirectoryMappings added in v1.25.20 

func (s *CreateUserInput) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *CreateUserInput

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*CreateUserInput) SetHomeDirectoryType added in v1.25.20 

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

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*CreateUserInput) SetPolicy 

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

SetPolicy sets the Policy field's value.

func (*CreateUserInput) SetPosixProfile added in v1.36.22 

func (s *CreateUserInput) SetPosixProfile(v *PosixProfile) *CreateUserInput

SetPosixProfile sets the PosixProfile field's value.

func (*CreateUserInput) SetRole 

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

SetRole sets the Role field's value.

func (*CreateUserInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*CreateUserInput) SetSshPublicKeyBody 

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

SetSshPublicKeyBody sets the SshPublicKeyBody field's value.

func (*CreateUserInput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreateUserInput) SetUserName 

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

SetUserName sets the UserName field's value.

func (CreateUserInput) String 

func (s CreateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (CreateUserOutput) GoString 

func (s CreateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserOutput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*CreateUserOutput) SetUserName 

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

SetUserName sets the UserName field's value.

func (CreateUserOutput) String 

func (s CreateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkflowInput added in v1.40.36 

type CreateWorkflowInput struct {

	// A textual description for the workflow.
	Description *string `type:"string"`

	// Specifies the steps (actions) to take if errors are encountered during execution
	// of the workflow.
	//
	// For custom steps, the lambda function needs to send FAILURE to the call back
	// API to kick off the exception steps. Additionally, if the lambda does not
	// send SUCCESS before it times out, the exception steps are executed.
	OnExceptionSteps []*WorkflowStep `type:"list"`

	// Specifies the details for the steps that are in the specified workflow.
	//
	// The TYPE specifies which of the following actions is being taken for this
	// step.
	//
	//    * Copy: copy the file to another location
	//
	//    * Custom: custom step with a lambda target
	//
	//    * Delete: delete the file
	//
	//    * Tag: add a tag to the file
	//
	// Currently, copying and tagging are supported only on S3.
	//
	// For file location, you specify either the S3 bucket and key, or the EFS filesystem
	// ID and path.
	//
	// Steps is a required field
	Steps []*WorkflowStep `type:"list" required:"true"`

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

func (CreateWorkflowInput) GoString added in v1.40.36 

func (s CreateWorkflowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkflowInput) SetDescription added in v1.40.36 

func (s *CreateWorkflowInput) SetDescription(v string) *CreateWorkflowInput

SetDescription sets the Description field's value.

func (*CreateWorkflowInput) SetOnExceptionSteps added in v1.40.36 

func (s *CreateWorkflowInput) SetOnExceptionSteps(v []*WorkflowStep) *CreateWorkflowInput

SetOnExceptionSteps sets the OnExceptionSteps field's value.

func (*CreateWorkflowInput) SetSteps added in v1.40.36 

func (s *CreateWorkflowInput) SetSteps(v []*WorkflowStep) *CreateWorkflowInput

SetSteps sets the Steps field's value.

func (*CreateWorkflowInput) SetTags added in v1.40.36 

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

SetTags sets the Tags field's value.

func (CreateWorkflowInput) String added in v1.40.36 

func (s CreateWorkflowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkflowInput) Validate added in v1.40.36 

func (s *CreateWorkflowInput) Validate() error

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

type CreateWorkflowOutput added in v1.40.36 

type CreateWorkflowOutput struct {

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkflowOutput) GoString added in v1.40.36 

func (s CreateWorkflowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkflowOutput) SetWorkflowId added in v1.40.36 

func (s *CreateWorkflowOutput) SetWorkflowId(v string) *CreateWorkflowOutput

SetWorkflowId sets the WorkflowId field's value.

func (CreateWorkflowOutput) String added in v1.40.36 

func (s CreateWorkflowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomStepDetails added in v1.40.36 

type CustomStepDetails struct {

	// The name of the step, used as an identifier.
	Name *string `type:"string"`

	// The ARN for the lambda function that is being called.
	Target *string `type:"string"`

	// Timeout, in seconds, for the step.
	TimeoutSeconds *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Each step type has its own StepDetails structure.

func (CustomStepDetails) GoString added in v1.40.36 

func (s CustomStepDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomStepDetails) SetName added in v1.40.36 

func (s *CustomStepDetails) SetName(v string) *CustomStepDetails

SetName sets the Name field's value.

func (*CustomStepDetails) SetTarget added in v1.40.36 

func (s *CustomStepDetails) SetTarget(v string) *CustomStepDetails

SetTarget sets the Target field's value.

func (*CustomStepDetails) SetTimeoutSeconds added in v1.40.36 

func (s *CustomStepDetails) SetTimeoutSeconds(v int64) *CustomStepDetails

SetTimeoutSeconds sets the TimeoutSeconds field's value.

func (CustomStepDetails) String added in v1.40.36 

func (s CustomStepDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomStepDetails) Validate added in v1.40.36 

func (s *CustomStepDetails) Validate() error

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

type DeleteAccessInput added in v1.38.47 

type DeleteAccessInput struct {

	// A unique identifier that is required to identify specific groups within your
	// directory. The users of the group that you associate have access to your
	// Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
	// Web Services Transfer Family. If you know the group name, you can view the
	// SID values by running the following command using Windows PowerShell.
	//
	// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
	// | Select SamAccountName,ObjectSid
	//
	// In that command, replace YourGroupName with the name of your Active Directory
	// group.
	//
	// The regex used to validate this parameter is a string of characters consisting
	// of uppercase and lowercase alphanumeric characters with no spaces. You can
	// also include underscores or any of the following characters: =,.@:/-
	//
	// ExternalId is a required field
	ExternalId *string `min:"1" type:"string" required:"true"`

	// A system-assigned unique identifier for a server that has this user assigned.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAccessInput) GoString added in v1.38.47 

func (s DeleteAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessInput) SetExternalId added in v1.38.47 

func (s *DeleteAccessInput) SetExternalId(v string) *DeleteAccessInput

SetExternalId sets the ExternalId field's value.

func (*DeleteAccessInput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (DeleteAccessInput) String added in v1.38.47 

func (s DeleteAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessInput) Validate added in v1.38.47 

func (s *DeleteAccessInput) Validate() error

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

type DeleteAccessOutput added in v1.38.47 

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

func (DeleteAccessOutput) GoString added in v1.38.47 

func (s DeleteAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAccessOutput) String added in v1.38.47 

func (s DeleteAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteServerInput 

type DeleteServerInput struct {

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

func (DeleteServerInput) GoString 

func (s DeleteServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteServerInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (DeleteServerInput) String 

func (s DeleteServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteServerOutput) String 

func (s DeleteServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteSshPublicKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSshPublicKeyInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*DeleteSshPublicKeyInput) SetSshPublicKeyId 

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

SetSshPublicKeyId sets the SshPublicKeyId field's value.

func (*DeleteSshPublicKeyInput) SetUserName 

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

SetUserName sets the UserName field's value.

func (DeleteSshPublicKeyInput) String 

func (s DeleteSshPublicKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteSshPublicKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSshPublicKeyOutput) String 

func (s DeleteSshPublicKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStepDetails added in v1.40.36 

type DeleteStepDetails struct {

	// The name of the step, used as an identifier.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

The name of the step, used to identify the delete step.

func (DeleteStepDetails) GoString added in v1.40.36 

func (s DeleteStepDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStepDetails) SetName added in v1.40.36 

func (s *DeleteStepDetails) SetName(v string) *DeleteStepDetails

SetName sets the Name field's value.

func (DeleteStepDetails) String added in v1.40.36 

func (s DeleteStepDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteUserInput 

type DeleteUserInput struct {

	// A system-assigned unique identifier for a 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 server.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserInput) GoString 

func (s DeleteUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*DeleteUserInput) SetUserName 

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

SetUserName sets the UserName field's value.

func (DeleteUserInput) String 

func (s DeleteUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkflowInput added in v1.40.36 

type DeleteWorkflowInput struct {

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWorkflowInput) GoString added in v1.40.36 

func (s DeleteWorkflowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkflowInput) SetWorkflowId added in v1.40.36 

func (s *DeleteWorkflowInput) SetWorkflowId(v string) *DeleteWorkflowInput

SetWorkflowId sets the WorkflowId field's value.

func (DeleteWorkflowInput) String added in v1.40.36 

func (s DeleteWorkflowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkflowInput) Validate added in v1.40.36 

func (s *DeleteWorkflowInput) Validate() error

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

type DeleteWorkflowOutput added in v1.40.36 

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

func (DeleteWorkflowOutput) GoString added in v1.40.36 

func (s DeleteWorkflowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkflowOutput) String added in v1.40.36 

func (s DeleteWorkflowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccessInput added in v1.38.47 

type DescribeAccessInput struct {

	// A unique identifier that is required to identify specific groups within your
	// directory. The users of the group that you associate have access to your
	// Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
	// Web Services Transfer Family. If you know the group name, you can view the
	// SID values by running the following command using Windows PowerShell.
	//
	// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
	// | Select SamAccountName,ObjectSid
	//
	// In that command, replace YourGroupName with the name of your Active Directory
	// group.
	//
	// The regex used to validate this parameter is a string of characters consisting
	// of uppercase and lowercase alphanumeric characters with no spaces. You can
	// also include underscores or any of the following characters: =,.@:/-
	//
	// ExternalId is a required field
	ExternalId *string `min:"1" type:"string" required:"true"`

	// A system-assigned unique identifier for a server that has this access assigned.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAccessInput) GoString added in v1.38.47 

func (s DescribeAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessInput) SetExternalId added in v1.38.47 

func (s *DescribeAccessInput) SetExternalId(v string) *DescribeAccessInput

SetExternalId sets the ExternalId field's value.

func (*DescribeAccessInput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (DescribeAccessInput) String added in v1.38.47 

func (s DescribeAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessInput) Validate added in v1.38.47 

func (s *DescribeAccessInput) Validate() error

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

type DescribeAccessOutput added in v1.38.47 

type DescribeAccessOutput struct {

	// The external ID of the server that the access is attached to.
	//
	// Access is a required field
	Access *DescribedAccess `type:"structure" required:"true"`

	// A system-assigned unique identifier for a server that has this access assigned.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAccessOutput) GoString added in v1.38.47 

func (s DescribeAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessOutput) SetAccess added in v1.38.47 

func (s *DescribeAccessOutput) SetAccess(v *DescribedAccess) *DescribeAccessOutput

SetAccess sets the Access field's value.

func (*DescribeAccessOutput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (DescribeAccessOutput) String added in v1.38.47 

func (s DescribeAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExecutionInput added in v1.40.36 

type DescribeExecutionInput struct {

	// A unique identifier for the execution of a workflow.
	//
	// ExecutionId is a required field
	ExecutionId *string `min:"36" type:"string" required:"true"`

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeExecutionInput) GoString added in v1.40.36 

func (s DescribeExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExecutionInput) SetExecutionId added in v1.40.36 

func (s *DescribeExecutionInput) SetExecutionId(v string) *DescribeExecutionInput

SetExecutionId sets the ExecutionId field's value.

func (*DescribeExecutionInput) SetWorkflowId added in v1.40.36 

func (s *DescribeExecutionInput) SetWorkflowId(v string) *DescribeExecutionInput

SetWorkflowId sets the WorkflowId field's value.

func (DescribeExecutionInput) String added in v1.40.36 

func (s DescribeExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExecutionInput) Validate added in v1.40.36 

func (s *DescribeExecutionInput) Validate() error

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

type DescribeExecutionOutput added in v1.40.36 

type DescribeExecutionOutput struct {

	// The structure that contains the details of the workflow' execution.
	//
	// Execution is a required field
	Execution *DescribedExecution `type:"structure" required:"true"`

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeExecutionOutput) GoString added in v1.40.36 

func (s DescribeExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExecutionOutput) SetExecution added in v1.40.36 

func (s *DescribeExecutionOutput) SetExecution(v *DescribedExecution) *DescribeExecutionOutput

SetExecution sets the Execution field's value.

func (*DescribeExecutionOutput) SetWorkflowId added in v1.40.36 

func (s *DescribeExecutionOutput) SetWorkflowId(v string) *DescribeExecutionOutput

SetWorkflowId sets the WorkflowId field's value.

func (DescribeExecutionOutput) String added in v1.40.36 

func (s DescribeExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSecurityPolicyInput added in v1.34.3 

type DescribeSecurityPolicyInput struct {

	// Specifies the name of the security policy that is attached to the server.
	//
	// SecurityPolicyName is a required field
	SecurityPolicyName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSecurityPolicyInput) GoString added in v1.34.3 

func (s DescribeSecurityPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityPolicyInput) SetSecurityPolicyName added in v1.34.3 

func (s *DescribeSecurityPolicyInput) SetSecurityPolicyName(v string) *DescribeSecurityPolicyInput

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (DescribeSecurityPolicyInput) String added in v1.34.3 

func (s DescribeSecurityPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityPolicyInput) Validate added in v1.34.3 

func (s *DescribeSecurityPolicyInput) Validate() error

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

type DescribeSecurityPolicyOutput added in v1.34.3 

type DescribeSecurityPolicyOutput struct {

	// An array containing the properties of the security policy.
	//
	// SecurityPolicy is a required field
	SecurityPolicy *DescribedSecurityPolicy `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSecurityPolicyOutput) GoString added in v1.34.3 

func (s DescribeSecurityPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityPolicyOutput) SetSecurityPolicy added in v1.34.3 

func (s *DescribeSecurityPolicyOutput) SetSecurityPolicy(v *DescribedSecurityPolicy) *DescribeSecurityPolicyOutput

SetSecurityPolicy sets the SecurityPolicy field's value.

func (DescribeSecurityPolicyOutput) String added in v1.34.3 

func (s DescribeSecurityPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeServerInput 

type DescribeServerInput struct {

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

func (DescribeServerInput) GoString 

func (s DescribeServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServerInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (DescribeServerInput) String 

func (s DescribeServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (DescribeServerOutput) GoString 

func (s DescribeServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServerOutput) SetServer 

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

SetServer sets the Server field's value.

func (DescribeServerOutput) String 

func (s DescribeServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeUserInput 

type DescribeUserInput struct {

	// A system-assigned unique identifier for a 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 servers. User names are part
	// of the sign-in credentials to use the Amazon Web Services 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) GoString 

func (s DescribeUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUserInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*DescribeUserInput) SetUserName 

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

SetUserName sets the UserName field's value.

func (DescribeUserInput) String 

func (s DescribeUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DescribeUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUserOutput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*DescribeUserOutput) SetUser 

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

SetUser sets the User field's value.

func (DescribeUserOutput) String 

func (s DescribeUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkflowInput added in v1.40.36 

type DescribeWorkflowInput struct {

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWorkflowInput) GoString added in v1.40.36 

func (s DescribeWorkflowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkflowInput) SetWorkflowId added in v1.40.36 

func (s *DescribeWorkflowInput) SetWorkflowId(v string) *DescribeWorkflowInput

SetWorkflowId sets the WorkflowId field's value.

func (DescribeWorkflowInput) String added in v1.40.36 

func (s DescribeWorkflowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkflowInput) Validate added in v1.40.36 

func (s *DescribeWorkflowInput) Validate() error

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

type DescribeWorkflowOutput added in v1.40.36 

type DescribeWorkflowOutput struct {

	// The structure that contains the details of the workflow.
	//
	// Workflow is a required field
	Workflow *DescribedWorkflow `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWorkflowOutput) GoString added in v1.40.36 

func (s DescribeWorkflowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkflowOutput) SetWorkflow added in v1.40.36 

func (s *DescribeWorkflowOutput) SetWorkflow(v *DescribedWorkflow) *DescribeWorkflowOutput

SetWorkflow sets the Workflow field's value.

func (DescribeWorkflowOutput) String added in v1.40.36 

func (s DescribeWorkflowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedAccess added in v1.38.47 

type DescribedAccess struct {

	// A unique identifier that is required to identify specific groups within your
	// directory. The users of the group that you associate have access to your
	// Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
	// Web Services Transfer Family. If you know the group name, you can view the
	// SID values by running the following command using Windows PowerShell.
	//
	// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
	// | Select SamAccountName,ObjectSid
	//
	// In that command, replace YourGroupName with the name of your Active Directory
	// group.
	//
	// The regex used to validate this parameter is a string of characters consisting
	// of uppercase and lowercase alphanumeric characters with no spaces. You can
	// also include underscores or any of the following characters: =,.@:/-
	ExternalId *string `min:"1" type:"string"`

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

	// Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
	// and keys should be visible to your user and how you want to make them visible.
	// You must specify the Entry and Target pair, where Entry shows how the path
	// is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
	// you only specify a target, it is displayed as is. You also must ensure that
	// your Amazon Web Services Identity and Access Management (IAM) role provides
	// access to paths in Target. This value can only be set when HomeDirectoryType
	// is set to LOGICAL.
	//
	// In most cases, you can use this value instead of the session policy to lock
	// down the associated access 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"`

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

	// A session policy for your user so that 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}.
	Policy *string `type:"string"`

	// The full POSIX identity, including user ID (Uid), group ID (Gid), and any
	// secondary groups IDs (SecondaryGids), that controls your users' access to
	// your Amazon EFS file systems. The POSIX permissions that are set on files
	// and directories in your file system determine the level of access your users
	// get when transferring files into and out of your Amazon EFS file systems.
	PosixProfile *PosixProfile `type:"structure"`

	// Specifies the Amazon Resource Name (ARN) of the IAM role that controls your
	// users' access to your Amazon S3 bucket or EFS file system. The policies attached
	// to this role determine the level of access that you want to provide your
	// users when transferring files into and out of your Amazon S3 bucket or EFS
	// file system. The IAM role should also contain a trust relationship that allows
	// the server to access your resources when servicing your users' transfer requests.
	Role *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

Describes the properties of the access that was specified.

func (DescribedAccess) GoString added in v1.38.47 

func (s DescribedAccess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedAccess) SetExternalId added in v1.38.47 

func (s *DescribedAccess) SetExternalId(v string) *DescribedAccess

SetExternalId sets the ExternalId field's value.

func (*DescribedAccess) SetHomeDirectory added in v1.38.47 

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

SetHomeDirectory sets the HomeDirectory field's value.

func (*DescribedAccess) SetHomeDirectoryMappings added in v1.38.47 

func (s *DescribedAccess) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *DescribedAccess

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*DescribedAccess) SetHomeDirectoryType added in v1.38.47 

func (s *DescribedAccess) SetHomeDirectoryType(v string) *DescribedAccess

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*DescribedAccess) SetPolicy added in v1.38.47 

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

SetPolicy sets the Policy field's value.

func (*DescribedAccess) SetPosixProfile added in v1.38.47 

func (s *DescribedAccess) SetPosixProfile(v *PosixProfile) *DescribedAccess

SetPosixProfile sets the PosixProfile field's value.

func (*DescribedAccess) SetRole added in v1.38.47 

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

SetRole sets the Role field's value.

func (DescribedAccess) String added in v1.38.47 

func (s DescribedAccess) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedExecution added in v1.40.36 

type DescribedExecution struct {

	// A unique identifier for the execution of a workflow.
	ExecutionId *string `min:"36" type:"string"`

	// The IAM role associated with the execution.
	ExecutionRole *string `min:"20" type:"string"`

	// A structure that describes the Amazon S3 or EFS file location. This is the
	// file location when the execution begins: if the file is being copied, this
	// is the initial (as opposed to destination) file location.
	InitialFileLocation *FileLocation `type:"structure"`

	// The IAM logging role associated with the execution.
	LoggingConfiguration *LoggingConfiguration `type:"structure"`

	// The full POSIX identity, including user ID (Uid), group ID (Gid), and any
	// secondary groups IDs (SecondaryGids), that controls your users' access to
	// your Amazon EFS file systems. The POSIX permissions that are set on files
	// and directories in your file system determine the level of access your users
	// get when transferring files into and out of your Amazon EFS file systems.
	PosixProfile *PosixProfile `type:"structure"`

	// A structure that describes the execution results. This includes a list of
	// the steps along with the details of each step, error type and message (if
	// any), and the OnExceptionSteps structure.
	Results *ExecutionResults `type:"structure"`

	// A container object for the session details associated with a workflow.
	ServiceMetadata *ServiceMetadata `type:"structure"`

	// The status is one of the execution. Can be in progress, completed, exception
	// encountered, or handling the exception.
	Status *string `type:"string" enum:"ExecutionStatus"`
	// contains filtered or unexported fields
}

The details for an execution object.

func (DescribedExecution) GoString added in v1.40.36 

func (s DescribedExecution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedExecution) SetExecutionId added in v1.40.36 

func (s *DescribedExecution) SetExecutionId(v string) *DescribedExecution

SetExecutionId sets the ExecutionId field's value.

func (*DescribedExecution) SetExecutionRole added in v1.40.36 

func (s *DescribedExecution) SetExecutionRole(v string) *DescribedExecution

SetExecutionRole sets the ExecutionRole field's value.

func (*DescribedExecution) SetInitialFileLocation added in v1.40.36 

func (s *DescribedExecution) SetInitialFileLocation(v *FileLocation) *DescribedExecution

SetInitialFileLocation sets the InitialFileLocation field's value.

func (*DescribedExecution) SetLoggingConfiguration added in v1.40.36 

func (s *DescribedExecution) SetLoggingConfiguration(v *LoggingConfiguration) *DescribedExecution

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*DescribedExecution) SetPosixProfile added in v1.40.36 

func (s *DescribedExecution) SetPosixProfile(v *PosixProfile) *DescribedExecution

SetPosixProfile sets the PosixProfile field's value.

func (*DescribedExecution) SetResults added in v1.40.36 

func (s *DescribedExecution) SetResults(v *ExecutionResults) *DescribedExecution

SetResults sets the Results field's value.

func (*DescribedExecution) SetServiceMetadata added in v1.40.36 

func (s *DescribedExecution) SetServiceMetadata(v *ServiceMetadata) *DescribedExecution

SetServiceMetadata sets the ServiceMetadata field's value.

func (*DescribedExecution) SetStatus added in v1.40.36 

func (s *DescribedExecution) SetStatus(v string) *DescribedExecution

SetStatus sets the Status field's value.

func (DescribedExecution) String added in v1.40.36 

func (s DescribedExecution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedSecurityPolicy added in v1.34.3 

type DescribedSecurityPolicy struct {

	// Specifies whether this policy enables Federal Information Processing Standards
	// (FIPS).
	Fips *bool `type:"boolean"`

	// Specifies the name of the security policy that is attached to the server.
	//
	// SecurityPolicyName is a required field
	SecurityPolicyName *string `type:"string" required:"true"`

	// Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in
	// the security policy that is attached to the server.
	SshCiphers []*string `type:"list"`

	// Specifies the enabled SSH key exchange (KEX) encryption algorithms in the
	// security policy that is attached to the server.
	SshKexs []*string `type:"list"`

	// Specifies the enabled SSH message authentication code (MAC) encryption algorithms
	// in the security policy that is attached to the server.
	SshMacs []*string `type:"list"`

	// Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms
	// in the security policy that is attached to the server.
	TlsCiphers []*string `type:"list"`
	// contains filtered or unexported fields
}

Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html).

func (DescribedSecurityPolicy) GoString added in v1.34.3 

func (s DescribedSecurityPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedSecurityPolicy) SetFips added in v1.34.3 

func (s *DescribedSecurityPolicy) SetFips(v bool) *DescribedSecurityPolicy

SetFips sets the Fips field's value.

func (*DescribedSecurityPolicy) SetSecurityPolicyName added in v1.34.3 

func (s *DescribedSecurityPolicy) SetSecurityPolicyName(v string) *DescribedSecurityPolicy

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*DescribedSecurityPolicy) SetSshCiphers added in v1.34.3 

func (s *DescribedSecurityPolicy) SetSshCiphers(v []*string) *DescribedSecurityPolicy

SetSshCiphers sets the SshCiphers field's value.

func (*DescribedSecurityPolicy) SetSshKexs added in v1.34.3 

func (s *DescribedSecurityPolicy) SetSshKexs(v []*string) *DescribedSecurityPolicy

SetSshKexs sets the SshKexs field's value.

func (*DescribedSecurityPolicy) SetSshMacs added in v1.34.3 

func (s *DescribedSecurityPolicy) SetSshMacs(v []*string) *DescribedSecurityPolicy

SetSshMacs sets the SshMacs field's value.

func (*DescribedSecurityPolicy) SetTlsCiphers added in v1.34.3 

func (s *DescribedSecurityPolicy) SetTlsCiphers(v []*string) *DescribedSecurityPolicy

SetTlsCiphers sets the TlsCiphers field's value.

func (DescribedSecurityPolicy) String added in v1.34.3 

func (s DescribedSecurityPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedServer 

type DescribedServer struct {

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

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

	// Specifies the domain of the storage system that is used for file transfers.
	Domain *string `type:"string" enum:"Domain"`

	// The virtual private cloud (VPC) endpoint settings that are configured for
	// your 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 IP
	// addresses 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"`

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

	// 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 server is AWS_DIRECTORY_SERVICE
	// or SERVICE_MANAGED.
	IdentityProviderDetails *IdentityProviderDetails `type:"structure"`

	// Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED,
	// which allows you to store and access user credentials within the Amazon Web
	// Services Transfer Family service.
	//
	// Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in
	// Amazon Web Services Managed Active Directory or Microsoft Active Directory
	// in your on-premises environment or in Amazon Web Services using AD Connectors.
	// This option also requires you to provide a Directory ID using the IdentityProviderDetails
	// parameter.
	//
	// 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 *string `type:"string" enum:"IdentityProviderType"`

	// Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
	// and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
	// logging for Amazon S3 or Amazon EFS events. When set, user activity can be
	// viewed in your CloudWatch logs.
	LoggingRole *string `min:"20" type:"string"`

	// The protocol settings that are configured for your server.
	//
	// Use the PassiveIp parameter to indicate passive mode. Enter a single dotted-quad
	// IPv4 address, such as the external IP address of a firewall, router, or load
	// balancer.
	ProtocolDetails *ProtocolDetails `type:"structure"`

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

	// Specifies the name of the security policy that is attached to the server.
	SecurityPolicyName *string `type:"string"`

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

	// Specifies the condition of a 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 *string `type:"string" enum:"State"`

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

	// Specifies the number of users that are assigned to a server you specified
	// with the ServerId.
	UserCount *int64 `type:"integer"`

	// Specifies the workflow ID for the workflow to assign and the execution role
	// used for executing the workflow.
	WorkflowDetails *WorkflowDetails `type:"structure"`
	// contains filtered or unexported fields
}

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

func (DescribedServer) GoString 

func (s DescribedServer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedServer) SetArn 

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

SetArn sets the Arn field's value.

func (*DescribedServer) SetCertificate added in v1.30.13 

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

SetCertificate sets the Certificate field's value.

func (*DescribedServer) SetDomain added in v1.36.22 

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

SetDomain sets the Domain field's value.

func (*DescribedServer) SetEndpointDetails added in v1.19.3 

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

SetEndpointDetails sets the EndpointDetails field's value.

func (*DescribedServer) SetEndpointType added in v1.19.3 

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

SetEndpointType sets the EndpointType field's value.

func (*DescribedServer) SetHostKeyFingerprint added in v1.19.20 

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

SetHostKeyFingerprint sets the HostKeyFingerprint field's value.

func (*DescribedServer) SetIdentityProviderDetails 

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

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.

func (*DescribedServer) SetIdentityProviderType 

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

SetIdentityProviderType sets the IdentityProviderType field's value.

func (*DescribedServer) SetLoggingRole 

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

SetLoggingRole sets the LoggingRole field's value.

func (*DescribedServer) SetProtocolDetails added in v1.38.67 

func (s *DescribedServer) SetProtocolDetails(v *ProtocolDetails) *DescribedServer

SetProtocolDetails sets the ProtocolDetails field's value.

func (*DescribedServer) SetProtocols added in v1.30.13 

func (s *DescribedServer) SetProtocols(v []*string) *DescribedServer

SetProtocols sets the Protocols field's value.

func (*DescribedServer) SetSecurityPolicyName added in v1.34.3 

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

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*DescribedServer) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*DescribedServer) SetState 

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

SetState sets the State field's value.

func (*DescribedServer) SetTags 

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

SetTags sets the Tags field's value.

func (*DescribedServer) SetUserCount 

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

SetUserCount sets the UserCount field's value.

func (*DescribedServer) SetWorkflowDetails added in v1.40.36 

func (s *DescribedServer) SetWorkflowDetails(v *WorkflowDetails) *DescribedServer

SetWorkflowDetails sets the WorkflowDetails field's value.

func (DescribedServer) String 

func (s DescribedServer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

	// Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
	// and keys should be visible to your user and how you want to make them visible.
	// You must specify the Entry and Target pair, where Entry shows how the path
	// is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
	// you only specify a target, it is displayed as is. You also must ensure that
	// your Amazon Web Services Identity and Access Management (IAM) role provides
	// access to paths in Target. This value can only be set when HomeDirectoryType
	// is set to LOGICAL.
	//
	// In most cases, you can use this value instead of the session 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"`

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

	// A session policy for your user so that 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}.
	Policy *string `type:"string"`

	// Specifies the full POSIX identity, including user ID (Uid), group ID (Gid),
	// and any secondary groups IDs (SecondaryGids), that controls your users' access
	// to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions
	// that are set on files and directories in your file system determine the level
	// of access your users get when transferring files into and out of your Amazon
	// EFS file systems.
	PosixProfile *PosixProfile `type:"structure"`

	// Specifies the Amazon Resource Name (ARN) of the IAM role that controls your
	// users' access to your Amazon S3 bucket or EFS file system. The policies attached
	// to this role determine the level of access that you want to provide your
	// users when transferring files into and out of your Amazon S3 bucket or EFS
	// file system. The IAM role should also contain a trust relationship that allows
	// the 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 server.
	UserName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Describes the properties of a user that was specified.

func (DescribedUser) GoString 

func (s DescribedUser) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedUser) SetArn 

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

SetArn sets the Arn field's value.

func (*DescribedUser) SetHomeDirectory 

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

SetHomeDirectory sets the HomeDirectory field's value.

func (*DescribedUser) SetHomeDirectoryMappings added in v1.25.20 

func (s *DescribedUser) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *DescribedUser

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*DescribedUser) SetHomeDirectoryType added in v1.25.20 

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

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*DescribedUser) SetPolicy 

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

SetPolicy sets the Policy field's value.

func (*DescribedUser) SetPosixProfile added in v1.36.22 

func (s *DescribedUser) SetPosixProfile(v *PosixProfile) *DescribedUser

SetPosixProfile sets the PosixProfile field's value.

func (*DescribedUser) SetRole 

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

SetRole sets the Role field's value.

func (*DescribedUser) SetSshPublicKeys 

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

SetSshPublicKeys sets the SshPublicKeys field's value.

func (*DescribedUser) SetTags 

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

SetTags sets the Tags field's value.

func (*DescribedUser) SetUserName 

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

SetUserName sets the UserName field's value.

func (DescribedUser) String 

func (s DescribedUser) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedWorkflow added in v1.40.36 

type DescribedWorkflow struct {

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

	// Specifies the text description for the workflow.
	Description *string `type:"string"`

	// Specifies the steps (actions) to take if errors are encountered during execution
	// of the workflow.
	OnExceptionSteps []*WorkflowStep `type:"list"`

	// Specifies the details for the steps that are in the specified workflow.
	Steps []*WorkflowStep `type:"list"`

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

	// A unique identifier for the workflow.
	WorkflowId *string `min:"19" type:"string"`
	// contains filtered or unexported fields
}

Describes the properties of the specified workflow

func (DescribedWorkflow) GoString added in v1.40.36 

func (s DescribedWorkflow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedWorkflow) SetArn added in v1.40.36 

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

SetArn sets the Arn field's value.

func (*DescribedWorkflow) SetDescription added in v1.40.36 

func (s *DescribedWorkflow) SetDescription(v string) *DescribedWorkflow

SetDescription sets the Description field's value.

func (*DescribedWorkflow) SetOnExceptionSteps added in v1.40.36 

func (s *DescribedWorkflow) SetOnExceptionSteps(v []*WorkflowStep) *DescribedWorkflow

SetOnExceptionSteps sets the OnExceptionSteps field's value.

func (*DescribedWorkflow) SetSteps added in v1.40.36 

func (s *DescribedWorkflow) SetSteps(v []*WorkflowStep) *DescribedWorkflow

SetSteps sets the Steps field's value.

func (*DescribedWorkflow) SetTags added in v1.40.36 

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

SetTags sets the Tags field's value.

func (*DescribedWorkflow) SetWorkflowId added in v1.40.36 

func (s *DescribedWorkflow) SetWorkflowId(v string) *DescribedWorkflow

SetWorkflowId sets the WorkflowId field's value.

func (DescribedWorkflow) String added in v1.40.36 

func (s DescribedWorkflow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EfsFileLocation added in v1.40.36 

type EfsFileLocation struct {

	// The ID of the file system, assigned by Amazon EFS.
	FileSystemId *string `type:"string"`

	// The pathname for the folder being used by a workflow.
	Path *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Reserved for future use.

func (EfsFileLocation) GoString added in v1.40.36 

func (s EfsFileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EfsFileLocation) SetFileSystemId added in v1.40.36 

func (s *EfsFileLocation) SetFileSystemId(v string) *EfsFileLocation

SetFileSystemId sets the FileSystemId field's value.

func (*EfsFileLocation) SetPath added in v1.40.36 

func (s *EfsFileLocation) SetPath(v string) *EfsFileLocation

SetPath sets the Path field's value.

func (EfsFileLocation) String added in v1.40.36 

func (s EfsFileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EfsFileLocation) Validate added in v1.40.36 

func (s *EfsFileLocation) Validate() error

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

type EndpointDetails added in v1.19.3 

type EndpointDetails struct {

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

	// A list of security groups IDs that are available to attach to your server's
	// endpoint.
	//
	// This property can only be set when EndpointType is set to VPC.
	//
	// You can edit the SecurityGroupIds property in the UpdateServer (https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html)
	// API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT
	// to VPC. To change security groups associated with your server's VPC endpoint
	// after creation, use the Amazon EC2 ModifyVpcEndpoint (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html)
	// API.
	SecurityGroupIds []*string `type:"list"`

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

	// The ID of the VPC endpoint.
	//
	// This property can only be set when EndpointType is set to VPC_ENDPOINT.
	//
	// For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
	VpcEndpointId *string `min:"22" type:"string"`

	// The VPC ID of the VPC in which a server's endpoint will be hosted.
	//
	// This property can only be set 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 address to your server's endpoint.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

func (EndpointDetails) GoString added in v1.19.3 

func (s EndpointDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointDetails) SetAddressAllocationIds added in v1.28.0 

func (s *EndpointDetails) SetAddressAllocationIds(v []*string) *EndpointDetails

SetAddressAllocationIds sets the AddressAllocationIds field's value.

func (*EndpointDetails) SetSecurityGroupIds added in v1.35.8 

func (s *EndpointDetails) SetSecurityGroupIds(v []*string) *EndpointDetails

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*EndpointDetails) SetSubnetIds added in v1.28.0 

func (s *EndpointDetails) SetSubnetIds(v []*string) *EndpointDetails

SetSubnetIds sets the SubnetIds field's value.

func (*EndpointDetails) SetVpcEndpointId added in v1.19.3 

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

SetVpcEndpointId sets the VpcEndpointId field's value.

func (*EndpointDetails) SetVpcId added in v1.28.0 

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

SetVpcId sets the VpcId field's value.

func (EndpointDetails) String added in v1.19.3 

func (s EndpointDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointDetails) Validate added in v1.25.20 

func (s *EndpointDetails) Validate() error

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

type ExecutionError added in v1.40.36 

type ExecutionError struct {

	// Specifies the descriptive message that corresponds to the ErrorType.
	//
	// Message is a required field
	Message *string `type:"string" required:"true"`

	// Specifies the error type: currently, the only valid value is PERMISSION_DENIED,
	// which occurs if your policy does not contain the correct permissions to complete
	// one or more of the steps in the workflow.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ExecutionErrorType"`
	// contains filtered or unexported fields
}

Specifies the error message and type, for an error that occurs during the execution of the workflow.

func (ExecutionError) GoString added in v1.40.36 

func (s ExecutionError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionError) SetMessage added in v1.40.36 

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

SetMessage sets the Message field's value.

func (*ExecutionError) SetType added in v1.40.36 

func (s *ExecutionError) SetType(v string) *ExecutionError

SetType sets the Type field's value.

func (ExecutionError) String added in v1.40.36 

func (s ExecutionError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionResults added in v1.40.36 

type ExecutionResults struct {

	// Specifies the steps (actions) to take if errors are encountered during execution
	// of the workflow.
	OnExceptionSteps []*ExecutionStepResult `min:"1" type:"list"`

	// Specifies the details for the steps that are in the specified workflow.
	Steps []*ExecutionStepResult `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.

func (ExecutionResults) GoString added in v1.40.36 

func (s ExecutionResults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionResults) SetOnExceptionSteps added in v1.40.36 

func (s *ExecutionResults) SetOnExceptionSteps(v []*ExecutionStepResult) *ExecutionResults

SetOnExceptionSteps sets the OnExceptionSteps field's value.

func (*ExecutionResults) SetSteps added in v1.40.36 

func (s *ExecutionResults) SetSteps(v []*ExecutionStepResult) *ExecutionResults

SetSteps sets the Steps field's value.

func (ExecutionResults) String added in v1.40.36 

func (s ExecutionResults) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionStepResult added in v1.40.36 

type ExecutionStepResult struct {

	// Specifies the details for an error, if it occurred during execution of the
	// specified workfow step.
	Error *ExecutionError `type:"structure"`

	// The values for the key/value pair applied as a tag to the file. Only applicable
	// if the step type is TAG.
	Outputs *string `type:"string"`

	// One of the available step types.
	//
	//    * Copy: copy the file to another location
	//
	//    * Custom: custom step with a lambda target
	//
	//    * Delete: delete the file
	//
	//    * Tag: add a tag to the file
	StepType *string `type:"string" enum:"WorkflowStepType"`
	// contains filtered or unexported fields
}

Specifies the following details for the step: error (if any), outputs (if any), and the step type.

func (ExecutionStepResult) GoString added in v1.40.36 

func (s ExecutionStepResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionStepResult) SetError added in v1.40.36 

func (s *ExecutionStepResult) SetError(v *ExecutionError) *ExecutionStepResult

SetError sets the Error field's value.

func (*ExecutionStepResult) SetOutputs added in v1.40.36 

func (s *ExecutionStepResult) SetOutputs(v string) *ExecutionStepResult

SetOutputs sets the Outputs field's value.

func (*ExecutionStepResult) SetStepType added in v1.40.36 

func (s *ExecutionStepResult) SetStepType(v string) *ExecutionStepResult

SetStepType sets the StepType field's value.

func (ExecutionStepResult) String added in v1.40.36 

func (s ExecutionStepResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileLocation added in v1.40.36 

type FileLocation struct {

	// Specifies the Amazon EFS ID and the path for the file being used.
	EfsFileLocation *EfsFileLocation `type:"structure"`

	// Specifies the S3 details for the file being used, such as bucket, Etag, and
	// so forth.
	S3FileLocation *S3FileLocation `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the Amazon S3 or EFS file details to be used in the step.

func (FileLocation) GoString added in v1.40.36 

func (s FileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileLocation) SetEfsFileLocation added in v1.40.36 

func (s *FileLocation) SetEfsFileLocation(v *EfsFileLocation) *FileLocation

SetEfsFileLocation sets the EfsFileLocation field's value.

func (*FileLocation) SetS3FileLocation added in v1.40.36 

func (s *FileLocation) SetS3FileLocation(v *S3FileLocation) *FileLocation

SetS3FileLocation sets the S3FileLocation field's value.

func (FileLocation) String added in v1.40.36 

func (s FileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HomeDirectoryMapEntry added in v1.25.20 

type HomeDirectoryMapEntry struct {

	// Represents an entry 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 targets for HomeDirectoryMappings.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs 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.

func (HomeDirectoryMapEntry) GoString added in v1.25.20 

func (s HomeDirectoryMapEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HomeDirectoryMapEntry) SetEntry added in v1.25.20 

func (s *HomeDirectoryMapEntry) SetEntry(v string) *HomeDirectoryMapEntry

SetEntry sets the Entry field's value.

func (*HomeDirectoryMapEntry) SetTarget added in v1.25.20 

func (s *HomeDirectoryMapEntry) SetTarget(v string) *HomeDirectoryMapEntry

SetTarget sets the Target field's value.

func (HomeDirectoryMapEntry) String added in v1.25.20 

func (s HomeDirectoryMapEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HomeDirectoryMapEntry) Validate added in v1.25.20 

func (s *HomeDirectoryMapEntry) Validate() error

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

type IdentityProviderDetails 

type IdentityProviderDetails struct {

	// The identifier of the Amazon Web ServicesDirectory Service directory that
	// you want to stop sharing.
	DirectoryId *string `min:"12" type:"string"`

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

func (s IdentityProviderDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityProviderDetails) SetDirectoryId added in v1.38.47 

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

SetDirectoryId sets the DirectoryId field's value.

func (*IdentityProviderDetails) SetInvocationRole 

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

SetInvocationRole sets the InvocationRole field's value.

func (*IdentityProviderDetails) SetUrl 

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

SetUrl sets the Url field's value.

func (IdentityProviderDetails) String 

func (s IdentityProviderDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityProviderDetails) Validate added in v1.25.20 

func (s *IdentityProviderDetails) Validate() error

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

type ImportSshPublicKeyInput 

type ImportSshPublicKeyInput struct {

	// A system-assigned unique identifier for a 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 servers.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ImportSshPublicKeyInput) GoString 

func (s ImportSshPublicKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportSshPublicKeyInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*ImportSshPublicKeyInput) SetSshPublicKeyBody 

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

SetSshPublicKeyBody sets the SshPublicKeyBody field's value.

func (*ImportSshPublicKeyInput) SetUserName 

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

SetUserName sets the UserName field's value.

func (ImportSshPublicKeyInput) String 

func (s ImportSshPublicKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ImportSshPublicKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportSshPublicKeyOutput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*ImportSshPublicKeyOutput) SetSshPublicKeyId 

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

SetSshPublicKeyId sets the SshPublicKeyId field's value.

func (*ImportSshPublicKeyOutput) SetUserName 

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

SetUserName sets the UserName field's value.

func (ImportSshPublicKeyOutput) String 

func (s ImportSshPublicKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputFileLocation added in v1.40.36 

type InputFileLocation struct {

	// Reserved for future use.
	EfsFileLocation *EfsFileLocation `type:"structure"`

	// Specifies the details for the S3 file being copied.
	S3FileLocation *S3InputFileLocation `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.

func (InputFileLocation) GoString added in v1.40.36 

func (s InputFileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputFileLocation) SetEfsFileLocation added in v1.40.36 

func (s *InputFileLocation) SetEfsFileLocation(v *EfsFileLocation) *InputFileLocation

SetEfsFileLocation sets the EfsFileLocation field's value.

func (*InputFileLocation) SetS3FileLocation added in v1.40.36 

func (s *InputFileLocation) SetS3FileLocation(v *S3InputFileLocation) *InputFileLocation

SetS3FileLocation sets the S3FileLocation field's value.

func (InputFileLocation) String added in v1.40.36 

func (s InputFileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputFileLocation) Validate added in v1.40.36 

func (s *InputFileLocation) Validate() error

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

type InternalServiceError added in v1.28.0 

type InternalServiceError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

func (*InternalServiceError) Code added in v1.28.0 

func (s *InternalServiceError) Code() string

Code returns the exception type name.

func (*InternalServiceError) Error added in v1.28.0 

func (s *InternalServiceError) Error() string

func (InternalServiceError) GoString added in v1.28.0 

func (s InternalServiceError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServiceError) Message added in v1.28.0 

func (s *InternalServiceError) Message() string

Message returns the exception's message.

func (*InternalServiceError) OrigErr added in v1.28.0 

func (s *InternalServiceError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceError) RequestID added in v1.28.0 

func (s *InternalServiceError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceError) StatusCode added in v1.28.0 

func (s *InternalServiceError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceError) String added in v1.28.0 

func (s InternalServiceError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidNextTokenException added in v1.28.0 

type InvalidNextTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The NextToken parameter that was passed is invalid.

func (*InvalidNextTokenException) Code added in v1.28.0 

func (s *InvalidNextTokenException) Code() string

Code returns the exception type name.

func (*InvalidNextTokenException) Error added in v1.28.0 

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString added in v1.28.0 

func (s InvalidNextTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidNextTokenException) Message added in v1.28.0 

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr added in v1.28.0 

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID added in v1.28.0 

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode added in v1.28.0 

func (s *InvalidNextTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidNextTokenException) String added in v1.28.0 

func (s InvalidNextTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

This exception is thrown when the client submits a malformed request.

func (*InvalidRequestException) Code added in v1.28.0 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAccessesInput added in v1.38.47 

type ListAccessesInput struct {

	// Specifies the maximum number of access SIDs to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// When you can get additional results from the ListAccesses 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 accesses.
	NextToken *string `min:"1" type:"string"`

	// A system-assigned unique identifier for a 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 (ListAccessesInput) GoString added in v1.38.47 

func (s ListAccessesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessesInput) SetMaxResults added in v1.38.47 

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

SetMaxResults sets the MaxResults field's value.

func (*ListAccessesInput) SetNextToken added in v1.38.47 

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

SetNextToken sets the NextToken field's value.

func (*ListAccessesInput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (ListAccessesInput) String added in v1.38.47 

func (s ListAccessesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessesInput) Validate added in v1.38.47 

func (s *ListAccessesInput) Validate() error

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

type ListAccessesOutput added in v1.38.47 

type ListAccessesOutput struct {

	// Returns the accesses and their properties for the ServerId value that you
	// specify.
	//
	// Accesses is a required field
	Accesses []*ListedAccess `type:"list" required:"true"`

	// When you can get additional results from the ListAccesses 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 accesses.
	NextToken *string `min:"1" type:"string"`

	// A system-assigned unique identifier for a 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 (ListAccessesOutput) GoString added in v1.38.47 

func (s ListAccessesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessesOutput) SetAccesses added in v1.38.47 

func (s *ListAccessesOutput) SetAccesses(v []*ListedAccess) *ListAccessesOutput

SetAccesses sets the Accesses field's value.

func (*ListAccessesOutput) SetNextToken added in v1.38.47 

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

SetNextToken sets the NextToken field's value.

func (*ListAccessesOutput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (ListAccessesOutput) String added in v1.38.47 

func (s ListAccessesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExecutionsInput added in v1.40.36 

type ListExecutionsInput struct {

	// Specifies the aximum number of executions to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// ListExecutions returns the NextToken parameter in the output. You can then
	// pass the NextToken parameter in a subsequent command to continue listing
	// additional executions.
	//
	// This is useful for pagination, for instance. If you have 100 executions for
	// a workflow, you might only want to list first 10. If so, callthe API by specifing
	// the max-results:
	//
	// aws transfer list-executions --max-results 10
	//
	// This returns details for the first 10 executions, as well as the pointer
	// (NextToken) to the eleventh execution. You can now call the API again, suppling
	// the NextToken value you received:
	//
	// aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult
	//
	// This call returns the next 10 executions, the 11th through the 20th. You
	// can then repeat the call until the details for all 100 executions have been
	// returned.
	NextToken *string `min:"1" type:"string"`

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListExecutionsInput) GoString added in v1.40.36 

func (s ListExecutionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutionsInput) SetMaxResults added in v1.40.36 

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

SetMaxResults sets the MaxResults field's value.

func (*ListExecutionsInput) SetNextToken added in v1.40.36 

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

SetNextToken sets the NextToken field's value.

func (*ListExecutionsInput) SetWorkflowId added in v1.40.36 

func (s *ListExecutionsInput) SetWorkflowId(v string) *ListExecutionsInput

SetWorkflowId sets the WorkflowId field's value.

func (ListExecutionsInput) String added in v1.40.36 

func (s ListExecutionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutionsInput) Validate added in v1.40.36 

func (s *ListExecutionsInput) Validate() error

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

type ListExecutionsOutput added in v1.40.36 

type ListExecutionsOutput struct {

	// Returns the details for each execution.
	//
	//    * NextToken: returned from a call to several APIs, you can use pass it
	//    to a subsequent command to continue listing additional executions.
	//
	//    * StartTime: timestamp indicating when the execution began.
	//
	//    * Executions: details of the execution, including the execution ID, initial
	//    file location, and Service metadata.
	//
	//    * Status: one of the following values: IN_PROGRESS, COMPLETED, EXCEPTION,
	//    HANDLING_EXEPTION.
	//
	// Executions is a required field
	Executions []*ListedExecution `type:"list" required:"true"`

	// ListExecutions returns the NextToken parameter in the output. You can then
	// pass the NextToken parameter in a subsequent command to continue listing
	// additional executions.
	NextToken *string `min:"1" type:"string"`

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListExecutionsOutput) GoString added in v1.40.36 

func (s ListExecutionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutionsOutput) SetExecutions added in v1.40.36 

func (s *ListExecutionsOutput) SetExecutions(v []*ListedExecution) *ListExecutionsOutput

SetExecutions sets the Executions field's value.

func (*ListExecutionsOutput) SetNextToken added in v1.40.36 

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

SetNextToken sets the NextToken field's value.

func (*ListExecutionsOutput) SetWorkflowId added in v1.40.36 

func (s *ListExecutionsOutput) SetWorkflowId(v string) *ListExecutionsOutput

SetWorkflowId sets the WorkflowId field's value.

func (ListExecutionsOutput) String added in v1.40.36 

func (s ListExecutionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSecurityPoliciesInput added in v1.34.3 

type ListSecurityPoliciesInput struct {

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

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

func (ListSecurityPoliciesInput) GoString added in v1.34.3 

func (s ListSecurityPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityPoliciesInput) SetMaxResults added in v1.34.3 

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

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityPoliciesInput) SetNextToken added in v1.34.3 

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

SetNextToken sets the NextToken field's value.

func (ListSecurityPoliciesInput) String added in v1.34.3 

func (s ListSecurityPoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityPoliciesInput) Validate added in v1.34.3 

func (s *ListSecurityPoliciesInput) Validate() error

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

type ListSecurityPoliciesOutput added in v1.34.3 

type ListSecurityPoliciesOutput struct {

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

	// An array of security policies that were listed.
	//
	// SecurityPolicyNames is a required field
	SecurityPolicyNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListSecurityPoliciesOutput) GoString added in v1.34.3 

func (s ListSecurityPoliciesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityPoliciesOutput) SetNextToken added in v1.34.3 

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

SetNextToken sets the NextToken field's value.

func (*ListSecurityPoliciesOutput) SetSecurityPolicyNames added in v1.34.3 

func (s *ListSecurityPoliciesOutput) SetSecurityPolicyNames(v []*string) *ListSecurityPoliciesOutput

SetSecurityPolicyNames sets the SecurityPolicyNames field's value.

func (ListSecurityPoliciesOutput) String added in v1.34.3 

func (s ListSecurityPoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListServersInput 

type ListServersInput struct {

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

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

func (ListServersInput) GoString 

func (s ListServersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListServersInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListServersInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListServersInput) String 

func (s ListServersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListServersInput) Validate 

func (s *ListServersInput) Validate() error

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

type ListServersOutput 

type ListServersOutput struct {

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

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

func (ListServersOutput) GoString 

func (s ListServersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListServersOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListServersOutput) SetServers 

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

SetServers sets the Servers field's value.

func (ListServersOutput) String 

func (s ListServersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// Requests the tags associated with a particular Amazon Resource Name (ARN).
	// An ARN is an identifier for a specific Amazon Web Services 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) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetArn 

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

SetArn sets the Arn field's value.

func (*ListTagsForResourceInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*ListTagsForResourceOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListUsersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListUsersInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListUsersInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (ListUsersInput) String 

func (s ListUsersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListUsersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListUsersOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*ListUsersOutput) SetUsers 

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

SetUsers sets the Users field's value.

func (ListUsersOutput) String 

func (s ListUsersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkflowsInput added in v1.40.36 

type ListWorkflowsInput struct {

	// Specifies the maximum number of workflows to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// ListWorkflows returns the NextToken parameter in the output. You can then
	// pass the NextToken parameter in a subsequent command to continue listing
	// additional workflows.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListWorkflowsInput) GoString added in v1.40.36 

func (s ListWorkflowsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkflowsInput) SetMaxResults added in v1.40.36 

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

SetMaxResults sets the MaxResults field's value.

func (*ListWorkflowsInput) SetNextToken added in v1.40.36 

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

SetNextToken sets the NextToken field's value.

func (ListWorkflowsInput) String added in v1.40.36 

func (s ListWorkflowsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkflowsInput) Validate added in v1.40.36 

func (s *ListWorkflowsInput) Validate() error

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

type ListWorkflowsOutput added in v1.40.36 

type ListWorkflowsOutput struct {

	// ListWorkflows returns the NextToken parameter in the output. You can then
	// pass the NextToken parameter in a subsequent command to continue listing
	// additional workflows.
	NextToken *string `min:"1" type:"string"`

	// Returns the Arn, WorkflowId, and Description for each workflow.
	//
	// Workflows is a required field
	Workflows []*ListedWorkflow `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListWorkflowsOutput) GoString added in v1.40.36 

func (s ListWorkflowsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkflowsOutput) SetNextToken added in v1.40.36 

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

SetNextToken sets the NextToken field's value.

func (*ListWorkflowsOutput) SetWorkflows added in v1.40.36 

func (s *ListWorkflowsOutput) SetWorkflows(v []*ListedWorkflow) *ListWorkflowsOutput

SetWorkflows sets the Workflows field's value.

func (ListWorkflowsOutput) String added in v1.40.36 

func (s ListWorkflowsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListedAccess added in v1.38.47 

type ListedAccess struct {

	// A unique identifier that is required to identify specific groups within your
	// directory. The users of the group that you associate have access to your
	// Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
	// Web Services Transfer Family. If you know the group name, you can view the
	// SID values by running the following command using Windows PowerShell.
	//
	// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
	// | Select SamAccountName,ObjectSid
	//
	// In that command, replace YourGroupName with the name of your Active Directory
	// group.
	//
	// The regex used to validate this parameter is a string of characters consisting
	// of uppercase and lowercase alphanumeric characters with no spaces. You can
	// also include underscores or any of the following characters: =,.@:/-
	ExternalId *string `min:"1" type:"string"`

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

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

	// Specifies the Amazon Resource Name (ARN) of the IAM role that controls your
	// users' access to your Amazon S3 bucket or EFS file system. The policies attached
	// to this role determine the level of access that you want to provide your
	// users when transferring files into and out of your Amazon S3 bucket or EFS
	// file system. The IAM role should also contain a trust relationship that allows
	// the server to access your resources when servicing your users' transfer requests.
	Role *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

Lists the properties for one or more specified associated accesses.

func (ListedAccess) GoString added in v1.38.47 

func (s ListedAccess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListedAccess) SetExternalId added in v1.38.47 

func (s *ListedAccess) SetExternalId(v string) *ListedAccess

SetExternalId sets the ExternalId field's value.

func (*ListedAccess) SetHomeDirectory added in v1.38.47 

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

SetHomeDirectory sets the HomeDirectory field's value.

func (*ListedAccess) SetHomeDirectoryType added in v1.38.47 

func (s *ListedAccess) SetHomeDirectoryType(v string) *ListedAccess

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*ListedAccess) SetRole added in v1.38.47 

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

SetRole sets the Role field's value.

func (ListedAccess) String added in v1.38.47 

func (s ListedAccess) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListedExecution added in v1.40.36 

type ListedExecution struct {

	// A unique identifier for the execution of a workflow.
	ExecutionId *string `min:"36" type:"string"`

	// A structure that describes the Amazon S3 or EFS file location. This is the
	// file location when the execution begins: if the file is being copied, this
	// is the initial (as opposed to destination) file location.
	InitialFileLocation *FileLocation `type:"structure"`

	// A container object for the session details associated with a workflow.
	ServiceMetadata *ServiceMetadata `type:"structure"`

	// The status is one of the execution. Can be in progress, completed, exception
	// encountered, or handling the exception.
	Status *string `type:"string" enum:"ExecutionStatus"`
	// contains filtered or unexported fields
}

Returns properties of the execution that is specified.

func (ListedExecution) GoString added in v1.40.36 

func (s ListedExecution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListedExecution) SetExecutionId added in v1.40.36 

func (s *ListedExecution) SetExecutionId(v string) *ListedExecution

SetExecutionId sets the ExecutionId field's value.

func (*ListedExecution) SetInitialFileLocation added in v1.40.36 

func (s *ListedExecution) SetInitialFileLocation(v *FileLocation) *ListedExecution

SetInitialFileLocation sets the InitialFileLocation field's value.

func (*ListedExecution) SetServiceMetadata added in v1.40.36 

func (s *ListedExecution) SetServiceMetadata(v *ServiceMetadata) *ListedExecution

SetServiceMetadata sets the ServiceMetadata field's value.

func (*ListedExecution) SetStatus added in v1.40.36 

func (s *ListedExecution) SetStatus(v string) *ListedExecution

SetStatus sets the Status field's value.

func (ListedExecution) String added in v1.40.36 

func (s ListedExecution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListedServer 

type ListedServer struct {

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

	// Specifies the domain of the storage system that is used for file transfers.
	Domain *string `type:"string" enum:"Domain"`

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

	// Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED,
	// which allows you to store and access user credentials within the Amazon Web
	// Services Transfer Family service.
	//
	// Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in
	// Amazon Web Services Managed Active Directory or Microsoft Active Directory
	// in your on-premises environment or in Amazon Web Services using AD Connectors.
	// This option also requires you to provide a Directory ID using the IdentityProviderDetails
	// parameter.
	//
	// 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 *string `type:"string" enum:"IdentityProviderType"`

	// Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
	// and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
	// logging for Amazon S3 or Amazon EFS events. When set, user activity can be
	// viewed in your CloudWatch logs.
	LoggingRole *string `min:"20" type:"string"`

	// Specifies the unique system assigned identifier for the servers that were
	// listed.
	ServerId *string `min:"19" type:"string"`

	// Specifies the condition of a 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 *string `type:"string" enum:"State"`

	// Specifies the number of users that are assigned to a 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) GoString 

func (s ListedServer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListedServer) SetArn 

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

SetArn sets the Arn field's value.

func (*ListedServer) SetDomain added in v1.36.22 

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

SetDomain sets the Domain field's value.

func (*ListedServer) SetEndpointType added in v1.19.3 

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

SetEndpointType sets the EndpointType field's value.

func (*ListedServer) SetIdentityProviderType 

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

SetIdentityProviderType sets the IdentityProviderType field's value.

func (*ListedServer) SetLoggingRole 

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

SetLoggingRole sets the LoggingRole field's value.

func (*ListedServer) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*ListedServer) SetState 

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

SetState sets the State field's value.

func (*ListedServer) SetUserCount 

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

SetUserCount sets the UserCount field's value.

func (ListedServer) String 

func (s ListedServer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

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

	// Specifies the Amazon Resource Name (ARN) of the IAM role that controls your
	// users' access to your Amazon S3 bucket or EFS file system. The policies attached
	// to this role determine the level of access that you want to provide your
	// users when transferring files into and out of your Amazon S3 bucket or EFS
	// file system. The IAM role should also contain a trust relationship that allows
	// the server to access your resources when servicing your users' transfer requests.
	//
	// The IAM role that controls your users' access to your Amazon S3 bucket for
	// servers with Domain=S3, or your EFS file system for servers with Domain=EFS.
	//
	// The policies attached to this role determine the level of access you want
	// to provide your users when transferring files into and out of your S3 buckets
	// or EFS file systems.
	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) GoString 

func (s ListedUser) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListedUser) SetArn 

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

SetArn sets the Arn field's value.

func (*ListedUser) SetHomeDirectory 

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

SetHomeDirectory sets the HomeDirectory field's value.

func (*ListedUser) SetHomeDirectoryType added in v1.25.20 

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

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*ListedUser) SetRole 

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

SetRole sets the Role field's value.

func (*ListedUser) SetSshPublicKeyCount 

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

SetSshPublicKeyCount sets the SshPublicKeyCount field's value.

func (*ListedUser) SetUserName 

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

SetUserName sets the UserName field's value.

func (ListedUser) String 

func (s ListedUser) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListedWorkflow added in v1.40.36 

type ListedWorkflow struct {

	// Specifies the unique Amazon Resource Name (ARN) for the workflow.
	Arn *string `min:"20" type:"string"`

	// Specifies the text description for the workflow.
	Description *string `type:"string"`

	// A unique identifier for the workflow.
	WorkflowId *string `min:"19" type:"string"`
	// contains filtered or unexported fields
}

Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.

func (ListedWorkflow) GoString added in v1.40.36 

func (s ListedWorkflow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListedWorkflow) SetArn added in v1.40.36 

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

SetArn sets the Arn field's value.

func (*ListedWorkflow) SetDescription added in v1.40.36 

func (s *ListedWorkflow) SetDescription(v string) *ListedWorkflow

SetDescription sets the Description field's value.

func (*ListedWorkflow) SetWorkflowId added in v1.40.36 

func (s *ListedWorkflow) SetWorkflowId(v string) *ListedWorkflow

SetWorkflowId sets the WorkflowId field's value.

func (ListedWorkflow) String added in v1.40.36 

func (s ListedWorkflow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoggingConfiguration added in v1.40.36 

type LoggingConfiguration struct {

	// The name of the CloudWatch logging group for the Amazon Web Services Transfer
	// server to which this workflow belongs.
	LogGroupName *string `min:"1" type:"string"`

	// Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
	// and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
	// logging for Amazon S3 or Amazon EFS events. When set, user activity can be
	// viewed in your CloudWatch logs.
	LoggingRole *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

Consists of the logging role and the log group name.

func (LoggingConfiguration) GoString added in v1.40.36 

func (s LoggingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfiguration) SetLogGroupName added in v1.40.36 

func (s *LoggingConfiguration) SetLogGroupName(v string) *LoggingConfiguration

SetLogGroupName sets the LogGroupName field's value.

func (*LoggingConfiguration) SetLoggingRole added in v1.40.36 

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

SetLoggingRole sets the LoggingRole field's value.

func (LoggingConfiguration) String added in v1.40.36 

func (s LoggingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PosixProfile added in v1.36.22 

type PosixProfile struct {

	// The POSIX group ID used for all EFS operations by this user.
	//
	// Gid is a required field
	Gid *int64 `type:"long" required:"true"`

	// The secondary POSIX group IDs used for all EFS operations by this user.
	SecondaryGids []*int64 `type:"list"`

	// The POSIX user ID used for all EFS operations by this user.
	//
	// Uid is a required field
	Uid *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

func (PosixProfile) GoString added in v1.36.22 

func (s PosixProfile) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PosixProfile) SetGid added in v1.36.22 

func (s *PosixProfile) SetGid(v int64) *PosixProfile

SetGid sets the Gid field's value.

func (*PosixProfile) SetSecondaryGids added in v1.36.22 

func (s *PosixProfile) SetSecondaryGids(v []*int64) *PosixProfile

SetSecondaryGids sets the SecondaryGids field's value.

func (*PosixProfile) SetUid added in v1.36.22 

func (s *PosixProfile) SetUid(v int64) *PosixProfile

SetUid sets the Uid field's value.

func (PosixProfile) String added in v1.36.22 

func (s PosixProfile) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PosixProfile) Validate added in v1.36.22 

func (s *PosixProfile) Validate() error

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

type ProtocolDetails added in v1.38.67 

type ProtocolDetails struct {

	// Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad
	// IPv4 address, such as the external IP address of a firewall, router, or load
	// balancer. For example:
	//
	// aws transfer update-server --protocol-details PassiveIp=0.0.0.0
	//
	// Replace 0.0.0.0 in the example above with the actual IP address you want
	// to use.
	//
	// If you change the PassiveIp value, you must stop and then restart your Transfer
	// server for the change to take effect. For details on using Passive IP (PASV)
	// in a NAT environment, see Configuring your FTPS server behind a firewall
	// or NAT with Amazon Web Services Transfer Family (http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/).
	PassiveIp *string `type:"string"`
	// contains filtered or unexported fields
}

The protocol settings that are configured for your server.

This type is only valid in the UpdateServer API.

func (ProtocolDetails) GoString added in v1.38.67 

func (s ProtocolDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProtocolDetails) SetPassiveIp added in v1.38.67 

func (s *ProtocolDetails) SetPassiveIp(v string) *ProtocolDetails

SetPassiveIp sets the PassiveIp field's value.

func (ProtocolDetails) String added in v1.38.67 

func (s ProtocolDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceExistsException added in v1.28.0 

type ResourceExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// Resource is a required field
	Resource *string `type:"string" required:"true"`

	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The requested resource does not exist.

func (*ResourceExistsException) Code added in v1.28.0 

func (s *ResourceExistsException) Code() string

Code returns the exception type name.

func (*ResourceExistsException) Error added in v1.28.0 

func (s *ResourceExistsException) Error() string

func (ResourceExistsException) GoString added in v1.28.0 

func (s ResourceExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceExistsException) Message added in v1.28.0 

func (s *ResourceExistsException) Message() string

Message returns the exception's message.

func (*ResourceExistsException) OrigErr added in v1.28.0 

func (s *ResourceExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceExistsException) RequestID added in v1.28.0 

func (s *ResourceExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceExistsException) StatusCode added in v1.28.0 

func (s *ResourceExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceExistsException) String added in v1.28.0 

func (s ResourceExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// Resource is a required field
	Resource *string `type:"string" required:"true"`

	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3FileLocation added in v1.40.36 

type S3FileLocation struct {

	// Specifies the S3 bucket that contains the file being used.
	Bucket *string `min:"3" type:"string"`

	// The entity tag is a hash of the object. The ETag reflects changes only to
	// the contents of an object, not its metadata.
	Etag *string `min:"1" type:"string"`

	// The name assigned to the file when it was created in S3. You use the object
	// key to retrieve the object.
	Key *string `type:"string"`

	// Specifies the file version.
	VersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies the details for the file location for the file being used in the workflow. Only applicable if you are using S3 storage.

func (S3FileLocation) GoString added in v1.40.36 

func (s S3FileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3FileLocation) SetBucket added in v1.40.36 

func (s *S3FileLocation) SetBucket(v string) *S3FileLocation

SetBucket sets the Bucket field's value.

func (*S3FileLocation) SetEtag added in v1.40.36 

func (s *S3FileLocation) SetEtag(v string) *S3FileLocation

SetEtag sets the Etag field's value.

func (*S3FileLocation) SetKey added in v1.40.36 

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

SetKey sets the Key field's value.

func (*S3FileLocation) SetVersionId added in v1.40.36 

func (s *S3FileLocation) SetVersionId(v string) *S3FileLocation

SetVersionId sets the VersionId field's value.

func (S3FileLocation) String added in v1.40.36 

func (s S3FileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3InputFileLocation added in v1.40.36 

type S3InputFileLocation struct {

	// Specifies the S3 bucket for the customer input file.
	Bucket *string `min:"3" type:"string"`

	// The name assigned to the file when it was created in S3. You use the object
	// key to retrieve the object.
	Key *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the customer input S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is "/", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

func (S3InputFileLocation) GoString added in v1.40.36 

func (s S3InputFileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3InputFileLocation) SetBucket added in v1.40.36 

func (s *S3InputFileLocation) SetBucket(v string) *S3InputFileLocation

SetBucket sets the Bucket field's value.

func (*S3InputFileLocation) SetKey added in v1.40.36 

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

SetKey sets the Key field's value.

func (S3InputFileLocation) String added in v1.40.36 

func (s S3InputFileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3InputFileLocation) Validate added in v1.40.36 

func (s *S3InputFileLocation) Validate() error

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

type S3Tag added in v1.40.36 

type S3Tag struct {

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

	// The value that corresponds to the key.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.

func (S3Tag) GoString added in v1.40.36 

func (s S3Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Tag) SetKey added in v1.40.36 

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

SetKey sets the Key field's value.

func (*S3Tag) SetValue added in v1.40.36 

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

SetValue sets the Value field's value.

func (S3Tag) String added in v1.40.36 

func (s S3Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Tag) Validate added in v1.40.36 

func (s *S3Tag) Validate() error

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

type SendWorkflowStepStateInput added in v1.40.36 

type SendWorkflowStepStateInput struct {

	// A unique identifier for the execution of a workflow.
	//
	// ExecutionId is a required field
	ExecutionId *string `min:"36" type:"string" required:"true"`

	// Indicates whether the specified step succeeded or failed.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"CustomStepStatus"`

	// Used to distinguish between multiple callbacks for multiple Lambda steps
	// within the same execution.
	//
	// Token is a required field
	Token *string `min:"1" type:"string" required:"true"`

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendWorkflowStepStateInput) GoString added in v1.40.36 

func (s SendWorkflowStepStateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendWorkflowStepStateInput) SetExecutionId added in v1.40.36 

func (s *SendWorkflowStepStateInput) SetExecutionId(v string) *SendWorkflowStepStateInput

SetExecutionId sets the ExecutionId field's value.

func (*SendWorkflowStepStateInput) SetStatus added in v1.40.36 

func (s *SendWorkflowStepStateInput) SetStatus(v string) *SendWorkflowStepStateInput

SetStatus sets the Status field's value.

func (*SendWorkflowStepStateInput) SetToken added in v1.40.36 

func (s *SendWorkflowStepStateInput) SetToken(v string) *SendWorkflowStepStateInput

SetToken sets the Token field's value.

func (*SendWorkflowStepStateInput) SetWorkflowId added in v1.40.36 

func (s *SendWorkflowStepStateInput) SetWorkflowId(v string) *SendWorkflowStepStateInput

SetWorkflowId sets the WorkflowId field's value.

func (SendWorkflowStepStateInput) String added in v1.40.36 

func (s SendWorkflowStepStateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendWorkflowStepStateInput) Validate added in v1.40.36 

func (s *SendWorkflowStepStateInput) Validate() error

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

type SendWorkflowStepStateOutput added in v1.40.36 

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

func (SendWorkflowStepStateOutput) GoString added in v1.40.36 

func (s SendWorkflowStepStateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SendWorkflowStepStateOutput) String added in v1.40.36 

func (s SendWorkflowStepStateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceMetadata added in v1.40.36 

type ServiceMetadata struct {

	// The Server ID (ServerId), Session ID (SessionId) and user (UserName) make
	// up the UserDetails.
	//
	// UserDetails is a required field
	UserDetails *UserDetails `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A container object for the session details associated with a workflow.

func (ServiceMetadata) GoString added in v1.40.36 

func (s ServiceMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceMetadata) SetUserDetails added in v1.40.36 

func (s *ServiceMetadata) SetUserDetails(v *UserDetails) *ServiceMetadata

SetUserDetails sets the UserDetails field's value.

func (ServiceMetadata) String added in v1.40.36 

func (s ServiceMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException added in v1.28.0 

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

func (*ServiceUnavailableException) Code added in v1.28.0 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString added in v1.28.0 

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message added in v1.28.0 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0 

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0 

func (s ServiceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SshPublicKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SshPublicKey) SetDateImported 

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

SetDateImported sets the DateImported field's value.

func (*SshPublicKey) SetSshPublicKeyBody 

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

SetSshPublicKeyBody sets the SshPublicKeyBody field's value.

func (*SshPublicKey) SetSshPublicKeyId 

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

SetSshPublicKeyId sets the SshPublicKeyId field's value.

func (SshPublicKey) String 

func (s SshPublicKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartServerInput 

type StartServerInput struct {

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

func (StartServerInput) GoString 

func (s StartServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartServerInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (StartServerInput) String 

func (s StartServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s StartServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StartServerOutput) String 

func (s StartServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopServerInput 

type StopServerInput struct {

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

func (StopServerInput) GoString 

func (s StopServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopServerInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (StopServerInput) String 

func (s StopServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s StopServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopServerOutput) String 

func (s StopServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

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

SetKey sets the Key field's value.

func (*Tag) SetValue 

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

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services resource,
	// such as a server, user, or role.
	//
	// Arn is a required field
	Arn *string `min:"20" type:"string" required:"true"`

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

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetArn 

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

SetArn sets the Arn field's value.

func (*TagResourceInput) SetTags 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagStepDetails added in v1.40.36 

type TagStepDetails struct {

	// The name of the step, used as an identifier.
	Name *string `type:"string"`

	// Array that contains from 1 to 10 key/value pairs.
	Tags []*S3Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Each step type has its own StepDetails structure.

The key/value pairs used to tag a file during the execution of a workflow step.

func (TagStepDetails) GoString added in v1.40.36 

func (s TagStepDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagStepDetails) SetName added in v1.40.36 

func (s *TagStepDetails) SetName(v string) *TagStepDetails

SetName sets the Name field's value.

func (*TagStepDetails) SetTags added in v1.40.36 

func (s *TagStepDetails) SetTags(v []*S3Tag) *TagStepDetails

SetTags sets the Tags field's value.

func (TagStepDetails) String added in v1.40.36 

func (s TagStepDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagStepDetails) Validate added in v1.40.36 

func (s *TagStepDetails) Validate() error

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

type TestIdentityProviderInput 

type TestIdentityProviderInput struct {

	// A system-assigned identifier for a specific server. That server's user authentication
	// method is tested with a user name and password.
	//
	// ServerId is a required field
	ServerId *string `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 *string `type:"string" enum:"Protocol"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TestIdentityProviderInput's
	// String and GoString methods.
	UserPassword *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (TestIdentityProviderInput) GoString 

func (s TestIdentityProviderInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestIdentityProviderInput) SetServerId 

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

SetServerId sets the ServerId field's value.

func (*TestIdentityProviderInput) SetServerProtocol added in v1.30.13 

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

SetServerProtocol sets the ServerProtocol field's value.

func (*TestIdentityProviderInput) SetSourceIp added in v1.31.14 

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

SetSourceIp sets the SourceIp field's value.

func (*TestIdentityProviderInput) SetUserName 

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

SetUserName sets the UserName field's value.

func (*TestIdentityProviderInput) SetUserPassword 

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

SetUserPassword sets the UserPassword field's value.

func (TestIdentityProviderInput) String 

func (s TestIdentityProviderInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s TestIdentityProviderOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestIdentityProviderOutput) SetMessage 

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

SetMessage sets the Message field's value.

func (*TestIdentityProviderOutput) SetResponse added in v1.23.5 

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

SetResponse sets the Response field's value.

func (*TestIdentityProviderOutput) SetStatusCode 

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

SetStatusCode sets the StatusCode field's value.

func (*TestIdentityProviderOutput) SetUrl 

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

SetUrl sets the Url field's value.

func (TestIdentityProviderOutput) String 

func (s TestIdentityProviderOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.28.0 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	RetryAfterSeconds *string `type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

HTTP Status Code: 400

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Transfer 

type Transfer struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

mySession := session.Must(session.NewSession())

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

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

func (*Transfer) CreateAccess added in v1.38.47 

func (c *Transfer) CreateAccess(input *CreateAccessInput) (*CreateAccessOutput, error)

CreateAccess API operation for AWS Transfer Family.

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceExistsException The requested resource does not exist.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) CreateAccessRequest added in v1.38.47 

func (c *Transfer) CreateAccessRequest(input *CreateAccessInput) (req *request.Request, output *CreateAccessOutput)

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

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

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

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

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

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

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

func (*Transfer) CreateAccessWithContext added in v1.38.47 

func (c *Transfer) CreateAccessWithContext(ctx aws.Context, input *CreateAccessInput, opts ...request.Option) (*CreateAccessOutput, error)

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

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

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

func (*Transfer) CreateServer 

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

CreateServer API operation for AWS Transfer Family.

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. 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.

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

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceExistsException The requested resource does not exist.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) CreateServerRequest 

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

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

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

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

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

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

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

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

func (*Transfer) CreateServerWithContext 

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

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

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

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

func (*Transfer) CreateUser 

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

CreateUser 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 Amazon Web Services Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceExistsException The requested resource does not exist.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) CreateUserRequest 

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

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

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

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

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

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

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

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

func (*Transfer) CreateUserWithContext 

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

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

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

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

func (*Transfer) CreateWorkflow added in v1.40.36 

func (c *Transfer) CreateWorkflow(input *CreateWorkflowInput) (*CreateWorkflowOutput, error)

CreateWorkflow API operation for AWS Transfer Family.

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

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

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceExistsException The requested resource does not exist.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) CreateWorkflowRequest added in v1.40.36 

func (c *Transfer) CreateWorkflowRequest(input *CreateWorkflowInput) (req *request.Request, output *CreateWorkflowOutput)

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

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

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

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

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

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

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

func (*Transfer) CreateWorkflowWithContext added in v1.40.36 

func (c *Transfer) CreateWorkflowWithContext(ctx aws.Context, input *CreateWorkflowInput, opts ...request.Option) (*CreateWorkflowOutput, error)

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

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

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

func (*Transfer) DeleteAccess added in v1.38.47 

func (c *Transfer) DeleteAccess(input *DeleteAccessInput) (*DeleteAccessOutput, error)

DeleteAccess API operation for AWS Transfer Family.

Allows you to delete the access specified in the ServerID and ExternalID parameters.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DeleteAccessRequest added in v1.38.47 

func (c *Transfer) DeleteAccessRequest(input *DeleteAccessInput) (req *request.Request, output *DeleteAccessOutput)

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

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

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

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

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

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

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

func (*Transfer) DeleteAccessWithContext added in v1.38.47 

func (c *Transfer) DeleteAccessWithContext(ctx aws.Context, input *DeleteAccessInput, opts ...request.Option) (*DeleteAccessOutput, error)

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

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

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

func (*Transfer) DeleteServer 

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

DeleteServer API operation for AWS Transfer Family.

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

No response returns from this operation.

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

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DeleteServerRequest 

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

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

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

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

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

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

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

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

func (*Transfer) DeleteServerWithContext 

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

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

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

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

func (*Transfer) DeleteSshPublicKey 

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

DeleteSshPublicKey API operation for AWS Transfer Family.

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) DeleteSshPublicKeyRequest 

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

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

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

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

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

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

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

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

func (*Transfer) DeleteSshPublicKeyWithContext 

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

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

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

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

func (*Transfer) DeleteUser 

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

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DeleteUserRequest 

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

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

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

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

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

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

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

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

func (*Transfer) DeleteUserWithContext 

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

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

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

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

func (*Transfer) DeleteWorkflow added in v1.40.36 

func (c *Transfer) DeleteWorkflow(input *DeleteWorkflowInput) (*DeleteWorkflowOutput, error)

DeleteWorkflow API operation for AWS Transfer Family.

Deletes the specified workflow.

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

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DeleteWorkflowRequest added in v1.40.36 

func (c *Transfer) DeleteWorkflowRequest(input *DeleteWorkflowInput) (req *request.Request, output *DeleteWorkflowOutput)

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

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

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

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

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

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

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

func (*Transfer) DeleteWorkflowWithContext added in v1.40.36 

func (c *Transfer) DeleteWorkflowWithContext(ctx aws.Context, input *DeleteWorkflowInput, opts ...request.Option) (*DeleteWorkflowOutput, error)

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

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

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

func (*Transfer) DescribeAccess added in v1.38.47 

func (c *Transfer) DescribeAccess(input *DescribeAccessInput) (*DescribeAccessOutput, error)

DescribeAccess API operation for AWS Transfer Family.

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalID.

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DescribeAccessRequest added in v1.38.47 

func (c *Transfer) DescribeAccessRequest(input *DescribeAccessInput) (req *request.Request, output *DescribeAccessOutput)

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

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

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

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

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

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

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

func (*Transfer) DescribeAccessWithContext added in v1.38.47 

func (c *Transfer) DescribeAccessWithContext(ctx aws.Context, input *DescribeAccessInput, opts ...request.Option) (*DescribeAccessOutput, error)

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

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

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

func (*Transfer) DescribeExecution added in v1.40.36 

func (c *Transfer) DescribeExecution(input *DescribeExecutionInput) (*DescribeExecutionOutput, error)

DescribeExecution API operation for AWS Transfer Family.

You can use DescribeExecution to check the details of the execution of the specified workflow.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DescribeExecutionRequest added in v1.40.36 

func (c *Transfer) DescribeExecutionRequest(input *DescribeExecutionInput) (req *request.Request, output *DescribeExecutionOutput)

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

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

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

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

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

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

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

func (*Transfer) DescribeExecutionWithContext added in v1.40.36 

func (c *Transfer) DescribeExecutionWithContext(ctx aws.Context, input *DescribeExecutionInput, opts ...request.Option) (*DescribeExecutionOutput, error)

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

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

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

func (*Transfer) DescribeSecurityPolicy added in v1.34.3 

func (c *Transfer) DescribeSecurityPolicy(input *DescribeSecurityPolicyInput) (*DescribeSecurityPolicyOutput, error)

DescribeSecurityPolicy API operation for AWS Transfer Family.

Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html).

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DescribeSecurityPolicyRequest added in v1.34.3 

func (c *Transfer) DescribeSecurityPolicyRequest(input *DescribeSecurityPolicyInput) (req *request.Request, output *DescribeSecurityPolicyOutput)

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

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

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

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

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

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

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

func (*Transfer) DescribeSecurityPolicyWithContext added in v1.34.3 

func (c *Transfer) DescribeSecurityPolicyWithContext(ctx aws.Context, input *DescribeSecurityPolicyInput, opts ...request.Option) (*DescribeSecurityPolicyOutput, error)

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

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

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

func (*Transfer) DescribeServer 

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

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DescribeServerRequest 

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

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

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

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

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

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

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

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

func (*Transfer) DescribeServerWithContext 

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

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

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

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

func (*Transfer) DescribeUser 

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

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DescribeUserRequest 

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

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

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

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

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

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

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

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

func (*Transfer) DescribeUserWithContext 

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

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

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

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

func (*Transfer) DescribeWorkflow added in v1.40.36 

func (c *Transfer) DescribeWorkflow(input *DescribeWorkflowInput) (*DescribeWorkflowOutput, error)

DescribeWorkflow API operation for AWS Transfer Family.

Describes the specified workflow.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) DescribeWorkflowRequest added in v1.40.36 

func (c *Transfer) DescribeWorkflowRequest(input *DescribeWorkflowInput) (req *request.Request, output *DescribeWorkflowOutput)

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

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

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

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

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

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

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

func (*Transfer) DescribeWorkflowWithContext added in v1.40.36 

func (c *Transfer) DescribeWorkflowWithContext(ctx aws.Context, input *DescribeWorkflowInput, opts ...request.Option) (*DescribeWorkflowOutput, error)

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

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

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

func (*Transfer) ImportSshPublicKey 

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

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceExistsException The requested resource does not exist.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) ImportSshPublicKeyRequest 

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

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

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

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

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

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

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

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

func (*Transfer) ImportSshPublicKeyWithContext 

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

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

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

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

func (*Transfer) ListAccesses added in v1.38.47 

func (c *Transfer) ListAccesses(input *ListAccessesInput) (*ListAccessesOutput, error)

ListAccesses API operation for AWS Transfer Family.

Lists the details for all the accesses you have on your server.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidNextTokenException The NextToken parameter that was passed is invalid.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) ListAccessesPages added in v1.38.47 

func (c *Transfer) ListAccessesPages(input *ListAccessesInput, fn func(*ListAccessesOutput, bool) bool) error

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

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

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

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

func (*Transfer) ListAccessesPagesWithContext added in v1.38.47 

func (c *Transfer) ListAccessesPagesWithContext(ctx aws.Context, input *ListAccessesInput, fn func(*ListAccessesOutput, bool) bool, opts ...request.Option) error

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

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

func (*Transfer) ListAccessesRequest added in v1.38.47 

func (c *Transfer) ListAccessesRequest(input *ListAccessesInput) (req *request.Request, output *ListAccessesOutput)

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

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

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

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

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

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

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

func (*Transfer) ListAccessesWithContext added in v1.38.47 

func (c *Transfer) ListAccessesWithContext(ctx aws.Context, input *ListAccessesInput, opts ...request.Option) (*ListAccessesOutput, error)

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

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

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

func (*Transfer) ListExecutions added in v1.40.36 

func (c *Transfer) ListExecutions(input *ListExecutionsInput) (*ListExecutionsOutput, error)

ListExecutions API operation for AWS Transfer Family.

Lists all executions for the specified workflow.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidNextTokenException The NextToken parameter that was passed is invalid.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) ListExecutionsPages added in v1.40.36 

func (c *Transfer) ListExecutionsPages(input *ListExecutionsInput, fn func(*ListExecutionsOutput, bool) bool) error

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

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

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

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

func (*Transfer) ListExecutionsPagesWithContext added in v1.40.36 

func (c *Transfer) ListExecutionsPagesWithContext(ctx aws.Context, input *ListExecutionsInput, fn func(*ListExecutionsOutput, bool) bool, opts ...request.Option) error

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

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

func (*Transfer) ListExecutionsRequest added in v1.40.36 

func (c *Transfer) ListExecutionsRequest(input *ListExecutionsInput) (req *request.Request, output *ListExecutionsOutput)

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

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

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

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

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

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

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

func (*Transfer) ListExecutionsWithContext added in v1.40.36 

func (c *Transfer) ListExecutionsWithContext(ctx aws.Context, input *ListExecutionsInput, opts ...request.Option) (*ListExecutionsOutput, error)

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

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

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

func (*Transfer) ListSecurityPolicies added in v1.34.3 

func (c *Transfer) ListSecurityPolicies(input *ListSecurityPoliciesInput) (*ListSecurityPoliciesOutput, error)

ListSecurityPolicies API operation for AWS Transfer Family.

Lists the security policies that are attached to your file transfer protocol-enabled servers.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidNextTokenException The NextToken parameter that was passed is invalid.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

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

func (*Transfer) ListSecurityPoliciesPages added in v1.34.3 

func (c *Transfer) ListSecurityPoliciesPages(input *ListSecurityPoliciesInput, fn func(*ListSecurityPoliciesOutput, bool) bool) error

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

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

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

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

func (*Transfer) ListSecurityPoliciesPagesWithContext added in v1.34.3 

func (c *Transfer) ListSecurityPoliciesPagesWithContext(ctx aws.Context, input *ListSecurityPoliciesInput, fn func(*ListSecurityPoliciesOutput, bool) bool, opts ...request.Option) error

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

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

func (*Transfer) ListSecurityPoliciesRequest added in v1.34.3 

func (c *Transfer) ListSecurityPoliciesRequest(input *ListSecurityPoliciesInput) (req *request.Request, output *ListSecurityPoliciesOutput)

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

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

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

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

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

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

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

func (*Transfer) ListSecurityPoliciesWithContext added in v1.34.3 

func (c *Transfer) ListSecurityPoliciesWithContext(ctx aws.Context, input *ListSecurityPoliciesInput, opts ...request.Option) (*ListSecurityPoliciesOutput, error)

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

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

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

func (*Transfer) ListServers 

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

ListServers API operation for AWS Transfer Family.

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidNextTokenException The NextToken parameter that was passed is invalid.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

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

func (*Transfer) ListServersPages added in v1.19.20 

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

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

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

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

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

func (*Transfer) ListServersPagesWithContext added in v1.19.20 

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

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

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

func (*Transfer) ListServersRequest 

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

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

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

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

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

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

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

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

func (*Transfer) ListServersWithContext 

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

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

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

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

func (*Transfer) ListTagsForResource 

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

ListTagsForResource API operation for AWS Transfer Family.

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidNextTokenException The NextToken parameter that was passed is invalid.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

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

func (*Transfer) ListTagsForResourcePages added in v1.19.20 

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

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

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

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

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

func (*Transfer) ListTagsForResourcePagesWithContext added in v1.19.20 

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

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

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

func (*Transfer) ListTagsForResourceRequest 

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

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

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

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

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

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

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

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

func (*Transfer) ListTagsForResourceWithContext 

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

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

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

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

func (*Transfer) ListUsers 

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

ListUsers API operation for AWS Transfer Family.

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidNextTokenException The NextToken parameter that was passed is invalid.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) ListUsersPages added in v1.19.20 

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

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

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

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

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

func (*Transfer) ListUsersPagesWithContext added in v1.19.20 

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

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

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

func (*Transfer) ListUsersRequest 

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

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

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

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

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

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

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

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

func (*Transfer) ListUsersWithContext 

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

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

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

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

func (*Transfer) ListWorkflows added in v1.40.36 

func (c *Transfer) ListWorkflows(input *ListWorkflowsInput) (*ListWorkflowsOutput, error)

ListWorkflows API operation for AWS Transfer Family.

Lists all of your workflows.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidNextTokenException The NextToken parameter that was passed is invalid.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

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

func (*Transfer) ListWorkflowsPages added in v1.40.36 

func (c *Transfer) ListWorkflowsPages(input *ListWorkflowsInput, fn func(*ListWorkflowsOutput, bool) bool) error

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

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

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

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

func (*Transfer) ListWorkflowsPagesWithContext added in v1.40.36 

func (c *Transfer) ListWorkflowsPagesWithContext(ctx aws.Context, input *ListWorkflowsInput, fn func(*ListWorkflowsOutput, bool) bool, opts ...request.Option) error

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

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

func (*Transfer) ListWorkflowsRequest added in v1.40.36 

func (c *Transfer) ListWorkflowsRequest(input *ListWorkflowsInput) (req *request.Request, output *ListWorkflowsOutput)

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

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

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

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

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

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

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

func (*Transfer) ListWorkflowsWithContext added in v1.40.36 

func (c *Transfer) ListWorkflowsWithContext(ctx aws.Context, input *ListWorkflowsInput, opts ...request.Option) (*ListWorkflowsOutput, error)

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

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

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

func (*Transfer) SendWorkflowStepState added in v1.40.36 

func (c *Transfer) SendWorkflowStepState(input *SendWorkflowStepStateInput) (*SendWorkflowStepStateOutput, error)

SendWorkflowStepState API operation for AWS Transfer Family.

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

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

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) SendWorkflowStepStateRequest added in v1.40.36 

func (c *Transfer) SendWorkflowStepStateRequest(input *SendWorkflowStepStateInput) (req *request.Request, output *SendWorkflowStepStateOutput)

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

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

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

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

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

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

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

func (*Transfer) SendWorkflowStepStateWithContext added in v1.40.36 

func (c *Transfer) SendWorkflowStepStateWithContext(ctx aws.Context, input *SendWorkflowStepStateInput, opts ...request.Option) (*SendWorkflowStepStateOutput, error)

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

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

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

func (*Transfer) StartServer 

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

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) StartServerRequest 

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

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

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

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

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

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

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

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

func (*Transfer) StartServerWithContext 

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

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

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

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

func (*Transfer) StopServer 

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

StopServer 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; you must delete the server to stop being billed.

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.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) StopServerRequest 

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

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

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

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

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

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

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

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

func (*Transfer) StopServerWithContext 

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

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

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

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

func (*Transfer) TagResource 

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

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) TagResourceRequest 

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

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

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

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

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

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

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

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

func (*Transfer) TagResourceWithContext 

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

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

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

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

func (*Transfer) TestIdentityProvider 

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

TestIdentityProvider API operation for AWS Transfer Family.

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider 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 identity provider integration to ensure that your users can successfully use the service.

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

  • If you provide any incorrect values for any parameters, the Response field is empty.

  • If you provide a server ID for a server that uses service-managed users, you get an error: An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth

  • If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error: An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) TestIdentityProviderRequest 

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

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

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

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

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

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

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

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

func (*Transfer) TestIdentityProviderWithContext 

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

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

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

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

func (*Transfer) UntagResource 

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

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) UntagResourceRequest 

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

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

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

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

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

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

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

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

func (*Transfer) UntagResourceWithContext 

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

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

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

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

func (*Transfer) UpdateAccess added in v1.38.47 

func (c *Transfer) UpdateAccess(input *UpdateAccessInput) (*UpdateAccessOutput, error)

UpdateAccess API operation for AWS Transfer Family.

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceExistsException The requested resource does not exist.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

func (*Transfer) UpdateAccessRequest added in v1.38.47 

func (c *Transfer) UpdateAccessRequest(input *UpdateAccessInput) (req *request.Request, output *UpdateAccessOutput)

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

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

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

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

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

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

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

func (*Transfer) UpdateAccessWithContext added in v1.38.47 

func (c *Transfer) UpdateAccessWithContext(ctx aws.Context, input *UpdateAccessInput, opts ...request.Option) (*UpdateAccessOutput, error)

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

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

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

func (*Transfer) UpdateServer 

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

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

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

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

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • ConflictException This exception is thrown when the UpdateServer 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.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceExistsException The requested resource does not exist.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) UpdateServerRequest 

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

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

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

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

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

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

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

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

func (*Transfer) UpdateServerWithContext 

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

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

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

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

func (*Transfer) UpdateUser 

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

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

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

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

Returned Error Types:

  • ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.

  • InternalServiceError This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException The request was denied due to request throttling.

    HTTP Status Code: 400

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

func (*Transfer) UpdateUserRequest 

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

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

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

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

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

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

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

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

func (*Transfer) UpdateUserWithContext 

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

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

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

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

type UntagResourceInput 

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 Amazon Web Services resource,
	// such as a server, user, or role.
	//
	// Arn is a required field
	Arn *string `min:"20" type:"string" required:"true"`

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

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetArn 

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

SetArn sets the Arn field's value.

func (*UntagResourceInput) SetTagKeys 

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAccessInput added in v1.38.47 

type UpdateAccessInput struct {

	// A unique identifier that is required to identify specific groups within your
	// directory. The users of the group that you associate have access to your
	// Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
	// Web Services Transfer Family. If you know the group name, you can view the
	// SID values by running the following command using Windows PowerShell.
	//
	// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
	// | Select SamAccountName,ObjectSid
	//
	// In that command, replace YourGroupName with the name of your Active Directory
	// group.
	//
	// The regex used to validate this parameter is a string of characters consisting
	// of uppercase and lowercase alphanumeric characters with no spaces. You can
	// also include underscores or any of the following characters: =,.@:/-
	//
	// ExternalId is a required field
	ExternalId *string `min:"1" type:"string" required:"true"`

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

	// Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
	// and keys should be visible to your user and how you want to make them visible.
	// You must specify the Entry and Target pair, where Entry shows how the path
	// is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
	// you only specify a target, it is displayed as is. You also must ensure that
	// your Amazon Web Services Identity and Access Management (IAM) role provides
	// access to paths in Target. This value can only be set when HomeDirectoryType
	// is set to LOGICAL.
	//
	// The following is an Entry and Target pair example.
	//
	// [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
	//
	// In most cases, you can use this value instead of the session policy to lock
	// down your user to the designated home directory ("chroot"). To do this, you
	// can set Entry to / and set Target to the HomeDirectory parameter value.
	//
	// The following is an Entry and Target pair example for chroot.
	//
	// [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
	//
	// If the target of a logical directory entry does not exist in Amazon S3 or
	// EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
	// or EFS API to create 0 byte objects as place holders for your directory.
	// If using the CLI, use the s3api or efsapi call instead of s3 or efs 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 server. If you set it to PATH, the user will
	// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
	// protocol clients. If you set it LOGICAL, you need to provide mappings in
	// the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths
	// visible to your users.
	HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"`

	// A session policy for your user so that 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}.
	//
	// This only applies when the domain of ServerId is S3. EFS does not use session
	// policies.
	//
	// For session policies, Amazon Web Services 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 session policy, see Example session policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html).
	//
	// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
	// in the Amazon Web ServicesSecurity Token Service API Reference.
	Policy *string `type:"string"`

	// The full POSIX identity, including user ID (Uid), group ID (Gid), and any
	// secondary groups IDs (SecondaryGids), that controls your users' access to
	// your Amazon EFS file systems. The POSIX permissions that are set on files
	// and directories in your file system determine the level of access your users
	// get when transferring files into and out of your Amazon EFS file systems.
	PosixProfile *PosixProfile `type:"structure"`

	// Specifies the Amazon Resource Name (ARN) of the IAM role that controls your
	// users' access to your Amazon S3 bucket or EFS file system. The policies attached
	// to this role determine the level of access that you want to provide your
	// users when transferring files into and out of your Amazon S3 bucket or EFS
	// file system. The IAM role should also contain a trust relationship that allows
	// the server to access your resources when servicing your users' transfer requests.
	Role *string `min:"20" type:"string"`

	// A system-assigned unique identifier for a 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"`
	// contains filtered or unexported fields
}

func (UpdateAccessInput) GoString added in v1.38.47 

func (s UpdateAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessInput) SetExternalId added in v1.38.47 

func (s *UpdateAccessInput) SetExternalId(v string) *UpdateAccessInput

SetExternalId sets the ExternalId field's value.

func (*UpdateAccessInput) SetHomeDirectory added in v1.38.47 

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

SetHomeDirectory sets the HomeDirectory field's value.

func (*UpdateAccessInput) SetHomeDirectoryMappings added in v1.38.47 

func (s *UpdateAccessInput) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *UpdateAccessInput

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*UpdateAccessInput) SetHomeDirectoryType added in v1.38.47 

func (s *UpdateAccessInput) SetHomeDirectoryType(v string) *UpdateAccessInput

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*UpdateAccessInput) SetPolicy added in v1.38.47 

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

SetPolicy sets the Policy field's value.

func (*UpdateAccessInput) SetPosixProfile added in v1.38.47 

func (s *UpdateAccessInput) SetPosixProfile(v *PosixProfile) *UpdateAccessInput

SetPosixProfile sets the PosixProfile field's value.

func (*UpdateAccessInput) SetRole added in v1.38.47 

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

SetRole sets the Role field's value.

func (*UpdateAccessInput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (UpdateAccessInput) String added in v1.38.47 

func (s UpdateAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessInput) Validate added in v1.38.47 

func (s *UpdateAccessInput) Validate() error

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

type UpdateAccessOutput added in v1.38.47 

type UpdateAccessOutput struct {

	// The external ID of the group whose users have access to your Amazon S3 or
	// Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer
	// Family.
	//
	// ExternalId is a required field
	ExternalId *string `min:"1" type:"string" required:"true"`

	// The ID of the server that the user is attached to.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAccessOutput) GoString added in v1.38.47 

func (s UpdateAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessOutput) SetExternalId added in v1.38.47 

func (s *UpdateAccessOutput) SetExternalId(v string) *UpdateAccessOutput

SetExternalId sets the ExternalId field's value.

func (*UpdateAccessOutput) SetServerId added in v1.38.47 

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

SetServerId sets the ServerId field's value.

func (UpdateAccessOutput) String added in v1.38.47 

func (s UpdateAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateServerInput 

type UpdateServerInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate 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 Amazon Web ServicesCertificate 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 Amazon Web ServicesCertificate 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 Amazon Web ServicesCertificate 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 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 IP
	// addresses 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 endpoint that you want your server to use. You can choose to
	// make your server's endpoint publicly accessible (PUBLIC) or host it inside
	// your VPC. With an endpoint that is hosted in a VPC, you can restrict access
	// to your server and resources only within your VPC or choose to make it internet
	// facing by attaching Elastic IP addresses directly to it.
	//
	// After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
	// in your Amazon Web Servicesaccount if your account hasn't already done so
	// before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
	// in your Amazon Web Servicesaccount on or before May 19, 2021, you will not
	// be affected. After this date, use EndpointType=VPC.
	//
	// For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
	//
	// 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 *string `type:"string" enum:"EndpointType"`

	// 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 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 Amazon Web ServicesTransfer Family User Guide.
	//
	// HostKey is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateServerInput's
	// String and GoString methods.
	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"`

	// Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
	// and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
	// logging for Amazon S3 or Amazon EFS events. When set, user activity can be
	// viewed in your CloudWatch logs.
	LoggingRole *string `type:"string"`

	// The protocol settings that are configured for your server.
	//
	// Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols).
	// Enter a single dotted-quad IPv4 address, such as the external IP address
	// of a firewall, router, or load balancer.
	ProtocolDetails *ProtocolDetails `type:"structure"`

	// 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 Amazon Web ServicesCertificate
	// 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 AWS_DIRECTORY_SERVICE or 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 []*string `min:"1" type:"list"`

	// Specifies the name of the security policy that is attached to the server.
	SecurityPolicyName *string `type:"string"`

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

	// Specifies the workflow ID for the workflow to assign and the execution role
	// used for executing the workflow.
	WorkflowDetails *WorkflowDetails `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateServerInput) GoString 

func (s UpdateServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServerInput) SetCertificate added in v1.30.13 

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

SetCertificate sets the Certificate field's value.

func (*UpdateServerInput) SetEndpointDetails added in v1.19.3 

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

SetEndpointDetails sets the EndpointDetails field's value.

func (*UpdateServerInput) SetEndpointType added in v1.19.3 

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

SetEndpointType sets the EndpointType field's value.

func (*UpdateServerInput) SetHostKey added in v1.19.20 

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

SetHostKey sets the HostKey field's value.

func (*UpdateServerInput) SetIdentityProviderDetails 

func (s *UpdateServerInput) SetIdentityProviderDetails(v *IdentityProviderDetails) *UpdateServerInput

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.

func (*UpdateServerInput) SetLoggingRole 

func (s *UpdateServerInput) SetLoggingRole(v string) *UpdateServerInput

SetLoggingRole sets the LoggingRole field's value.

func (*UpdateServerInput) SetProtocolDetails added in v1.38.67 

func (s *UpdateServerInput) SetProtocolDetails(v *ProtocolDetails) *UpdateServerInput

SetProtocolDetails sets the ProtocolDetails field's value.

func (*UpdateServerInput) SetProtocols added in v1.30.13 

func (s *UpdateServerInput) SetProtocols(v []*string) *UpdateServerInput

SetProtocols sets the Protocols field's value.

func (*UpdateServerInput) SetSecurityPolicyName added in v1.34.3 

func (s *UpdateServerInput) SetSecurityPolicyName(v string) *UpdateServerInput

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*UpdateServerInput) SetServerId 

func (s *UpdateServerInput) SetServerId(v string) *UpdateServerInput

SetServerId sets the ServerId field's value.

func (*UpdateServerInput) SetWorkflowDetails added in v1.40.36 

func (s *UpdateServerInput) SetWorkflowDetails(v *WorkflowDetails) *UpdateServerInput

SetWorkflowDetails sets the WorkflowDetails field's value.

func (UpdateServerInput) String 

func (s UpdateServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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) GoString 

func (s UpdateServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServerOutput) SetServerId 

func (s *UpdateServerOutput) SetServerId(v string) *UpdateServerOutput

SetServerId sets the ServerId field's value.

func (UpdateServerOutput) String 

func (s UpdateServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateUserInput 

type UpdateUserInput struct {

	// The landing directory (folder) for a user when they log in to the server
	// using the client.
	//
	// A HomeDirectory example is /bucket_name/home/mydirectory.
	HomeDirectory *string `type:"string"`

	// Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
	// and keys should be visible to your user and how you want to make them visible.
	// You must specify the Entry and Target pair, where Entry shows how the path
	// is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
	// you only specify a target, it is displayed as is. You also must ensure that
	// your Amazon Web Services Identity and Access Management (IAM) role provides
	// access to paths in Target. This value can only be set when HomeDirectoryType
	// is set to LOGICAL.
	//
	// The following is an Entry and Target pair example.
	//
	// [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
	//
	// In most cases, you can use this value instead of the session policy to lock
	// down your user to the designated home directory ("chroot"). To do this, you
	// can set Entry to '/' and set Target to the HomeDirectory parameter value.
	//
	// The following is an Entry and Target pair example for chroot.
	//
	// [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
	//
	// If the target of a logical directory entry does not exist in Amazon S3 or
	// EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
	// or EFS API to create 0 byte objects as place holders for your directory.
	// If using the CLI, use the s3api or efsapi call instead of s3 or efs 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 server. If you set it to PATH, the user will
	// see the absolute Amazon S3 bucket or EFS paths as is in their file transfer
	// protocol clients. If you set it LOGICAL, you need to provide mappings in
	// the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths
	// visible to your users.
	HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"`

	// A session policy for your user so that 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}.
	//
	// This only applies when the domain of ServerId is S3. EFS does not use session
	// policies.
	//
	// For session policies, Amazon Web Services 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 session policy, see Creating a session policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy).
	//
	// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
	// in the Amazon Web Services Security Token Service API Reference.
	Policy *string `type:"string"`

	// Specifies the full POSIX identity, including user ID (Uid), group ID (Gid),
	// and any secondary groups IDs (SecondaryGids), that controls your users' access
	// to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that
	// are set on files and directories in your file system determines the level
	// of access your users get when transferring files into and out of your Amazon
	// EFS file systems.
	PosixProfile *PosixProfile `type:"structure"`

	// Specifies the Amazon Resource Name (ARN) of the IAM role that controls your
	// users' access to your Amazon S3 bucket or EFS file system. The policies attached
	// to this role determine the level of access that you want to provide your
	// users when transferring files into and out of your Amazon S3 bucket or EFS
	// file system. The IAM role should also contain a trust relationship that allows
	// the server to access your resources when servicing your users' transfer requests.
	Role *string `min:"20" type:"string"`

	// A system-assigned unique identifier for a 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 server as
	// specified by the ServerId. This user name must be a minimum of 3 and a maximum
	// of 100 characters long. The following are valid characters: a-z, A-Z, 0-9,
	// underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't
	// start with a hyphen, period, or at sign.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserInput) GoString 

func (s UpdateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateUserInput) SetHomeDirectory 

func (s *UpdateUserInput) SetHomeDirectory(v string) *UpdateUserInput

SetHomeDirectory sets the HomeDirectory field's value.

func (*UpdateUserInput) SetHomeDirectoryMappings added in v1.25.20 

func (s *UpdateUserInput) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *UpdateUserInput

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*UpdateUserInput) SetHomeDirectoryType added in v1.25.20 

func (s *UpdateUserInput) SetHomeDirectoryType(v string) *UpdateUserInput

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*UpdateUserInput) SetPolicy 

func (s *UpdateUserInput) SetPolicy(v string) *UpdateUserInput

SetPolicy sets the Policy field's value.

func (*UpdateUserInput) SetPosixProfile added in v1.36.22 

func (s *UpdateUserInput) SetPosixProfile(v *PosixProfile) *UpdateUserInput

SetPosixProfile sets the PosixProfile field's value.

func (*UpdateUserInput) SetRole 

func (s *UpdateUserInput) SetRole(v string) *UpdateUserInput

SetRole sets the Role field's value.

func (*UpdateUserInput) SetServerId 

func (s *UpdateUserInput) SetServerId(v string) *UpdateUserInput

SetServerId sets the ServerId field's value.

func (*UpdateUserInput) SetUserName 

func (s *UpdateUserInput) SetUserName(v string) *UpdateUserInput

SetUserName sets the UserName field's value.

func (UpdateUserInput) String 

func (s UpdateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 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 identifier for the request to update a user's properties.

func (UpdateUserOutput) GoString 

func (s UpdateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateUserOutput) SetServerId 

func (s *UpdateUserOutput) SetServerId(v string) *UpdateUserOutput

SetServerId sets the ServerId field's value.

func (*UpdateUserOutput) SetUserName 

func (s *UpdateUserOutput) SetUserName(v string) *UpdateUserOutput

SetUserName sets the UserName field's value.

func (UpdateUserOutput) String 

func (s UpdateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserDetails added in v1.40.36 

type UserDetails struct {

	// The system-assigned unique identifier for a Transfer server instance.
	//
	// ServerId is a required field
	ServerId *string `min:"19" type:"string" required:"true"`

	// The system-assigned unique identifier for a session that corresponds to the
	// workflow.
	SessionId *string `min:"3" type:"string"`

	// A unique string that identifies a user account associated with a server.
	//
	// UserName is a required field
	UserName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the user name, server ID, and session ID for a workflow.

func (UserDetails) GoString added in v1.40.36 

func (s UserDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserDetails) SetServerId added in v1.40.36 

func (s *UserDetails) SetServerId(v string) *UserDetails

SetServerId sets the ServerId field's value.

func (*UserDetails) SetSessionId added in v1.40.36 

func (s *UserDetails) SetSessionId(v string) *UserDetails

SetSessionId sets the SessionId field's value.

func (*UserDetails) SetUserName added in v1.40.36 

func (s *UserDetails) SetUserName(v string) *UserDetails

SetUserName sets the UserName field's value.

func (UserDetails) String added in v1.40.36 

func (s UserDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkflowDetail added in v1.40.36 

type WorkflowDetail struct {

	// Includes the necessary permissions for S3, EFS, and Lambda operations that
	// Transfer can assume, so that all workflow steps can operate on the required
	// resources
	//
	// ExecutionRole is a required field
	ExecutionRole *string `min:"20" type:"string" required:"true"`

	// A unique identifier for the workflow.
	//
	// WorkflowId is a required field
	WorkflowId *string `min:"19" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

func (WorkflowDetail) GoString added in v1.40.36 

func (s WorkflowDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkflowDetail) SetExecutionRole added in v1.40.36 

func (s *WorkflowDetail) SetExecutionRole(v string) *WorkflowDetail

SetExecutionRole sets the ExecutionRole field's value.

func (*WorkflowDetail) SetWorkflowId added in v1.40.36 

func (s *WorkflowDetail) SetWorkflowId(v string) *WorkflowDetail

SetWorkflowId sets the WorkflowId field's value.

func (WorkflowDetail) String added in v1.40.36 

func (s WorkflowDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkflowDetail) Validate added in v1.40.36 

func (s *WorkflowDetail) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkflowDetails added in v1.40.36 

type WorkflowDetails struct {

	// A trigger that starts a workflow: the workflow begins to execute after a
	// file is uploaded.
	//
	// OnUpload is a required field
	OnUpload []*WorkflowDetail `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

func (WorkflowDetails) GoString added in v1.40.36 

func (s WorkflowDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkflowDetails) SetOnUpload added in v1.40.36 

func (s *WorkflowDetails) SetOnUpload(v []*WorkflowDetail) *WorkflowDetails

SetOnUpload sets the OnUpload field's value.

func (WorkflowDetails) String added in v1.40.36 

func (s WorkflowDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkflowDetails) Validate added in v1.40.36 

func (s *WorkflowDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkflowStep added in v1.40.36 

type WorkflowStep struct {

	// Details for a step that performs a file copy.
	//
	// Consists of the following values:
	//
	//    * A description
	//
	//    * An S3 location for the destination of the file copy.
	//
	//    * A flag that indicates whether or not to overwrite an existing file of
	//    the same name. The default is FALSE.
	CopyStepDetails *CopyStepDetails `type:"structure"`

	// Details for a step that invokes a lambda function.
	//
	// Consists of the lambda function name, target, and timeout (in seconds).
	CustomStepDetails *CustomStepDetails `type:"structure"`

	// Details for a step that deletes the file.
	DeleteStepDetails *DeleteStepDetails `type:"structure"`

	// Details for a step that creates one or more tags.
	//
	// You specify one or more tags: each tag contains a key/value pair.
	TagStepDetails *TagStepDetails `type:"structure"`

	// Currently, the following step types are supported.
	//
	//    * Copy: copy the file to another location
	//
	//    * Custom: custom step with a lambda target
	//
	//    * Delete: delete the file
	//
	//    * Tag: add a tag to the file
	Type *string `type:"string" enum:"WorkflowStepType"`
	// contains filtered or unexported fields
}

The basic building block of a workflow.

func (WorkflowStep) GoString added in v1.40.36 

func (s WorkflowStep) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkflowStep) SetCopyStepDetails added in v1.40.36 

func (s *WorkflowStep) SetCopyStepDetails(v *CopyStepDetails) *WorkflowStep

SetCopyStepDetails sets the CopyStepDetails field's value.

func (*WorkflowStep) SetCustomStepDetails added in v1.40.36 

func (s *WorkflowStep) SetCustomStepDetails(v *CustomStepDetails) *WorkflowStep

SetCustomStepDetails sets the CustomStepDetails field's value.

func (*WorkflowStep) SetDeleteStepDetails added in v1.40.36 

func (s *WorkflowStep) SetDeleteStepDetails(v *DeleteStepDetails) *WorkflowStep

SetDeleteStepDetails sets the DeleteStepDetails field's value.

func (*WorkflowStep) SetTagStepDetails added in v1.40.36 

func (s *WorkflowStep) SetTagStepDetails(v *TagStepDetails) *WorkflowStep

SetTagStepDetails sets the TagStepDetails field's value.

func (*WorkflowStep) SetType added in v1.40.36 

func (s *WorkflowStep) SetType(v string) *WorkflowStep

SetType sets the Type field's value.

func (WorkflowStep) String added in v1.40.36 

func (s WorkflowStep) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkflowStep) Validate added in v1.40.36 

func (s *WorkflowStep) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.