func AgreementStatusType_Values() []string
AgreementStatusType_Values returns all elements of the AgreementStatusType enum
func As2Transport_Values() []string
As2Transport_Values returns all elements of the As2Transport enum
func CertificateStatusType_Values() []string
CertificateStatusType_Values returns all elements of the CertificateStatusType enum
func CertificateType_Values() []string
CertificateType_Values returns all elements of the CertificateType enum
func CertificateUsageType_Values() []string
CertificateUsageType_Values returns all elements of the CertificateUsageType enum
func CompressionEnum_Values() []string
CompressionEnum_Values returns all elements of the CompressionEnum enum
func CustomStepStatus_Values() []string
CustomStepStatus_Values returns all elements of the CustomStepStatus enum
func DirectoryListingOptimization_Values() []string
DirectoryListingOptimization_Values returns all elements of the DirectoryListingOptimization enum
func Domain_Values() []string
Domain_Values returns all elements of the Domain enum
func EncryptionAlg_Values() []string
EncryptionAlg_Values returns all elements of the EncryptionAlg enum
func EncryptionType_Values() []string
EncryptionType_Values returns all elements of the EncryptionType enum
func EndpointType_Values() []string
EndpointType_Values returns all elements of the EndpointType enum
func ExecutionErrorType_Values() []string
ExecutionErrorType_Values returns all elements of the ExecutionErrorType enum
func ExecutionStatus_Values() []string
ExecutionStatus_Values returns all elements of the ExecutionStatus enum
func HomeDirectoryType_Values() []string
HomeDirectoryType_Values returns all elements of the HomeDirectoryType enum
func IdentityProviderType_Values() []string
IdentityProviderType_Values returns all elements of the IdentityProviderType enum
func MapType_Values() []string
MapType_Values returns all elements of the MapType enum
func MdnResponse_Values() []string
MdnResponse_Values returns all elements of the MdnResponse enum
func MdnSigningAlg_Values() []string
MdnSigningAlg_Values returns all elements of the MdnSigningAlg enum
func OverwriteExisting_Values() []string
OverwriteExisting_Values returns all elements of the OverwriteExisting enum
func ProfileType_Values() []string
ProfileType_Values returns all elements of the ProfileType enum
func Protocol_Values() []string
Protocol_Values returns all elements of the Protocol enum
func SecurityPolicyProtocol_Values() []string
SecurityPolicyProtocol_Values returns all elements of the SecurityPolicyProtocol enum
func SecurityPolicyResourceType_Values() []string
SecurityPolicyResourceType_Values returns all elements of the SecurityPolicyResourceType enum
func SetStatOption_Values() []string
SetStatOption_Values returns all elements of the SetStatOption enum
func SftpAuthenticationMethods_Values() []string
SftpAuthenticationMethods_Values returns all elements of the SftpAuthenticationMethods enum
func SigningAlg_Values() []string
SigningAlg_Values returns all elements of the SigningAlg enum
func State_Values() []string
State_Values returns all elements of the State enum
func TlsSessionResumptionMode_Values() []string
TlsSessionResumptionMode_Values returns all elements of the TlsSessionResumptionMode enum
func WorkflowStepType_Values() []string
WorkflowStepType_Values returns all elements of the WorkflowStepType enum
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 (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
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 (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 As2ConnectorConfig struct { // Provides Basic authentication support to the AS2 Connectors API. To use Basic // authentication, you must provide the name or Amazon Resource Name (ARN) of // a secret in Secrets Manager. // // The default value for this parameter is null, which indicates that Basic // authentication is not enabled for the connector. // // If the connector should use Basic authentication, the secret needs to be // in the following format: // // { "Username": "user-name", "Password": "user-password" } // // Replace user-name and user-password with the credentials for the actual user // that is being authenticated. // // Note the following: // // * You are storing these credentials in Secrets Manager, not passing them // directly into this API. // // * If you are using the API, SDKs, or CloudFormation to configure your // connector, then you must create the secret before you can enable Basic // authentication. However, if you are using the Amazon Web Services management // console, you can have the system create the secret for you. // // If you have previously enabled Basic authentication for a connector, you // can disable it by using the UpdateConnector API call. For example, if you // are using the CLI, you can run the following command to remove Basic authentication: // // update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""' BasicAuthSecretId *string `type:"string"` // Specifies whether the AS2 file is compressed. Compression *string `type:"string" enum:"CompressionEnum"` // The algorithm that is used to encrypt the file. // // Note the following: // // * Do not use the DES_EDE3_CBC algorithm unless you must support a legacy // client that requires it, as it is a weak encryption algorithm. // // * You can only specify NONE if the URL for your connector uses HTTPS. // Using HTTPS ensures that no traffic is sent in clear text. EncryptionAlgorithm *string `type:"string" enum:"EncryptionAlg"` // A unique identifier for the AS2 local profile. LocalProfileId *string `min:"19" type:"string"` // Used for outbound requests (from an Transfer Family server to a partner AS2 // server) to determine whether the partner response for transfers is synchronous // or asynchronous. Specify either of the following values: // // * SYNC: The system expects a synchronous MDN response, confirming that // the file was transferred successfully (or not). // // * NONE: Specifies that no MDN response is required. MdnResponse *string `type:"string" enum:"MdnResponse"` // The signing algorithm for the MDN response. // // If set to DEFAULT (or not set at all), the value for SigningAlgorithm is // used. MdnSigningAlgorithm *string `type:"string" enum:"MdnSigningAlg"` // Used as the Subject HTTP header attribute in AS2 messages that are being // sent with the connector. MessageSubject *string `min:"1" type:"string"` // A unique identifier for the partner profile for the connector. PartnerProfileId *string `min:"19" type:"string"` // The algorithm that is used to sign the AS2 messages sent with the connector. SigningAlgorithm *string `type:"string" enum:"SigningAlg"` // contains filtered or unexported fields }
Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.
func (s As2ConnectorConfig) 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 (s *As2ConnectorConfig) SetBasicAuthSecretId(v string) *As2ConnectorConfig
SetBasicAuthSecretId sets the BasicAuthSecretId field's value.
func (s *As2ConnectorConfig) SetCompression(v string) *As2ConnectorConfig
SetCompression sets the Compression field's value.
func (s *As2ConnectorConfig) SetEncryptionAlgorithm(v string) *As2ConnectorConfig
SetEncryptionAlgorithm sets the EncryptionAlgorithm field's value.
func (s *As2ConnectorConfig) SetLocalProfileId(v string) *As2ConnectorConfig
SetLocalProfileId sets the LocalProfileId field's value.
func (s *As2ConnectorConfig) SetMdnResponse(v string) *As2ConnectorConfig
SetMdnResponse sets the MdnResponse field's value.
func (s *As2ConnectorConfig) SetMdnSigningAlgorithm(v string) *As2ConnectorConfig
SetMdnSigningAlgorithm sets the MdnSigningAlgorithm field's value.
func (s *As2ConnectorConfig) SetMessageSubject(v string) *As2ConnectorConfig
SetMessageSubject sets the MessageSubject field's value.
func (s *As2ConnectorConfig) SetPartnerProfileId(v string) *As2ConnectorConfig
SetPartnerProfileId sets the PartnerProfileId field's value.
func (s *As2ConnectorConfig) SetSigningAlgorithm(v string) *As2ConnectorConfig
SetSigningAlgorithm sets the SigningAlgorithm field's value.
func (s As2ConnectorConfig) 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 (s *As2ConnectorConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
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 (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 struct { // Specifies the location for the file being copied. Use ${Transfer:UserName} // or ${Transfer:UploadDate} in this field to parametrize the destination prefix // by username or uploaded date. // // * Set the value of DestinationFileLocation to ${Transfer:UserName} to // copy uploaded files to an Amazon S3 bucket that is prefixed with the name // of the Transfer Family user that uploaded the file. // // * Set the value of DestinationFileLocation to ${Transfer:UploadDate} to // copy uploaded files to an Amazon S3 bucket that is prefixed with the date // of the upload. The system resolves UploadDate to a date format of YYYY-MM-DD, // based on the date the file is uploaded in UTC. DestinationFileLocation *InputFileLocation `type:"structure"` // The name of the step, used as an identifier. Name *string `type:"string"` // A flag that indicates whether to overwrite an existing file of the same name. // The default is FALSE. // // If the workflow is processing a file that has the same name as an existing // file, the behavior is as follows: // // * If OverwriteExisting is TRUE, the existing file is replaced with the // file being processed. // // * If OverwriteExisting is FALSE, nothing happens, and the workflow processing // stops. OverwriteExisting *string `type:"string" enum:"OverwriteExisting"` // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. // // * To use the previous file as the input, enter ${previous.file}. In this // case, this workflow step uses the output file from the previous workflow // step as input. This is the default value. // // * To use the originally uploaded file location as input for this step, // enter ${original.file}. SourceFileLocation *string `type:"string"` // contains filtered or unexported fields }
Each step type has its own StepDetails structure.
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 (s *CopyStepDetails) SetDestinationFileLocation(v *InputFileLocation) *CopyStepDetails
SetDestinationFileLocation sets the DestinationFileLocation field's value.
func (s *CopyStepDetails) SetName(v string) *CopyStepDetails
SetName sets the Name field's value.
func (s *CopyStepDetails) SetOverwriteExisting(v string) *CopyStepDetails
SetOverwriteExisting sets the OverwriteExisting field's value.
func (s *CopyStepDetails) SetSourceFileLocation(v string) *CopyStepDetails
SetSourceFileLocation sets the SourceFileLocation field's value.
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 (s *CopyStepDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 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 regular expression 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. // // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. 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 Identity and Access Management (IAM) role provides access to paths in // Target. This value can be set only 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" } ] HomeDirectoryMappings []*HomeDirectoryMapEntry `min:"1" type:"list"` // The type of landing directory (folder) that you want your users' home directory // to be when they log in to the server. If you set it to PATH, the user will // see the absolute Amazon S3 bucket or Amazon EFS path as is in their file // transfer protocol clients. If you set it to LOGICAL, you need to provide // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 // or Amazon EFS paths visible to your users. // // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide // an absolute path using the HomeDirectory parameter. You cannot have both // HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"` // A session policy for your user so that you can use the same Identity and // Access Management (IAM) role across multiple users. This policy scopes down // a user's 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 policy applies only when the domain of ServerId is Amazon S3. Amazon // EFS does not use session policies. // // For session policies, 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 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"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that controls your users' access to your Amazon S3 bucket or Amazon // 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 Amazon 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 (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 (s *CreateAccessInput) SetExternalId(v string) *CreateAccessInput
SetExternalId sets the ExternalId field's value.
func (s *CreateAccessInput) SetHomeDirectory(v string) *CreateAccessInput
SetHomeDirectory sets the HomeDirectory field's value.
func (s *CreateAccessInput) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *CreateAccessInput
SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.
func (s *CreateAccessInput) SetHomeDirectoryType(v string) *CreateAccessInput
SetHomeDirectoryType sets the HomeDirectoryType field's value.
func (s *CreateAccessInput) SetPolicy(v string) *CreateAccessInput
SetPolicy sets the Policy field's value.
func (s *CreateAccessInput) SetPosixProfile(v *PosixProfile) *CreateAccessInput
SetPosixProfile sets the PosixProfile field's value.
func (s *CreateAccessInput) SetRole(v string) *CreateAccessInput
SetRole sets the Role field's value.
func (s *CreateAccessInput) SetServerId(v string) *CreateAccessInput
SetServerId sets the ServerId field's value.
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 (s *CreateAccessInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAccessOutput struct { // The external identifier of the group whose users have access to your Amazon // S3 or Amazon EFS resources over the enabled protocols using Transfer Family. // // ExternalId is a required field ExternalId *string `min:"1" type:"string" required:"true"` // The identifier 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 (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 (s *CreateAccessOutput) SetExternalId(v string) *CreateAccessOutput
SetExternalId sets the ExternalId field's value.
func (s *CreateAccessOutput) SetServerId(v string) *CreateAccessOutput
SetServerId sets the ServerId field's value.
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 CreateAgreementInput struct { // Connectors are used to send files using either the AS2 or SFTP protocol. // For the access role, provide the Amazon Resource Name (ARN) of the Identity // and Access Management role to use. // // For AS2 connectors // // With AS2, you can send files by calling StartFileTransfer and specifying // the file paths in the request parameter, SendFilePaths. We use the file’s // parent directory (for example, for --send-file-paths /bucket/dir/file.txt, // parent directory is /bucket/dir/) to temporarily store a processed AS2 message // file, store the MDN when we receive them from the partner, and write a final // JSON file containing relevant metadata of the transmission. So, the AccessRole // needs to provide read and write access to the parent directory of the file // location used in the StartFileTransfer request. Additionally, you need to // provide read and write access to the parent directory of the files that you // intend to send with StartFileTransfer. // // If you are using Basic authentication for your AS2 connector, the access // role requires the secretsmanager:GetSecretValue permission for the secret. // If the secret is encrypted using a customer-managed key instead of the Amazon // Web Services managed key in Secrets Manager, then the role also needs the // kms:Decrypt permission for that key. // // For SFTP connectors // // Make sure that the access role provides read and write access to the parent // directory of the file location that's used in the StartFileTransfer request. // Additionally, make sure that the role provides secretsmanager:GetSecretValue // permission to Secrets Manager. // // AccessRole is a required field AccessRole *string `min:"20" type:"string" required:"true"` // The landing directory (folder) for files transferred by using the AS2 protocol. // // A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory. // // BaseDirectory is a required field BaseDirectory *string `type:"string" required:"true"` // A name or short description to identify the agreement. Description *string `min:"1" type:"string"` // A unique identifier for the AS2 local profile. // // LocalProfileId is a required field LocalProfileId *string `min:"19" type:"string" required:"true"` // A unique identifier for the partner profile used in the agreement. // // PartnerProfileId is a required field PartnerProfileId *string `min:"19" type:"string" required:"true"` // A system-assigned unique identifier for a server instance. This is the specific // server that the agreement uses. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // The status of the agreement. The agreement can be either ACTIVE or INACTIVE. Status *string `type:"string" enum:"AgreementStatusType"` // Key-value pairs that can be used to group and search for agreements. Tags []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
func (s CreateAgreementInput) 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 (s *CreateAgreementInput) SetAccessRole(v string) *CreateAgreementInput
SetAccessRole sets the AccessRole field's value.
func (s *CreateAgreementInput) SetBaseDirectory(v string) *CreateAgreementInput
SetBaseDirectory sets the BaseDirectory field's value.
func (s *CreateAgreementInput) SetDescription(v string) *CreateAgreementInput
SetDescription sets the Description field's value.
func (s *CreateAgreementInput) SetLocalProfileId(v string) *CreateAgreementInput
SetLocalProfileId sets the LocalProfileId field's value.
func (s *CreateAgreementInput) SetPartnerProfileId(v string) *CreateAgreementInput
SetPartnerProfileId sets the PartnerProfileId field's value.
func (s *CreateAgreementInput) SetServerId(v string) *CreateAgreementInput
SetServerId sets the ServerId field's value.
func (s *CreateAgreementInput) SetStatus(v string) *CreateAgreementInput
SetStatus sets the Status field's value.
func (s *CreateAgreementInput) SetTags(v []*Tag) *CreateAgreementInput
SetTags sets the Tags field's value.
func (s CreateAgreementInput) 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 (s *CreateAgreementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAgreementOutput struct { // The unique identifier for the agreement. Use this ID for deleting, or updating // an agreement, as well as in any other API calls that require that you specify // the agreement ID. // // AgreementId is a required field AgreementId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateAgreementOutput) 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 (s *CreateAgreementOutput) SetAgreementId(v string) *CreateAgreementOutput
SetAgreementId sets the AgreementId field's value.
func (s CreateAgreementOutput) 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 CreateConnectorInput struct { // Connectors are used to send files using either the AS2 or SFTP protocol. // For the access role, provide the Amazon Resource Name (ARN) of the Identity // and Access Management role to use. // // For AS2 connectors // // With AS2, you can send files by calling StartFileTransfer and specifying // the file paths in the request parameter, SendFilePaths. We use the file’s // parent directory (for example, for --send-file-paths /bucket/dir/file.txt, // parent directory is /bucket/dir/) to temporarily store a processed AS2 message // file, store the MDN when we receive them from the partner, and write a final // JSON file containing relevant metadata of the transmission. So, the AccessRole // needs to provide read and write access to the parent directory of the file // location used in the StartFileTransfer request. Additionally, you need to // provide read and write access to the parent directory of the files that you // intend to send with StartFileTransfer. // // If you are using Basic authentication for your AS2 connector, the access // role requires the secretsmanager:GetSecretValue permission for the secret. // If the secret is encrypted using a customer-managed key instead of the Amazon // Web Services managed key in Secrets Manager, then the role also needs the // kms:Decrypt permission for that key. // // For SFTP connectors // // Make sure that the access role provides read and write access to the parent // directory of the file location that's used in the StartFileTransfer request. // Additionally, make sure that the role provides secretsmanager:GetSecretValue // permission to Secrets Manager. // // AccessRole is a required field AccessRole *string `min:"20" type:"string" required:"true"` // A structure that contains the parameters for an AS2 connector object. As2Config *As2ConnectorConfig `type:"structure"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that allows a connector to turn on CloudWatch logging for Amazon S3 // events. When set, you can view connector activity in your CloudWatch logs. LoggingRole *string `min:"20" type:"string"` // Specifies the name of the security policy for the connector. SecurityPolicyName *string `type:"string"` // A structure that contains the parameters for an SFTP connector object. SftpConfig *SftpConnectorConfig `type:"structure"` // Key-value pairs that can be used to group and search for connectors. Tags // are metadata attached to connectors for any purpose. Tags []*Tag `min:"1" type:"list"` // The URL of the partner's AS2 or SFTP endpoint. // // Url is a required field Url *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateConnectorInput) 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 (s *CreateConnectorInput) SetAccessRole(v string) *CreateConnectorInput
SetAccessRole sets the AccessRole field's value.
func (s *CreateConnectorInput) SetAs2Config(v *As2ConnectorConfig) *CreateConnectorInput
SetAs2Config sets the As2Config field's value.
func (s *CreateConnectorInput) SetLoggingRole(v string) *CreateConnectorInput
SetLoggingRole sets the LoggingRole field's value.
func (s *CreateConnectorInput) SetSecurityPolicyName(v string) *CreateConnectorInput
SetSecurityPolicyName sets the SecurityPolicyName field's value.
func (s *CreateConnectorInput) SetSftpConfig(v *SftpConnectorConfig) *CreateConnectorInput
SetSftpConfig sets the SftpConfig field's value.
func (s *CreateConnectorInput) SetTags(v []*Tag) *CreateConnectorInput
SetTags sets the Tags field's value.
func (s *CreateConnectorInput) SetUrl(v string) *CreateConnectorInput
SetUrl sets the Url field's value.
func (s CreateConnectorInput) 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 (s *CreateConnectorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateConnectorOutput struct { // The unique identifier for the connector, returned after the API call succeeds. // // ConnectorId is a required field ConnectorId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateConnectorOutput) 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 (s *CreateConnectorOutput) SetConnectorId(v string) *CreateConnectorOutput
SetConnectorId sets the ConnectorId field's value.
func (s CreateConnectorOutput) 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 CreateProfileInput struct { // The As2Id is the AS2-name, as defined in the RFC 4130 (https://datatracker.ietf.org/doc/html/rfc4130). // For inbound transfers, this is the AS2-From header for the AS2 messages sent // from the partner. For outbound connectors, this is the AS2-To header for // the AS2 messages sent to the partner using the StartFileTransfer API operation. // This ID cannot include spaces. // // As2Id is a required field As2Id *string `min:"1" type:"string" required:"true"` // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. CertificateIds []*string `type:"list"` // Determines the type of profile to create: // // * Specify LOCAL to create a local profile. A local profile represents // the AS2-enabled Transfer Family server organization or party. // // * Specify PARTNER to create a partner profile. A partner profile represents // a remote organization, external to Transfer Family. // // ProfileType is a required field ProfileType *string `type:"string" required:"true" enum:"ProfileType"` // Key-value pairs that can be used to group and search for AS2 profiles. Tags []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
func (s CreateProfileInput) 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 (s *CreateProfileInput) SetAs2Id(v string) *CreateProfileInput
SetAs2Id sets the As2Id field's value.
func (s *CreateProfileInput) SetCertificateIds(v []*string) *CreateProfileInput
SetCertificateIds sets the CertificateIds field's value.
func (s *CreateProfileInput) SetProfileType(v string) *CreateProfileInput
SetProfileType sets the ProfileType field's value.
func (s *CreateProfileInput) SetTags(v []*Tag) *CreateProfileInput
SetTags sets the Tags field's value.
func (s CreateProfileInput) 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 (s *CreateProfileInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateProfileOutput struct { // The unique identifier for the AS2 profile, returned after the API call succeeds. // // ProfileId is a required field ProfileId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateProfileOutput) 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 (s *CreateProfileOutput) SetProfileId(v string) *CreateProfileOutput
SetProfileId sets the ProfileId field's value.
func (s CreateProfileOutput) 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 struct { // The Amazon Resource Name (ARN) of the 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 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 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 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 your // endpoint accessible only to resources within your VPC, or you can attach // Elastic IP addresses and make your endpoint 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, ECDSA, or ED25519 private key to use for your SFTP-enabled server. // You can add multiple host keys, in case you want to rotate keys, or have // a set of active keys that use different algorithms. // // Use the following command to generate an RSA 2048 bit key with no passphrase: // // ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key. // // Use a minimum value of 2048 for the -b option. You can create a stronger // key by using 3072 or 4096. // // Use the following command to generate an ECDSA 256 bit key with no passphrase: // // ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key. // // Valid values for the -b option for ECDSA are 256, 384, and 521. // // Use the following command to generate an ED25519 key with no passphrase: // // ssh-keygen -t ed25519 -N "" -f my-new-server-key. // // For all of these commands, you can replace my-new-server-key with a string // of your choice. // // 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 Manage host keys for your SFTP-enabled server (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key) // in the 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, Amazon // Web Services_LAMBDA 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"` // The mode of authentication for a server. The default value is SERVICE_MANAGED, // which allows you to store and access user credentials within the Transfer // Family service. // // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in // Directory Service for Microsoft Active Directory or Microsoft Active Directory // in your on-premises environment or in Amazon Web Services using AD Connector. // This option also requires you to provide a Directory ID by 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 Amazon API Gateway // endpoint URL to call for authentication by using the IdentityProviderDetails // parameter. // // Use the AWS_LAMBDA value to directly use an Lambda function as your identity // provider. If you choose this value, you must specify the ARN for the Lambda // function in the Function parameter for the IdentityProviderDetails data type. IdentityProviderType *string `type:"string" enum:"IdentityProviderType"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that allows a server to turn on Amazon CloudWatch logging for Amazon // S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch // logs. LoggingRole *string `type:"string"` // Specifies a string to display when users connect to a server. This string // is displayed after the user authenticates. // // The SFTP protocol does not support post-authentication display banners. PostAuthenticationLoginBanner *string `type:"string"` // Specifies a string to display when users connect to a server. This string // is displayed before the user authenticates. For example, the following banner // displays details about using the system: // // This system is for the use of authorized users only. Individuals using this // computer system without authority, or in excess of their authority, are subject // to having all of their activities on this system monitored and recorded by // system personnel. PreAuthenticationLoginBanner *string `type:"string"` // The protocol settings that are configured for your server. // // * To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp // parameter. Enter a single dotted-quad IPv4 address, such as the external // IP address of a firewall, router, or load balancer. // // * To ignore the error that is generated when the client attempts to use // the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, // use the SetStatOption parameter. To have the Transfer Family server ignore // the SETSTAT command and upload files without needing to make any changes // to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption // parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon // CloudWatch Logs, so that you can determine when the client is making a // SETSTAT call. // // * To determine whether your Transfer Family server resumes recent, negotiated // sessions through a unique session ID, use the TlsSessionResumptionMode // parameter. // // * As2Transports indicates the transport method for the AS2 messages. Currently, // only HTTP is supported. 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 // // * AS2 (Applicability Statement 2): used for transporting structured business-to-business // data // // * If you select FTPS, you must choose a certificate stored in 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 either AWS_DIRECTORY_SERVICE, // AWS_LAMBDA, 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 any of the supported identity // types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. // // * If Protocol includes AS2, then the EndpointType must be VPC, and domain // must be Amazon S3. Protocols []*string `min:"1" type:"list" enum:"Protocol"` // Specifies whether or not performance for your Amazon S3 directories is optimized. // This is disabled by default. // // By default, home directory mappings have a TYPE of DIRECTORY. If you enable // this option, you would then need to explicitly set the HomeDirectoryMapEntry // Type to FILE if you want a mapping to have a file target. S3StorageOptions *S3StorageOptions `type:"structure"` // Specifies the name of the security policy for the server. SecurityPolicyName *string `type:"string"` // Specifies the log groups to which your server logs are sent. // // To specify a log group, you must provide the ARN for an existing log group. // In this case, the format of the log group is as follows: // // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* // // For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* // // If you have previously specified a log group for a server, you can clear // it, and in effect turn off structured logging, by providing an empty value // for this parameter in an update-server call. For example: // // update-server --server-id s-1234567890abcdef0 --structured-log-destinations StructuredLogDestinations []*string `type:"list"` // 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 // that's used for executing the workflow. // // In addition to a workflow to execute when a file is uploaded completely, // WorkflowDetails can also contain a workflow ID (and execution role) for a // workflow to execute on partial upload. A partial upload occurs when the server // session disconnects while the file is still being uploaded. WorkflowDetails *WorkflowDetails `type:"structure"` // contains filtered or unexported fields }
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 (s *CreateServerInput) SetCertificate(v string) *CreateServerInput
SetCertificate sets the Certificate field's value.
func (s *CreateServerInput) SetDomain(v string) *CreateServerInput
SetDomain sets the Domain field's value.
func (s *CreateServerInput) SetEndpointDetails(v *EndpointDetails) *CreateServerInput
SetEndpointDetails sets the EndpointDetails field's value.
func (s *CreateServerInput) SetEndpointType(v string) *CreateServerInput
SetEndpointType sets the EndpointType field's value.
func (s *CreateServerInput) SetHostKey(v string) *CreateServerInput
SetHostKey sets the HostKey field's value.
func (s *CreateServerInput) SetIdentityProviderDetails(v *IdentityProviderDetails) *CreateServerInput
SetIdentityProviderDetails sets the IdentityProviderDetails field's value.
func (s *CreateServerInput) SetIdentityProviderType(v string) *CreateServerInput
SetIdentityProviderType sets the IdentityProviderType field's value.
func (s *CreateServerInput) SetLoggingRole(v string) *CreateServerInput
SetLoggingRole sets the LoggingRole field's value.
func (s *CreateServerInput) SetPostAuthenticationLoginBanner(v string) *CreateServerInput
SetPostAuthenticationLoginBanner sets the PostAuthenticationLoginBanner field's value.
func (s *CreateServerInput) SetPreAuthenticationLoginBanner(v string) *CreateServerInput
SetPreAuthenticationLoginBanner sets the PreAuthenticationLoginBanner field's value.
func (s *CreateServerInput) SetProtocolDetails(v *ProtocolDetails) *CreateServerInput
SetProtocolDetails sets the ProtocolDetails field's value.
func (s *CreateServerInput) SetProtocols(v []*string) *CreateServerInput
SetProtocols sets the Protocols field's value.
func (s *CreateServerInput) SetS3StorageOptions(v *S3StorageOptions) *CreateServerInput
SetS3StorageOptions sets the S3StorageOptions field's value.
func (s *CreateServerInput) SetSecurityPolicyName(v string) *CreateServerInput
SetSecurityPolicyName sets the SecurityPolicyName field's value.
func (s *CreateServerInput) SetStructuredLogDestinations(v []*string) *CreateServerInput
SetStructuredLogDestinations sets the StructuredLogDestinations field's value.
func (s *CreateServerInput) SetTags(v []*Tag) *CreateServerInput
SetTags sets the Tags field's value.
func (s *CreateServerInput) SetWorkflowDetails(v *WorkflowDetails) *CreateServerInput
SetWorkflowDetails sets the WorkflowDetails field's value.
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 (s *CreateServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateServerOutput struct { // The service-assigned identifier 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 (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 (s *CreateServerOutput) SetServerId(v string) *CreateServerOutput
SetServerId sets the ServerId field's value.
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 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. // // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. 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 Identity and Access Management (IAM) role provides access to paths in // Target. This value can be set only 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 value the user should see for their // home directory when they log in. // // The following is an Entry and Target pair example for chroot. // // [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ] HomeDirectoryMappings []*HomeDirectoryMapEntry `min:"1" type:"list"` // The type of landing directory (folder) that you want your users' home directory // to be when they log in to the server. If you set it to PATH, the user will // see the absolute Amazon S3 bucket or Amazon EFS path as is in their file // transfer protocol clients. If you set it to LOGICAL, you need to provide // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 // or Amazon EFS paths visible to your users. // // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide // an absolute path using the HomeDirectory parameter. You cannot have both // HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"` // A session policy for your user so that you can use the same Identity and // Access Management (IAM) role across multiple users. This policy scopes down // a user's 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 policy applies only when the domain of ServerId is Amazon S3. Amazon // EFS does not use session policies. // // For session policies, 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"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that controls your users' access to your Amazon S3 bucket or Amazon // 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 Amazon 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. // // The three standard SSH public key format elements are <key type>, <body base64>, // and an optional <comment>, with spaces between each element. // // Transfer Family accepts RSA, ECDSA, and ED25519 keys. // // * For RSA keys, the key type is ssh-rsa. // // * For ED25519 keys, the key type is ssh-ed25519. // // * For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, // or ecdsa-sha2-nistp521, depending on the size of the key you generated. 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 (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 (s *CreateUserInput) SetHomeDirectory(v string) *CreateUserInput
SetHomeDirectory sets the HomeDirectory field's value.
func (s *CreateUserInput) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *CreateUserInput
SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.
func (s *CreateUserInput) SetHomeDirectoryType(v string) *CreateUserInput
SetHomeDirectoryType sets the HomeDirectoryType field's value.
func (s *CreateUserInput) SetPolicy(v string) *CreateUserInput
SetPolicy sets the Policy field's value.
func (s *CreateUserInput) SetPosixProfile(v *PosixProfile) *CreateUserInput
SetPosixProfile sets the PosixProfile field's value.
func (s *CreateUserInput) SetRole(v string) *CreateUserInput
SetRole sets the Role field's value.
func (s *CreateUserInput) SetServerId(v string) *CreateUserInput
SetServerId sets the ServerId field's value.
func (s *CreateUserInput) SetSshPublicKeyBody(v string) *CreateUserInput
SetSshPublicKeyBody sets the SshPublicKeyBody field's value.
func (s *CreateUserInput) SetTags(v []*Tag) *CreateUserInput
SetTags sets the Tags field's value.
func (s *CreateUserInput) SetUserName(v string) *CreateUserInput
SetUserName sets the UserName field's value.
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 (s *CreateUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUserOutput struct { // The identifier 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 Transfer Family user. // // UserName is a required field UserName *string `min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
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 (s *CreateUserOutput) SetServerId(v string) *CreateUserOutput
SetServerId sets the ServerId field's value.
func (s *CreateUserOutput) SetUserName(v string) *CreateUserOutput
SetUserName sets the UserName field's value.
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 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 - Perform a custom step with an Lambda function target. // // * DECRYPT - Decrypt a file that was encrypted before it was uploaded. // // * 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 Amazon S3 bucket and key, or the // Amazon EFS file system 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 (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 (s *CreateWorkflowInput) SetDescription(v string) *CreateWorkflowInput
SetDescription sets the Description field's value.
func (s *CreateWorkflowInput) SetOnExceptionSteps(v []*WorkflowStep) *CreateWorkflowInput
SetOnExceptionSteps sets the OnExceptionSteps field's value.
func (s *CreateWorkflowInput) SetSteps(v []*WorkflowStep) *CreateWorkflowInput
SetSteps sets the Steps field's value.
func (s *CreateWorkflowInput) SetTags(v []*Tag) *CreateWorkflowInput
SetTags sets the Tags field's value.
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 (s *CreateWorkflowInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateWorkflowOutput) SetWorkflowId(v string) *CreateWorkflowOutput
SetWorkflowId sets the WorkflowId field's value.
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 struct { // The name of the step, used as an identifier. Name *string `type:"string"` // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. // // * To use the previous file as the input, enter ${previous.file}. In this // case, this workflow step uses the output file from the previous workflow // step as input. This is the default value. // // * To use the originally uploaded file location as input for this step, // enter ${original.file}. SourceFileLocation *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 (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 (s *CustomStepDetails) SetName(v string) *CustomStepDetails
SetName sets the Name field's value.
func (s *CustomStepDetails) SetSourceFileLocation(v string) *CustomStepDetails
SetSourceFileLocation sets the SourceFileLocation field's value.
func (s *CustomStepDetails) SetTarget(v string) *CustomStepDetails
SetTarget sets the Target field's value.
func (s *CustomStepDetails) SetTimeoutSeconds(v int64) *CustomStepDetails
SetTimeoutSeconds sets the TimeoutSeconds field's value.
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 (s *CustomStepDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DecryptStepDetails struct { // Specifies the location for the file being decrypted. Use ${Transfer:UserName} // or ${Transfer:UploadDate} in this field to parametrize the destination prefix // by username or uploaded date. // // * Set the value of DestinationFileLocation to ${Transfer:UserName} to // decrypt uploaded files to an Amazon S3 bucket that is prefixed with the // name of the Transfer Family user that uploaded the file. // // * Set the value of DestinationFileLocation to ${Transfer:UploadDate} to // decrypt uploaded files to an Amazon S3 bucket that is prefixed with the // date of the upload. The system resolves UploadDate to a date format of // YYYY-MM-DD, based on the date the file is uploaded in UTC. // // DestinationFileLocation is a required field DestinationFileLocation *InputFileLocation `type:"structure" required:"true"` // The name of the step, used as an identifier. Name *string `type:"string"` // A flag that indicates whether to overwrite an existing file of the same name. // The default is FALSE. // // If the workflow is processing a file that has the same name as an existing // file, the behavior is as follows: // // * If OverwriteExisting is TRUE, the existing file is replaced with the // file being processed. // // * If OverwriteExisting is FALSE, nothing happens, and the workflow processing // stops. OverwriteExisting *string `type:"string" enum:"OverwriteExisting"` // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. // // * To use the previous file as the input, enter ${previous.file}. In this // case, this workflow step uses the output file from the previous workflow // step as input. This is the default value. // // * To use the originally uploaded file location as input for this step, // enter ${original.file}. SourceFileLocation *string `type:"string"` // The type of encryption used. Currently, this value must be PGP. // // Type is a required field Type *string `type:"string" required:"true" enum:"EncryptionType"` // contains filtered or unexported fields }
Each step type has its own StepDetails structure.
func (s DecryptStepDetails) 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 (s *DecryptStepDetails) SetDestinationFileLocation(v *InputFileLocation) *DecryptStepDetails
SetDestinationFileLocation sets the DestinationFileLocation field's value.
func (s *DecryptStepDetails) SetName(v string) *DecryptStepDetails
SetName sets the Name field's value.
func (s *DecryptStepDetails) SetOverwriteExisting(v string) *DecryptStepDetails
SetOverwriteExisting sets the OverwriteExisting field's value.
func (s *DecryptStepDetails) SetSourceFileLocation(v string) *DecryptStepDetails
SetSourceFileLocation sets the SourceFileLocation field's value.
func (s *DecryptStepDetails) SetType(v string) *DecryptStepDetails
SetType sets the Type field's value.
func (s DecryptStepDetails) 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 (s *DecryptStepDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 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 regular expression 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 (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 (s *DeleteAccessInput) SetExternalId(v string) *DeleteAccessInput
SetExternalId sets the ExternalId field's value.
func (s *DeleteAccessInput) SetServerId(v string) *DeleteAccessInput
SetServerId sets the ServerId field's value.
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 (s *DeleteAccessInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAccessOutput struct {
// contains filtered or unexported fields
}
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 (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 DeleteAgreementInput struct { // A unique identifier for the agreement. This identifier is returned when you // create an agreement. // // AgreementId is a required field AgreementId *string `min:"19" type:"string" required:"true"` // The server identifier associated with the agreement that you are deleting. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteAgreementInput) 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 (s *DeleteAgreementInput) SetAgreementId(v string) *DeleteAgreementInput
SetAgreementId sets the AgreementId field's value.
func (s *DeleteAgreementInput) SetServerId(v string) *DeleteAgreementInput
SetServerId sets the ServerId field's value.
func (s DeleteAgreementInput) 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 (s *DeleteAgreementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAgreementOutput struct {
// contains filtered or unexported fields
}
func (s DeleteAgreementOutput) 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 (s DeleteAgreementOutput) 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 DeleteCertificateInput struct { // The identifier of the certificate object that you are deleting. // // CertificateId is a required field CertificateId *string `min:"22" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteCertificateInput) 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 (s *DeleteCertificateInput) SetCertificateId(v string) *DeleteCertificateInput
SetCertificateId sets the CertificateId field's value.
func (s DeleteCertificateInput) 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 (s *DeleteCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteCertificateOutput struct {
// contains filtered or unexported fields
}
func (s DeleteCertificateOutput) 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 (s DeleteCertificateOutput) 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 DeleteConnectorInput struct { // The unique identifier for the connector. // // ConnectorId is a required field ConnectorId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteConnectorInput) 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 (s *DeleteConnectorInput) SetConnectorId(v string) *DeleteConnectorInput
SetConnectorId sets the ConnectorId field's value.
func (s DeleteConnectorInput) 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 (s *DeleteConnectorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteConnectorOutput struct {
// contains filtered or unexported fields
}
func (s DeleteConnectorOutput) 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 (s DeleteConnectorOutput) 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 DeleteHostKeyInput struct { // The identifier of the host key that you are deleting. // // HostKeyId is a required field HostKeyId *string `min:"25" type:"string" required:"true"` // The identifier of the server that contains the host key that you are deleting. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteHostKeyInput) 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 (s *DeleteHostKeyInput) SetHostKeyId(v string) *DeleteHostKeyInput
SetHostKeyId sets the HostKeyId field's value.
func (s *DeleteHostKeyInput) SetServerId(v string) *DeleteHostKeyInput
SetServerId sets the ServerId field's value.
func (s DeleteHostKeyInput) 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 (s *DeleteHostKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteHostKeyOutput struct {
// contains filtered or unexported fields
}
func (s DeleteHostKeyOutput) 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 (s DeleteHostKeyOutput) 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 DeleteProfileInput struct { // The identifier of the profile that you are deleting. // // ProfileId is a required field ProfileId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteProfileInput) 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 (s *DeleteProfileInput) SetProfileId(v string) *DeleteProfileInput
SetProfileId sets the ProfileId field's value.
func (s DeleteProfileInput) 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 (s *DeleteProfileInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteProfileOutput struct {
// contains filtered or unexported fields
}
func (s DeleteProfileOutput) 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 (s DeleteProfileOutput) 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 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 (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 (s *DeleteServerInput) SetServerId(v string) *DeleteServerInput
SetServerId sets the ServerId field's value.
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 (s *DeleteServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteServerOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *DeleteSshPublicKeyInput) SetServerId(v string) *DeleteSshPublicKeyInput
SetServerId sets the ServerId field's value.
func (s *DeleteSshPublicKeyInput) SetSshPublicKeyId(v string) *DeleteSshPublicKeyInput
SetSshPublicKeyId sets the SshPublicKeyId field's value.
func (s *DeleteSshPublicKeyInput) SetUserName(v string) *DeleteSshPublicKeyInput
SetUserName sets the UserName field's value.
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 (s *DeleteSshPublicKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteSshPublicKeyOutput struct {
// contains filtered or unexported fields
}
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 (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 struct { // The name of the step, used as an identifier. Name *string `type:"string"` // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. // // * To use the previous file as the input, enter ${previous.file}. In this // case, this workflow step uses the output file from the previous workflow // step as input. This is the default value. // // * To use the originally uploaded file location as input for this step, // enter ${original.file}. SourceFileLocation *string `type:"string"` // contains filtered or unexported fields }
The name of the step, used to identify the delete step.
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 (s *DeleteStepDetails) SetName(v string) *DeleteStepDetails
SetName sets the Name field's value.
func (s *DeleteStepDetails) SetSourceFileLocation(v string) *DeleteStepDetails
SetSourceFileLocation sets the SourceFileLocation field's value.
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 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 (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 (s *DeleteUserInput) SetServerId(v string) *DeleteUserInput
SetServerId sets the ServerId field's value.
func (s *DeleteUserInput) SetUserName(v string) *DeleteUserInput
SetUserName sets the UserName field's value.
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 (s *DeleteUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *DeleteWorkflowInput) SetWorkflowId(v string) *DeleteWorkflowInput
SetWorkflowId sets the WorkflowId field's value.
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 (s *DeleteWorkflowInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteWorkflowOutput struct {
// contains filtered or unexported fields
}
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 (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 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 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 regular expression 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 (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 (s *DescribeAccessInput) SetExternalId(v string) *DescribeAccessInput
SetExternalId sets the ExternalId field's value.
func (s *DescribeAccessInput) SetServerId(v string) *DescribeAccessInput
SetServerId sets the ServerId field's value.
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 (s *DescribeAccessInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAccessOutput struct { // The external identifier 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 (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 (s *DescribeAccessOutput) SetAccess(v *DescribedAccess) *DescribeAccessOutput
SetAccess sets the Access field's value.
func (s *DescribeAccessOutput) SetServerId(v string) *DescribeAccessOutput
SetServerId sets the ServerId field's value.
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 DescribeAgreementInput struct { // A unique identifier for the agreement. This identifier is returned when you // create an agreement. // // AgreementId is a required field AgreementId *string `min:"19" type:"string" required:"true"` // The server identifier that's associated with the agreement. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeAgreementInput) 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 (s *DescribeAgreementInput) SetAgreementId(v string) *DescribeAgreementInput
SetAgreementId sets the AgreementId field's value.
func (s *DescribeAgreementInput) SetServerId(v string) *DescribeAgreementInput
SetServerId sets the ServerId field's value.
func (s DescribeAgreementInput) 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 (s *DescribeAgreementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAgreementOutput struct { // The details for the specified agreement, returned as a DescribedAgreement // object. // // Agreement is a required field Agreement *DescribedAgreement `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeAgreementOutput) 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 (s *DescribeAgreementOutput) SetAgreement(v *DescribedAgreement) *DescribeAgreementOutput
SetAgreement sets the Agreement field's value.
func (s DescribeAgreementOutput) 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 DescribeCertificateInput struct { // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. // // CertificateId is a required field CertificateId *string `min:"22" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeCertificateInput) 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 (s *DescribeCertificateInput) SetCertificateId(v string) *DescribeCertificateInput
SetCertificateId sets the CertificateId field's value.
func (s DescribeCertificateInput) 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 (s *DescribeCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeCertificateOutput struct { // The details for the specified certificate, returned as an object. // // Certificate is a required field Certificate *DescribedCertificate `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeCertificateOutput) 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 (s *DescribeCertificateOutput) SetCertificate(v *DescribedCertificate) *DescribeCertificateOutput
SetCertificate sets the Certificate field's value.
func (s DescribeCertificateOutput) 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 DescribeConnectorInput struct { // The unique identifier for the connector. // // ConnectorId is a required field ConnectorId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeConnectorInput) 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 (s *DescribeConnectorInput) SetConnectorId(v string) *DescribeConnectorInput
SetConnectorId sets the ConnectorId field's value.
func (s DescribeConnectorInput) 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 (s *DescribeConnectorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeConnectorOutput struct { // The structure that contains the details of the connector. // // Connector is a required field Connector *DescribedConnector `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeConnectorOutput) 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 (s *DescribeConnectorOutput) SetConnector(v *DescribedConnector) *DescribeConnectorOutput
SetConnector sets the Connector field's value.
func (s DescribeConnectorOutput) 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 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 (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 (s *DescribeExecutionInput) SetExecutionId(v string) *DescribeExecutionInput
SetExecutionId sets the ExecutionId field's value.
func (s *DescribeExecutionInput) SetWorkflowId(v string) *DescribeExecutionInput
SetWorkflowId sets the WorkflowId field's value.
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 (s *DescribeExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeExecutionOutput) SetExecution(v *DescribedExecution) *DescribeExecutionOutput
SetExecution sets the Execution field's value.
func (s *DescribeExecutionOutput) SetWorkflowId(v string) *DescribeExecutionOutput
SetWorkflowId sets the WorkflowId field's value.
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 DescribeHostKeyInput struct { // The identifier of the host key that you want described. // // HostKeyId is a required field HostKeyId *string `min:"25" type:"string" required:"true"` // The identifier of the server that contains the host key that you want described. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeHostKeyInput) 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 (s *DescribeHostKeyInput) SetHostKeyId(v string) *DescribeHostKeyInput
SetHostKeyId sets the HostKeyId field's value.
func (s *DescribeHostKeyInput) SetServerId(v string) *DescribeHostKeyInput
SetServerId sets the ServerId field's value.
func (s DescribeHostKeyInput) 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 (s *DescribeHostKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeHostKeyOutput struct { // Returns the details for the specified host key. // // HostKey is a required field HostKey *DescribedHostKey `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeHostKeyOutput) 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 (s *DescribeHostKeyOutput) SetHostKey(v *DescribedHostKey) *DescribeHostKeyOutput
SetHostKey sets the HostKey field's value.
func (s DescribeHostKeyOutput) 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 DescribeProfileInput struct { // The identifier of the profile that you want described. // // ProfileId is a required field ProfileId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeProfileInput) 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 (s *DescribeProfileInput) SetProfileId(v string) *DescribeProfileInput
SetProfileId sets the ProfileId field's value.
func (s DescribeProfileInput) 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 (s *DescribeProfileInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeProfileOutput struct { // The details of the specified profile, returned as an object. // // Profile is a required field Profile *DescribedProfile `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeProfileOutput) 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 (s *DescribeProfileOutput) SetProfile(v *DescribedProfile) *DescribeProfileOutput
SetProfile sets the Profile field's value.
func (s DescribeProfileOutput) 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 struct { // Specify the text name of the security policy for which you want the details. // // SecurityPolicyName is a required field SecurityPolicyName *string `type:"string" required:"true"` // contains filtered or unexported fields }
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 (s *DescribeSecurityPolicyInput) SetSecurityPolicyName(v string) *DescribeSecurityPolicyInput
SetSecurityPolicyName sets the SecurityPolicyName field's value.
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 (s *DescribeSecurityPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeSecurityPolicyOutput) SetSecurityPolicy(v *DescribedSecurityPolicy) *DescribeSecurityPolicyOutput
SetSecurityPolicy sets the SecurityPolicy field's value.
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 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 (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 (s *DescribeServerInput) SetServerId(v string) *DescribeServerInput
SetServerId sets the ServerId field's value.
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 (s *DescribeServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeServerOutput) SetServer(v *DescribedServer) *DescribeServerOutput
SetServer sets the Server field's value.
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 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 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 (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 (s *DescribeUserInput) SetServerId(v string) *DescribeUserInput
SetServerId sets the ServerId field's value.
func (s *DescribeUserInput) SetUserName(v string) *DescribeUserInput
SetUserName sets the UserName field's value.
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 (s *DescribeUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 Transfer Family user for the ServerID // value that you specified. // // User is a required field User *DescribedUser `type:"structure" required:"true"` // contains filtered or unexported fields }
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 (s *DescribeUserOutput) SetServerId(v string) *DescribeUserOutput
SetServerId sets the ServerId field's value.
func (s *DescribeUserOutput) SetUser(v *DescribedUser) *DescribeUserOutput
SetUser sets the User field's value.
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 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 (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 (s *DescribeWorkflowInput) SetWorkflowId(v string) *DescribeWorkflowInput
SetWorkflowId sets the WorkflowId field's value.
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 (s *DescribeWorkflowInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeWorkflowOutput) SetWorkflow(v *DescribedWorkflow) *DescribeWorkflowOutput
SetWorkflow sets the Workflow field's value.
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 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 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 regular expression 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. // // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. 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 Identity and Access Management (IAM) role provides access to paths in // Target. This value can be set only 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) that you want your users' home directory // to be when they log in to the server. If you set it to PATH, the user will // see the absolute Amazon S3 bucket or Amazon EFS path as is in their file // transfer protocol clients. If you set it to LOGICAL, you need to provide // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 // or Amazon EFS paths visible to your users. // // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide // an absolute path using the HomeDirectory parameter. You cannot have both // HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"` // A session policy for your user so that you can use the same Identity and // Access Management (IAM) role across multiple users. This policy scopes down // a user's 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"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that controls your users' access to your Amazon S3 bucket or Amazon // 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 Amazon 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 (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 (s *DescribedAccess) SetExternalId(v string) *DescribedAccess
SetExternalId sets the ExternalId field's value.
func (s *DescribedAccess) SetHomeDirectory(v string) *DescribedAccess
SetHomeDirectory sets the HomeDirectory field's value.
func (s *DescribedAccess) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *DescribedAccess
SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.
func (s *DescribedAccess) SetHomeDirectoryType(v string) *DescribedAccess
SetHomeDirectoryType sets the HomeDirectoryType field's value.
func (s *DescribedAccess) SetPolicy(v string) *DescribedAccess
SetPolicy sets the Policy field's value.
func (s *DescribedAccess) SetPosixProfile(v *PosixProfile) *DescribedAccess
SetPosixProfile sets the PosixProfile field's value.
func (s *DescribedAccess) SetRole(v string) *DescribedAccess
SetRole sets the Role field's value.
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 DescribedAgreement struct { // Connectors are used to send files using either the AS2 or SFTP protocol. // For the access role, provide the Amazon Resource Name (ARN) of the Identity // and Access Management role to use. // // For AS2 connectors // // With AS2, you can send files by calling StartFileTransfer and specifying // the file paths in the request parameter, SendFilePaths. We use the file’s // parent directory (for example, for --send-file-paths /bucket/dir/file.txt, // parent directory is /bucket/dir/) to temporarily store a processed AS2 message // file, store the MDN when we receive them from the partner, and write a final // JSON file containing relevant metadata of the transmission. So, the AccessRole // needs to provide read and write access to the parent directory of the file // location used in the StartFileTransfer request. Additionally, you need to // provide read and write access to the parent directory of the files that you // intend to send with StartFileTransfer. // // If you are using Basic authentication for your AS2 connector, the access // role requires the secretsmanager:GetSecretValue permission for the secret. // If the secret is encrypted using a customer-managed key instead of the Amazon // Web Services managed key in Secrets Manager, then the role also needs the // kms:Decrypt permission for that key. // // For SFTP connectors // // Make sure that the access role provides read and write access to the parent // directory of the file location that's used in the StartFileTransfer request. // Additionally, make sure that the role provides secretsmanager:GetSecretValue // permission to Secrets Manager. AccessRole *string `min:"20" type:"string"` // A unique identifier for the agreement. This identifier is returned when you // create an agreement. AgreementId *string `min:"19" type:"string"` // The unique Amazon Resource Name (ARN) for the agreement. // // Arn is a required field Arn *string `min:"20" type:"string" required:"true"` // The landing directory (folder) for files that are transferred by using the // AS2 protocol. BaseDirectory *string `type:"string"` // The name or short description that's used to identify the agreement. Description *string `min:"1" type:"string"` // A unique identifier for the AS2 local profile. LocalProfileId *string `min:"19" type:"string"` // A unique identifier for the partner profile used in the agreement. PartnerProfileId *string `min:"19" type:"string"` // A system-assigned unique identifier for a server instance. This identifier // indicates the specific server that the agreement uses. ServerId *string `min:"19" type:"string"` // The current status of the agreement, either ACTIVE or INACTIVE. Status *string `type:"string" enum:"AgreementStatusType"` // Key-value pairs that can be used to group and search for agreements. Tags []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
Describes the properties of an agreement.
func (s DescribedAgreement) 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 (s *DescribedAgreement) SetAccessRole(v string) *DescribedAgreement
SetAccessRole sets the AccessRole field's value.
func (s *DescribedAgreement) SetAgreementId(v string) *DescribedAgreement
SetAgreementId sets the AgreementId field's value.
func (s *DescribedAgreement) SetArn(v string) *DescribedAgreement
SetArn sets the Arn field's value.
func (s *DescribedAgreement) SetBaseDirectory(v string) *DescribedAgreement
SetBaseDirectory sets the BaseDirectory field's value.
func (s *DescribedAgreement) SetDescription(v string) *DescribedAgreement
SetDescription sets the Description field's value.
func (s *DescribedAgreement) SetLocalProfileId(v string) *DescribedAgreement
SetLocalProfileId sets the LocalProfileId field's value.
func (s *DescribedAgreement) SetPartnerProfileId(v string) *DescribedAgreement
SetPartnerProfileId sets the PartnerProfileId field's value.
func (s *DescribedAgreement) SetServerId(v string) *DescribedAgreement
SetServerId sets the ServerId field's value.
func (s *DescribedAgreement) SetStatus(v string) *DescribedAgreement
SetStatus sets the Status field's value.
func (s *DescribedAgreement) SetTags(v []*Tag) *DescribedAgreement
SetTags sets the Tags field's value.
func (s DescribedAgreement) 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 DescribedCertificate struct { // An optional date that specifies when the certificate becomes active. ActiveDate *time.Time `type:"timestamp"` // The unique Amazon Resource Name (ARN) for the certificate. // // Arn is a required field Arn *string `min:"20" type:"string" required:"true"` // The file name for the certificate. // // Certificate is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DescribedCertificate's // String and GoString methods. Certificate *string `min:"1" type:"string" sensitive:"true"` // The list of certificates that make up the chain for the certificate. // // CertificateChain is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DescribedCertificate's // String and GoString methods. CertificateChain *string `min:"1" type:"string" sensitive:"true"` // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. CertificateId *string `min:"22" type:"string"` // The name or description that's used to identity the certificate. Description *string `min:"1" type:"string"` // An optional date that specifies when the certificate becomes inactive. InactiveDate *time.Time `type:"timestamp"` // The final date that the certificate is valid. NotAfterDate *time.Time `type:"timestamp"` // The earliest date that the certificate is valid. NotBeforeDate *time.Time `type:"timestamp"` // The serial number for the certificate. Serial *string `type:"string"` // The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION // means that this certificate will replace the current certificate when it // expires. Status *string `type:"string" enum:"CertificateStatusType"` // Key-value pairs that can be used to group and search for certificates. Tags []*Tag `min:"1" type:"list"` // If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. // If there is no private key, the type is CERTIFICATE. Type *string `type:"string" enum:"CertificateType"` // Specifies how this certificate is used. It can be used in the following ways: // // * SIGNING: For signing AS2 messages // // * ENCRYPTION: For encrypting AS2 messages // // * TLS: For securing AS2 communications sent over HTTPS Usage *string `type:"string" enum:"CertificateUsageType"` // contains filtered or unexported fields }
Describes the properties of a certificate.
func (s DescribedCertificate) 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 (s *DescribedCertificate) SetActiveDate(v time.Time) *DescribedCertificate
SetActiveDate sets the ActiveDate field's value.
func (s *DescribedCertificate) SetArn(v string) *DescribedCertificate
SetArn sets the Arn field's value.
func (s *DescribedCertificate) SetCertificate(v string) *DescribedCertificate
SetCertificate sets the Certificate field's value.
func (s *DescribedCertificate) SetCertificateChain(v string) *DescribedCertificate
SetCertificateChain sets the CertificateChain field's value.
func (s *DescribedCertificate) SetCertificateId(v string) *DescribedCertificate
SetCertificateId sets the CertificateId field's value.
func (s *DescribedCertificate) SetDescription(v string) *DescribedCertificate
SetDescription sets the Description field's value.
func (s *DescribedCertificate) SetInactiveDate(v time.Time) *DescribedCertificate
SetInactiveDate sets the InactiveDate field's value.
func (s *DescribedCertificate) SetNotAfterDate(v time.Time) *DescribedCertificate
SetNotAfterDate sets the NotAfterDate field's value.
func (s *DescribedCertificate) SetNotBeforeDate(v time.Time) *DescribedCertificate
SetNotBeforeDate sets the NotBeforeDate field's value.
func (s *DescribedCertificate) SetSerial(v string) *DescribedCertificate
SetSerial sets the Serial field's value.
func (s *DescribedCertificate) SetStatus(v string) *DescribedCertificate
SetStatus sets the Status field's value.
func (s *DescribedCertificate) SetTags(v []*Tag) *DescribedCertificate
SetTags sets the Tags field's value.
func (s *DescribedCertificate) SetType(v string) *DescribedCertificate
SetType sets the Type field's value.
func (s *DescribedCertificate) SetUsage(v string) *DescribedCertificate
SetUsage sets the Usage field's value.
func (s DescribedCertificate) 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 DescribedConnector struct { // Connectors are used to send files using either the AS2 or SFTP protocol. // For the access role, provide the Amazon Resource Name (ARN) of the Identity // and Access Management role to use. // // For AS2 connectors // // With AS2, you can send files by calling StartFileTransfer and specifying // the file paths in the request parameter, SendFilePaths. We use the file’s // parent directory (for example, for --send-file-paths /bucket/dir/file.txt, // parent directory is /bucket/dir/) to temporarily store a processed AS2 message // file, store the MDN when we receive them from the partner, and write a final // JSON file containing relevant metadata of the transmission. So, the AccessRole // needs to provide read and write access to the parent directory of the file // location used in the StartFileTransfer request. Additionally, you need to // provide read and write access to the parent directory of the files that you // intend to send with StartFileTransfer. // // If you are using Basic authentication for your AS2 connector, the access // role requires the secretsmanager:GetSecretValue permission for the secret. // If the secret is encrypted using a customer-managed key instead of the Amazon // Web Services managed key in Secrets Manager, then the role also needs the // kms:Decrypt permission for that key. // // For SFTP connectors // // Make sure that the access role provides read and write access to the parent // directory of the file location that's used in the StartFileTransfer request. // Additionally, make sure that the role provides secretsmanager:GetSecretValue // permission to Secrets Manager. AccessRole *string `min:"20" type:"string"` // The unique Amazon Resource Name (ARN) for the connector. // // Arn is a required field Arn *string `min:"20" type:"string" required:"true"` // A structure that contains the parameters for an AS2 connector object. As2Config *As2ConnectorConfig `type:"structure"` // The unique identifier for the connector. ConnectorId *string `min:"19" type:"string"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that allows a connector to turn on CloudWatch logging for Amazon S3 // events. When set, you can view connector activity in your CloudWatch logs. LoggingRole *string `min:"20" type:"string"` // The text name of the security policy for the specified connector. SecurityPolicyName *string `type:"string"` // The list of egress IP addresses of this connector. These IP addresses are // assigned automatically when you create the connector. ServiceManagedEgressIpAddresses []*string `type:"list"` // A structure that contains the parameters for an SFTP connector object. SftpConfig *SftpConnectorConfig `type:"structure"` // Key-value pairs that can be used to group and search for connectors. Tags []*Tag `min:"1" type:"list"` // The URL of the partner's AS2 or SFTP endpoint. Url *string `type:"string"` // contains filtered or unexported fields }
Describes the parameters for the connector, as identified by the ConnectorId.
func (s DescribedConnector) 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 (s *DescribedConnector) SetAccessRole(v string) *DescribedConnector
SetAccessRole sets the AccessRole field's value.
func (s *DescribedConnector) SetArn(v string) *DescribedConnector
SetArn sets the Arn field's value.
func (s *DescribedConnector) SetAs2Config(v *As2ConnectorConfig) *DescribedConnector
SetAs2Config sets the As2Config field's value.
func (s *DescribedConnector) SetConnectorId(v string) *DescribedConnector
SetConnectorId sets the ConnectorId field's value.
func (s *DescribedConnector) SetLoggingRole(v string) *DescribedConnector
SetLoggingRole sets the LoggingRole field's value.
func (s *DescribedConnector) SetSecurityPolicyName(v string) *DescribedConnector
SetSecurityPolicyName sets the SecurityPolicyName field's value.
func (s *DescribedConnector) SetServiceManagedEgressIpAddresses(v []*string) *DescribedConnector
SetServiceManagedEgressIpAddresses sets the ServiceManagedEgressIpAddresses field's value.
func (s *DescribedConnector) SetSftpConfig(v *SftpConnectorConfig) *DescribedConnector
SetSftpConfig sets the SftpConfig field's value.
func (s *DescribedConnector) SetTags(v []*Tag) *DescribedConnector
SetTags sets the Tags field's value.
func (s *DescribedConnector) SetUrl(v string) *DescribedConnector
SetUrl sets the Url field's value.
func (s DescribedConnector) 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 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 that are 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 (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 (s *DescribedExecution) SetExecutionId(v string) *DescribedExecution
SetExecutionId sets the ExecutionId field's value.
func (s *DescribedExecution) SetExecutionRole(v string) *DescribedExecution
SetExecutionRole sets the ExecutionRole field's value.
func (s *DescribedExecution) SetInitialFileLocation(v *FileLocation) *DescribedExecution
SetInitialFileLocation sets the InitialFileLocation field's value.
func (s *DescribedExecution) SetLoggingConfiguration(v *LoggingConfiguration) *DescribedExecution
SetLoggingConfiguration sets the LoggingConfiguration field's value.
func (s *DescribedExecution) SetPosixProfile(v *PosixProfile) *DescribedExecution
SetPosixProfile sets the PosixProfile field's value.
func (s *DescribedExecution) SetResults(v *ExecutionResults) *DescribedExecution
SetResults sets the Results field's value.
func (s *DescribedExecution) SetServiceMetadata(v *ServiceMetadata) *DescribedExecution
SetServiceMetadata sets the ServiceMetadata field's value.
func (s *DescribedExecution) SetStatus(v string) *DescribedExecution
SetStatus sets the Status field's value.
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 DescribedHostKey struct { // The unique Amazon Resource Name (ARN) for the host key. // // Arn is a required field Arn *string `min:"20" type:"string" required:"true"` // The date on which the host key was added to the server. DateImported *time.Time `type:"timestamp"` // The text description for this host key. Description *string `type:"string"` // The public key fingerprint, which is a short sequence of bytes used to identify // the longer public key. HostKeyFingerprint *string `type:"string"` // A unique identifier for the host key. HostKeyId *string `min:"25" type:"string"` // Key-value pairs that can be used to group and search for host keys. Tags []*Tag `min:"1" type:"list"` // The encryption algorithm that is used for the host key. The Type parameter // is specified by using one of the following values: // // * ssh-rsa // // * ssh-ed25519 // // * ecdsa-sha2-nistp256 // // * ecdsa-sha2-nistp384 // // * ecdsa-sha2-nistp521 Type *string `type:"string"` // contains filtered or unexported fields }
The details for a server host key.
func (s DescribedHostKey) 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 (s *DescribedHostKey) SetArn(v string) *DescribedHostKey
SetArn sets the Arn field's value.
func (s *DescribedHostKey) SetDateImported(v time.Time) *DescribedHostKey
SetDateImported sets the DateImported field's value.
func (s *DescribedHostKey) SetDescription(v string) *DescribedHostKey
SetDescription sets the Description field's value.
func (s *DescribedHostKey) SetHostKeyFingerprint(v string) *DescribedHostKey
SetHostKeyFingerprint sets the HostKeyFingerprint field's value.
func (s *DescribedHostKey) SetHostKeyId(v string) *DescribedHostKey
SetHostKeyId sets the HostKeyId field's value.
func (s *DescribedHostKey) SetTags(v []*Tag) *DescribedHostKey
SetTags sets the Tags field's value.
func (s *DescribedHostKey) SetType(v string) *DescribedHostKey
SetType sets the Type field's value.
func (s DescribedHostKey) 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 DescribedProfile struct { // The unique Amazon Resource Name (ARN) for the profile. // // Arn is a required field Arn *string `min:"20" type:"string" required:"true"` // The As2Id is the AS2-name, as defined in the RFC 4130 (https://datatracker.ietf.org/doc/html/rfc4130). // For inbound transfers, this is the AS2-From header for the AS2 messages sent // from the partner. For outbound connectors, this is the AS2-To header for // the AS2 messages sent to the partner using the StartFileTransfer API operation. // This ID cannot include spaces. As2Id *string `min:"1" type:"string"` // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. CertificateIds []*string `type:"list"` // A unique identifier for the local or partner AS2 profile. ProfileId *string `min:"19" type:"string"` // Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. // If not supplied in the request, the command lists all types of profiles. ProfileType *string `type:"string" enum:"ProfileType"` // Key-value pairs that can be used to group and search for profiles. Tags []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
The details for a local or partner AS2 profile.
func (s DescribedProfile) 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 (s *DescribedProfile) SetArn(v string) *DescribedProfile
SetArn sets the Arn field's value.
func (s *DescribedProfile) SetAs2Id(v string) *DescribedProfile
SetAs2Id sets the As2Id field's value.
func (s *DescribedProfile) SetCertificateIds(v []*string) *DescribedProfile
SetCertificateIds sets the CertificateIds field's value.
func (s *DescribedProfile) SetProfileId(v string) *DescribedProfile
SetProfileId sets the ProfileId field's value.
func (s *DescribedProfile) SetProfileType(v string) *DescribedProfile
SetProfileType sets the ProfileType field's value.
func (s *DescribedProfile) SetTags(v []*Tag) *DescribedProfile
SetTags sets the Tags field's value.
func (s DescribedProfile) 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 struct { // Specifies whether this policy enables Federal Information Processing Standards // (FIPS). This parameter applies to both server and connector security policies. Fips *bool `type:"boolean"` // Lists the file transfer protocols that the security policy applies to. Protocols []*string `min:"1" type:"list" enum:"SecurityPolicyProtocol"` // The text name of the specified security policy. // // SecurityPolicyName is a required field SecurityPolicyName *string `type:"string" required:"true"` // Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the // security policy that is attached to the server or connector. This parameter // applies to both server and connector security policies. SshCiphers []*string `type:"list"` // Lists the host key algorithms for the security policy. // // This parameter only applies to security policies for connectors. SshHostKeyAlgorithms []*string `type:"list"` // Lists the enabled SSH key exchange (KEX) encryption algorithms in the security // policy that is attached to the server or connector. This parameter applies // to both server and connector security policies. SshKexs []*string `type:"list"` // Lists the enabled SSH message authentication code (MAC) encryption algorithms // in the security policy that is attached to the server or connector. This // parameter applies to both server and connector security policies. SshMacs []*string `type:"list"` // Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms // in the security policy that is attached to the server. // // This parameter only applies to security policies for servers. TlsCiphers []*string `type:"list"` // The resource type to which the security policy applies, either server or // connector. Type *string `type:"string" enum:"SecurityPolicyResourceType"` // contains filtered or unexported fields }
Describes the properties of a security policy that you specify. For more information about security policies, see Working with security policies for servers (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) or Working with security policies for SFTP connectors (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html).
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 (s *DescribedSecurityPolicy) SetFips(v bool) *DescribedSecurityPolicy
SetFips sets the Fips field's value.
func (s *DescribedSecurityPolicy) SetProtocols(v []*string) *DescribedSecurityPolicy
SetProtocols sets the Protocols field's value.
func (s *DescribedSecurityPolicy) SetSecurityPolicyName(v string) *DescribedSecurityPolicy
SetSecurityPolicyName sets the SecurityPolicyName field's value.
func (s *DescribedSecurityPolicy) SetSshCiphers(v []*string) *DescribedSecurityPolicy
SetSshCiphers sets the SshCiphers field's value.
func (s *DescribedSecurityPolicy) SetSshHostKeyAlgorithms(v []*string) *DescribedSecurityPolicy
SetSshHostKeyAlgorithms sets the SshHostKeyAlgorithms field's value.
func (s *DescribedSecurityPolicy) SetSshKexs(v []*string) *DescribedSecurityPolicy
SetSshKexs sets the SshKexs field's value.
func (s *DescribedSecurityPolicy) SetSshMacs(v []*string) *DescribedSecurityPolicy
SetSshMacs sets the SshMacs field's value.
func (s *DescribedSecurityPolicy) SetTlsCiphers(v []*string) *DescribedSecurityPolicy
SetTlsCiphers sets the TlsCiphers field's value.
func (s *DescribedSecurityPolicy) SetType(v string) *DescribedSecurityPolicy
SetType sets the Type field's value.
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 struct { // Specifies the unique Amazon Resource Name (ARN) of the server. // // Arn is a required field Arn *string `min:"20" type:"string" required:"true"` // The list of egress IP addresses of this server. These IP addresses are only // relevant for servers that use the AS2 protocol. They are used for sending // asynchronous MDNs. // // These IP addresses are assigned automatically when you create an AS2 server. // Additionally, if you update an existing server and add the AS2 protocol, // static IP addresses are assigned as well. As2ServiceManagedEgressIpAddresses []*string `type:"list"` // 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. // There are two domains available: Amazon Simple Storage Service (Amazon S3) // and Amazon Elastic File System (Amazon EFS). The default value is S3. 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 your // endpoint accessible only to resources within your VPC, or you can attach // Elastic IP addresses and make your endpoint 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"` // The mode of authentication for a server. The default value is SERVICE_MANAGED, // which allows you to store and access user credentials within the Transfer // Family service. // // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in // Directory Service for Microsoft Active Directory or Microsoft Active Directory // in your on-premises environment or in Amazon Web Services using AD Connector. // This option also requires you to provide a Directory ID by 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 Amazon API Gateway // endpoint URL to call for authentication by using the IdentityProviderDetails // parameter. // // Use the AWS_LAMBDA value to directly use an Lambda function as your identity // provider. If you choose this value, you must specify the ARN for the Lambda // function in the Function parameter for the IdentityProviderDetails data type. IdentityProviderType *string `type:"string" enum:"IdentityProviderType"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that allows a server to turn on Amazon CloudWatch logging for Amazon // S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch // logs. LoggingRole *string `type:"string"` // Specifies a string to display when users connect to a server. This string // is displayed after the user authenticates. // // The SFTP protocol does not support post-authentication display banners. PostAuthenticationLoginBanner *string `type:"string"` // Specifies a string to display when users connect to a server. This string // is displayed before the user authenticates. For example, the following banner // displays details about using the system: // // This system is for the use of authorized users only. Individuals using this // computer system without authority, or in excess of their authority, are subject // to having all of their activities on this system monitored and recorded by // system personnel. PreAuthenticationLoginBanner *string `type:"string"` // The protocol settings that are configured for your server. // // * To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp // parameter. Enter a single dotted-quad IPv4 address, such as the external // IP address of a firewall, router, or load balancer. // // * To ignore the error that is generated when the client attempts to use // the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, // use the SetStatOption parameter. To have the Transfer Family server ignore // the SETSTAT command and upload files without needing to make any changes // to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption // parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon // CloudWatch Logs, so that you can determine when the client is making a // SETSTAT call. // // * To determine whether your Transfer Family server resumes recent, negotiated // sessions through a unique session ID, use the TlsSessionResumptionMode // parameter. // // * As2Transports indicates the transport method for the AS2 messages. Currently, // only HTTP is supported. 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 // // * AS2 (Applicability Statement 2): used for transporting structured business-to-business // data // // * If you select FTPS, you must choose a certificate stored in 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 either AWS_DIRECTORY_SERVICE, // AWS_LAMBDA, 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 any of the supported identity // types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. // // * If Protocol includes AS2, then the EndpointType must be VPC, and domain // must be Amazon S3. Protocols []*string `min:"1" type:"list" enum:"Protocol"` // Specifies whether or not performance for your Amazon S3 directories is optimized. // This is disabled by default. // // By default, home directory mappings have a TYPE of DIRECTORY. If you enable // this option, you would then need to explicitly set the HomeDirectoryMapEntry // Type to FILE if you want a mapping to have a file target. S3StorageOptions *S3StorageOptions `type:"structure"` // Specifies the name of the security policy for the server. SecurityPolicyName *string `type:"string"` // Specifies the unique system-assigned identifier for a server that you instantiate. ServerId *string `min:"19" type:"string"` // The condition of 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 log groups to which your server logs are sent. // // To specify a log group, you must provide the ARN for an existing log group. // In this case, the format of the log group is as follows: // // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* // // For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* // // If you have previously specified a log group for a server, you can clear // it, and in effect turn off structured logging, by providing an empty value // for this parameter in an update-server call. For example: // // update-server --server-id s-1234567890abcdef0 --structured-log-destinations StructuredLogDestinations []*string `type:"list"` // 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 // that's used for executing the workflow. // // In addition to a workflow to execute when a file is uploaded completely, // WorkflowDetails can also contain a workflow ID (and execution role) for a // workflow to execute on partial upload. A partial upload occurs when the server // session disconnects while the file is still being uploaded. WorkflowDetails *WorkflowDetails `type:"structure"` // contains filtered or unexported fields }
Describes the properties of a file transfer protocol-enabled server that was specified.
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 (s *DescribedServer) SetArn(v string) *DescribedServer
SetArn sets the Arn field's value.
func (s *DescribedServer) SetAs2ServiceManagedEgressIpAddresses(v []*string) *DescribedServer
SetAs2ServiceManagedEgressIpAddresses sets the As2ServiceManagedEgressIpAddresses field's value.
func (s *DescribedServer) SetCertificate(v string) *DescribedServer
SetCertificate sets the Certificate field's value.
func (s *DescribedServer) SetDomain(v string) *DescribedServer
SetDomain sets the Domain field's value.
func (s *DescribedServer) SetEndpointDetails(v *EndpointDetails) *DescribedServer
SetEndpointDetails sets the EndpointDetails field's value.
func (s *DescribedServer) SetEndpointType(v string) *DescribedServer
SetEndpointType sets the EndpointType field's value.
func (s *DescribedServer) SetHostKeyFingerprint(v string) *DescribedServer
SetHostKeyFingerprint sets the HostKeyFingerprint field's value.
func (s *DescribedServer) SetIdentityProviderDetails(v *IdentityProviderDetails) *DescribedServer
SetIdentityProviderDetails sets the IdentityProviderDetails field's value.
func (s *DescribedServer) SetIdentityProviderType(v string) *DescribedServer
SetIdentityProviderType sets the IdentityProviderType field's value.
func (s *DescribedServer) SetLoggingRole(v string) *DescribedServer
SetLoggingRole sets the LoggingRole field's value.
func (s *DescribedServer) SetPostAuthenticationLoginBanner(v string) *DescribedServer
SetPostAuthenticationLoginBanner sets the PostAuthenticationLoginBanner field's value.
func (s *DescribedServer) SetPreAuthenticationLoginBanner(v string) *DescribedServer
SetPreAuthenticationLoginBanner sets the PreAuthenticationLoginBanner field's value.
func (s *DescribedServer) SetProtocolDetails(v *ProtocolDetails) *DescribedServer
SetProtocolDetails sets the ProtocolDetails field's value.
func (s *DescribedServer) SetProtocols(v []*string) *DescribedServer
SetProtocols sets the Protocols field's value.
func (s *DescribedServer) SetS3StorageOptions(v *S3StorageOptions) *DescribedServer
SetS3StorageOptions sets the S3StorageOptions field's value.
func (s *DescribedServer) SetSecurityPolicyName(v string) *DescribedServer
SetSecurityPolicyName sets the SecurityPolicyName field's value.
func (s *DescribedServer) SetServerId(v string) *DescribedServer
SetServerId sets the ServerId field's value.
func (s *DescribedServer) SetState(v string) *DescribedServer
SetState sets the State field's value.
func (s *DescribedServer) SetStructuredLogDestinations(v []*string) *DescribedServer
SetStructuredLogDestinations sets the StructuredLogDestinations field's value.
func (s *DescribedServer) SetTags(v []*Tag) *DescribedServer
SetTags sets the Tags field's value.
func (s *DescribedServer) SetUserCount(v int64) *DescribedServer
SetUserCount sets the UserCount field's value.
func (s *DescribedServer) SetWorkflowDetails(v *WorkflowDetails) *DescribedServer
SetWorkflowDetails sets the WorkflowDetails field's value.
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 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. // // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. 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 Identity and Access Management (IAM) role provides access to paths in // Target. This value can be set only 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) that you want your users' home directory // to be when they log in to the server. If you set it to PATH, the user will // see the absolute Amazon S3 bucket or Amazon EFS path as is in their file // transfer protocol clients. If you set it to LOGICAL, you need to provide // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 // or Amazon EFS paths visible to your users. // // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide // an absolute path using the HomeDirectory parameter. You cannot have both // HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"` // A session policy for your user so that you can use the same Identity and // Access Management (IAM) role across multiple users. This policy scopes down // a user's 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"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that controls your users' access to your Amazon S3 bucket or Amazon // 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 Amazon 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 (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 (s *DescribedUser) SetArn(v string) *DescribedUser
SetArn sets the Arn field's value.
func (s *DescribedUser) SetHomeDirectory(v string) *DescribedUser
SetHomeDirectory sets the HomeDirectory field's value.
func (s *DescribedUser) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *DescribedUser
SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.
func (s *DescribedUser) SetHomeDirectoryType(v string) *DescribedUser
SetHomeDirectoryType sets the HomeDirectoryType field's value.
func (s *DescribedUser) SetPolicy(v string) *DescribedUser
SetPolicy sets the Policy field's value.
func (s *DescribedUser) SetPosixProfile(v *PosixProfile) *DescribedUser
SetPosixProfile sets the PosixProfile field's value.
func (s *DescribedUser) SetRole(v string) *DescribedUser
SetRole sets the Role field's value.
func (s *DescribedUser) SetSshPublicKeys(v []*SshPublicKey) *DescribedUser
SetSshPublicKeys sets the SshPublicKeys field's value.
func (s *DescribedUser) SetTags(v []*Tag) *DescribedUser
SetTags sets the Tags field's value.
func (s *DescribedUser) SetUserName(v string) *DescribedUser
SetUserName sets the UserName field's value.
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 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 (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 (s *DescribedWorkflow) SetArn(v string) *DescribedWorkflow
SetArn sets the Arn field's value.
func (s *DescribedWorkflow) SetDescription(v string) *DescribedWorkflow
SetDescription sets the Description field's value.
func (s *DescribedWorkflow) SetOnExceptionSteps(v []*WorkflowStep) *DescribedWorkflow
SetOnExceptionSteps sets the OnExceptionSteps field's value.
func (s *DescribedWorkflow) SetSteps(v []*WorkflowStep) *DescribedWorkflow
SetSteps sets the Steps field's value.
func (s *DescribedWorkflow) SetTags(v []*Tag) *DescribedWorkflow
SetTags sets the Tags field's value.
func (s *DescribedWorkflow) SetWorkflowId(v string) *DescribedWorkflow
SetWorkflowId sets the WorkflowId field's value.
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 struct { // The identifier 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 }
Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon Elastic File Systems (Amazon EFS) for storage.
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 (s *EfsFileLocation) SetFileSystemId(v string) *EfsFileLocation
SetFileSystemId sets the FileSystemId field's value.
func (s *EfsFileLocation) SetPath(v string) *EfsFileLocation
SetPath sets the Path field's value.
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 (s *EfsFileLocation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EndpointDetails struct { // A list of address allocation IDs that are required to attach an Elastic IP // address to your server's endpoint. // // An address allocation ID corresponds to the allocation ID of an Elastic IP // address. This value can be retrieved from the allocationId field from the // Amazon EC2 Address (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html) // data type. One way to retrieve this value is by calling the EC2 DescribeAddresses // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html) // API. // // This parameter is optional. Set this parameter if you want to make your VPC // endpoint public-facing. For details, see Create an internet-facing endpoint // for your server (https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint). // // This property can only be set as follows: // // * EndpointType must be set to VPC // // * The Transfer Family server must be offline. // // * You cannot set this parameter for Transfer Family servers that use the // FTP protocol. // // * The server must already have SubnetIds populated (SubnetIds and AddressAllocationIds // cannot be updated simultaneously). // // * AddressAllocationIds can't contain duplicates, and must be equal in // length to SubnetIds. For example, if you have three subnet IDs, you must // also specify three address allocation IDs. // // * Call the UpdateServer API to set or change this parameter. 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 identifier 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 identifier 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 (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 (s *EndpointDetails) SetAddressAllocationIds(v []*string) *EndpointDetails
SetAddressAllocationIds sets the AddressAllocationIds field's value.
func (s *EndpointDetails) SetSecurityGroupIds(v []*string) *EndpointDetails
SetSecurityGroupIds sets the SecurityGroupIds field's value.
func (s *EndpointDetails) SetSubnetIds(v []*string) *EndpointDetails
SetSubnetIds sets the SubnetIds field's value.
func (s *EndpointDetails) SetVpcEndpointId(v string) *EndpointDetails
SetVpcEndpointId sets the VpcEndpointId field's value.
func (s *EndpointDetails) SetVpcId(v string) *EndpointDetails
SetVpcId sets the VpcId field's value.
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 (s *EndpointDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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. // // * ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not // selected and a file with the same name already exists in the target location. // // * BAD_REQUEST: a general bad request: for example, a step that attempts // to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged. // // * CUSTOM_STEP_FAILED: occurs when the custom step provided a callback // that indicates failure. // // * INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety // of reasons. // // * NOT_FOUND: occurs when a requested entity, for example a source file // for a copy step, does not exist. // // * PERMISSION_DENIED: occurs if your policy does not contain the correct // permissions to complete one or more of the steps in the workflow. // // * TIMEOUT: occurs when the execution times out. You can set the TimeoutSeconds // for a custom step, anywhere from 1 second to 1800 seconds (30 minutes). // // * THROTTLED: occurs if you exceed the new execution refill rate of one // workflow per second. // // 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 (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 (s *ExecutionError) SetMessage(v string) *ExecutionError
SetMessage sets the Message field's value.
func (s *ExecutionError) SetType(v string) *ExecutionError
SetType sets the Type field's value.
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 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 (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 (s *ExecutionResults) SetOnExceptionSteps(v []*ExecutionStepResult) *ExecutionResults
SetOnExceptionSteps sets the OnExceptionSteps field's value.
func (s *ExecutionResults) SetSteps(v []*ExecutionStepResult) *ExecutionResults
SetSteps sets the Steps field's value.
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 struct { // Specifies the details for an error, if it occurred during execution of the // specified workflow 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 - Perform a custom step with an Lambda function target. // // * DECRYPT - Decrypt a file that was encrypted before it was uploaded. // // * 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 (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 (s *ExecutionStepResult) SetError(v *ExecutionError) *ExecutionStepResult
SetError sets the Error field's value.
func (s *ExecutionStepResult) SetOutputs(v string) *ExecutionStepResult
SetOutputs sets the Outputs field's value.
func (s *ExecutionStepResult) SetStepType(v string) *ExecutionStepResult
SetStepType sets the StepType field's value.
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 struct { // Specifies the Amazon EFS identifier 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 (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 (s *FileLocation) SetEfsFileLocation(v *EfsFileLocation) *FileLocation
SetEfsFileLocation sets the EfsFileLocation field's value.
func (s *FileLocation) SetS3FileLocation(v *S3FileLocation) *FileLocation
SetS3FileLocation sets the S3FileLocation field's value.
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 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"` // Specifies the type of mapping. Set the type to FILE if you want the mapping // to point to a file, or DIRECTORY for the directory to point to a directory. // // By default, home directory mappings have a Type of DIRECTORY when you create // a Transfer Family server. You would need to explicitly set Type to FILE if // you want a mapping to have a file target. Type *string `type:"string" enum:"MapType"` // 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" } ]
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 (s *HomeDirectoryMapEntry) SetEntry(v string) *HomeDirectoryMapEntry
SetEntry sets the Entry field's value.
func (s *HomeDirectoryMapEntry) SetTarget(v string) *HomeDirectoryMapEntry
SetTarget sets the Target field's value.
func (s *HomeDirectoryMapEntry) SetType(v string) *HomeDirectoryMapEntry
SetType sets the Type field's value.
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 (s *HomeDirectoryMapEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type IdentityProviderDetails struct { // The identifier of the Directory Service directory that you want to use as // your identity provider. DirectoryId *string `min:"12" type:"string"` // The ARN for a Lambda function to use for the Identity provider. Function *string `min:"1" type:"string"` // This parameter is only applicable if your IdentityProviderType is API_GATEWAY. // Provides the type of InvocationRole used to authenticate the user account. InvocationRole *string `min:"20" type:"string"` // For SFTP-enabled servers, and for custom identity providers only, you can // specify whether to authenticate using a password, SSH key pair, or both. // // * PASSWORD - users must provide their password to connect. // // * PUBLIC_KEY - users must provide their private key to connect. // // * PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password // or their key. This is the default value. // // * PUBLIC_KEY_AND_PASSWORD - users must provide both their private key // and their password to connect. The server checks the key first, and then // if the key is valid, the system prompts for a password. If the private // key provided does not match the public key that is stored, authentication // fails. SftpAuthenticationMethods *string `type:"string" enum:"SftpAuthenticationMethods"` // 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 (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 (s *IdentityProviderDetails) SetDirectoryId(v string) *IdentityProviderDetails
SetDirectoryId sets the DirectoryId field's value.
func (s *IdentityProviderDetails) SetFunction(v string) *IdentityProviderDetails
SetFunction sets the Function field's value.
func (s *IdentityProviderDetails) SetInvocationRole(v string) *IdentityProviderDetails
SetInvocationRole sets the InvocationRole field's value.
func (s *IdentityProviderDetails) SetSftpAuthenticationMethods(v string) *IdentityProviderDetails
SetSftpAuthenticationMethods sets the SftpAuthenticationMethods field's value.
func (s *IdentityProviderDetails) SetUrl(v string) *IdentityProviderDetails
SetUrl sets the Url field's value.
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 (s *IdentityProviderDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportCertificateInput struct { // An optional date that specifies when the certificate becomes active. ActiveDate *time.Time `type:"timestamp"` // * For the CLI, provide a file path for a certificate in URI format. For // example, --certificate file://encryption-cert.pem. Alternatively, you // can provide the raw content. // // * For the SDK, specify the raw content of a certificate file. For example, // --certificate "`cat encryption-cert.pem`". // // Certificate is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ImportCertificateInput's // String and GoString methods. // // Certificate is a required field Certificate *string `min:"1" type:"string" required:"true" sensitive:"true"` // An optional list of certificates that make up the chain for the certificate // that's being imported. // // CertificateChain is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ImportCertificateInput's // String and GoString methods. CertificateChain *string `min:"1" type:"string" sensitive:"true"` // A short description that helps identify the certificate. Description *string `min:"1" type:"string"` // An optional date that specifies when the certificate becomes inactive. InactiveDate *time.Time `type:"timestamp"` // * For the CLI, provide a file path for a private key in URI format.For // example, --private-key file://encryption-key.pem. Alternatively, you can // provide the raw content of the private key file. // // * For the SDK, specify the raw content of a private key file. For example, // --private-key "`cat encryption-key.pem`" // // PrivateKey is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ImportCertificateInput's // String and GoString methods. PrivateKey *string `min:"1" type:"string" sensitive:"true"` // Key-value pairs that can be used to group and search for certificates. Tags []*Tag `min:"1" type:"list"` // Specifies how this certificate is used. It can be used in the following ways: // // * SIGNING: For signing AS2 messages // // * ENCRYPTION: For encrypting AS2 messages // // * TLS: For securing AS2 communications sent over HTTPS // // Usage is a required field Usage *string `type:"string" required:"true" enum:"CertificateUsageType"` // contains filtered or unexported fields }
func (s ImportCertificateInput) 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 (s *ImportCertificateInput) SetActiveDate(v time.Time) *ImportCertificateInput
SetActiveDate sets the ActiveDate field's value.
func (s *ImportCertificateInput) SetCertificate(v string) *ImportCertificateInput
SetCertificate sets the Certificate field's value.
func (s *ImportCertificateInput) SetCertificateChain(v string) *ImportCertificateInput
SetCertificateChain sets the CertificateChain field's value.
func (s *ImportCertificateInput) SetDescription(v string) *ImportCertificateInput
SetDescription sets the Description field's value.
func (s *ImportCertificateInput) SetInactiveDate(v time.Time) *ImportCertificateInput
SetInactiveDate sets the InactiveDate field's value.
func (s *ImportCertificateInput) SetPrivateKey(v string) *ImportCertificateInput
SetPrivateKey sets the PrivateKey field's value.
func (s *ImportCertificateInput) SetTags(v []*Tag) *ImportCertificateInput
SetTags sets the Tags field's value.
func (s *ImportCertificateInput) SetUsage(v string) *ImportCertificateInput
SetUsage sets the Usage field's value.
func (s ImportCertificateInput) 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 (s *ImportCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportCertificateOutput struct { // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. // // CertificateId is a required field CertificateId *string `min:"22" type:"string" required:"true"` // contains filtered or unexported fields }
func (s ImportCertificateOutput) 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 (s *ImportCertificateOutput) SetCertificateId(v string) *ImportCertificateOutput
SetCertificateId sets the CertificateId field's value.
func (s ImportCertificateOutput) 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 ImportHostKeyInput struct { // The text description that identifies this host key. Description *string `type:"string"` // The private key portion of an SSH key pair. // // Transfer Family accepts RSA, ECDSA, and ED25519 keys. // // HostKeyBody is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ImportHostKeyInput's // String and GoString methods. // // HostKeyBody is a required field HostKeyBody *string `type:"string" required:"true" sensitive:"true"` // The identifier of the server that contains the host key that you are importing. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // Key-value pairs that can be used to group and search for host keys. Tags []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
func (s ImportHostKeyInput) 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 (s *ImportHostKeyInput) SetDescription(v string) *ImportHostKeyInput
SetDescription sets the Description field's value.
func (s *ImportHostKeyInput) SetHostKeyBody(v string) *ImportHostKeyInput
SetHostKeyBody sets the HostKeyBody field's value.
func (s *ImportHostKeyInput) SetServerId(v string) *ImportHostKeyInput
SetServerId sets the ServerId field's value.
func (s *ImportHostKeyInput) SetTags(v []*Tag) *ImportHostKeyInput
SetTags sets the Tags field's value.
func (s ImportHostKeyInput) 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 (s *ImportHostKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportHostKeyOutput struct { // Returns the host key identifier for the imported key. // // HostKeyId is a required field HostKeyId *string `min:"25" type:"string" required:"true"` // Returns the server identifier that contains the imported key. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s ImportHostKeyOutput) 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 (s *ImportHostKeyOutput) SetHostKeyId(v string) *ImportHostKeyOutput
SetHostKeyId sets the HostKeyId field's value.
func (s *ImportHostKeyOutput) SetServerId(v string) *ImportHostKeyOutput
SetServerId sets the ServerId field's value.
func (s ImportHostKeyOutput) 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 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. // // Transfer Family accepts RSA, ECDSA, and ED25519 keys. // // SshPublicKeyBody is a required field SshPublicKeyBody *string `type:"string" required:"true"` // The name of the Transfer Family user 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 (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 (s *ImportSshPublicKeyInput) SetServerId(v string) *ImportSshPublicKeyInput
SetServerId sets the ServerId field's value.
func (s *ImportSshPublicKeyInput) SetSshPublicKeyBody(v string) *ImportSshPublicKeyInput
SetSshPublicKeyBody sets the SshPublicKeyBody field's value.
func (s *ImportSshPublicKeyInput) SetUserName(v string) *ImportSshPublicKeyInput
SetUserName sets the UserName field's value.
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 (s *ImportSshPublicKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ImportSshPublicKeyOutput) SetServerId(v string) *ImportSshPublicKeyOutput
SetServerId sets the ServerId field's value.
func (s *ImportSshPublicKeyOutput) SetSshPublicKeyId(v string) *ImportSshPublicKeyOutput
SetSshPublicKeyId sets the SshPublicKeyId field's value.
func (s *ImportSshPublicKeyOutput) SetUserName(v string) *ImportSshPublicKeyOutput
SetUserName sets the UserName field's value.
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 struct { // Specifies the details for the Amazon Elastic File System (Amazon EFS) file // that's being decrypted. EfsFileLocation *EfsFileLocation `type:"structure"` // Specifies the details for the Amazon S3 file that's being copied or decrypted. S3FileLocation *S3InputFileLocation `type:"structure"` // contains filtered or unexported fields }
Specifies the location for the file that's being processed.
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 (s *InputFileLocation) SetEfsFileLocation(v *EfsFileLocation) *InputFileLocation
SetEfsFileLocation sets the EfsFileLocation field's value.
func (s *InputFileLocation) SetS3FileLocation(v *S3InputFileLocation) *InputFileLocation
SetS3FileLocation sets the S3FileLocation field's value.
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 (s *InputFileLocation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 Transfer Family service.
func (s *InternalServiceError) Code() string
Code returns the exception type name.
func (s *InternalServiceError) Error() string
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 (s *InternalServiceError) Message() string
Message returns the exception's message.
func (s *InternalServiceError) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServiceError) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServiceError) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *InvalidNextTokenException) Code() string
Code returns the exception type name.
func (s *InvalidNextTokenException) Error() string
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 (s *InvalidNextTokenException) Message() string
Message returns the exception's message.
func (s *InvalidNextTokenException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidNextTokenException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidNextTokenException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
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 (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ListAccessesInput) SetMaxResults(v int64) *ListAccessesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListAccessesInput) SetNextToken(v string) *ListAccessesInput
SetNextToken sets the NextToken field's value.
func (s *ListAccessesInput) SetServerId(v string) *ListAccessesInput
SetServerId sets the ServerId field's value.
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 (s *ListAccessesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListAccessesOutput) SetAccesses(v []*ListedAccess) *ListAccessesOutput
SetAccesses sets the Accesses field's value.
func (s *ListAccessesOutput) SetNextToken(v string) *ListAccessesOutput
SetNextToken sets the NextToken field's value.
func (s *ListAccessesOutput) SetServerId(v string) *ListAccessesOutput
SetServerId sets the ServerId field's value.
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 ListAgreementsInput struct { // The maximum number of agreements to return. MaxResults *int64 `min:"1" type:"integer"` // When you can get additional results from the ListAgreements 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 agreements. NextToken *string `min:"1" type:"string"` // The identifier of the server for which you want a list of agreements. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s ListAgreementsInput) 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 (s *ListAgreementsInput) SetMaxResults(v int64) *ListAgreementsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListAgreementsInput) SetNextToken(v string) *ListAgreementsInput
SetNextToken sets the NextToken field's value.
func (s *ListAgreementsInput) SetServerId(v string) *ListAgreementsInput
SetServerId sets the ServerId field's value.
func (s ListAgreementsInput) 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 (s *ListAgreementsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListAgreementsOutput struct { // Returns an array, where each item contains the details of an agreement. // // Agreements is a required field Agreements []*ListedAgreement `type:"list" required:"true"` // Returns a token that you can use to call ListAgreements again and receive // additional results, if there are any. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListAgreementsOutput) 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 (s *ListAgreementsOutput) SetAgreements(v []*ListedAgreement) *ListAgreementsOutput
SetAgreements sets the Agreements field's value.
func (s *ListAgreementsOutput) SetNextToken(v string) *ListAgreementsOutput
SetNextToken sets the NextToken field's value.
func (s ListAgreementsOutput) 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 ListCertificatesInput struct { // The maximum number of certificates to return. MaxResults *int64 `min:"1" type:"integer"` // When you can get additional results from the ListCertificates 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 certificates. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListCertificatesInput) 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 (s *ListCertificatesInput) SetMaxResults(v int64) *ListCertificatesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListCertificatesInput) SetNextToken(v string) *ListCertificatesInput
SetNextToken sets the NextToken field's value.
func (s ListCertificatesInput) 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 (s *ListCertificatesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListCertificatesOutput struct { // Returns an array of the certificates that are specified in the ListCertificates // call. // // Certificates is a required field Certificates []*ListedCertificate `type:"list" required:"true"` // Returns the next token, which you can use to list the next certificate. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListCertificatesOutput) 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 (s *ListCertificatesOutput) SetCertificates(v []*ListedCertificate) *ListCertificatesOutput
SetCertificates sets the Certificates field's value.
func (s *ListCertificatesOutput) SetNextToken(v string) *ListCertificatesOutput
SetNextToken sets the NextToken field's value.
func (s ListCertificatesOutput) 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 ListConnectorsInput struct { // The maximum number of connectors to return. MaxResults *int64 `min:"1" type:"integer"` // When you can get additional results from the ListConnectors 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 connectors. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListConnectorsInput) 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 (s *ListConnectorsInput) SetMaxResults(v int64) *ListConnectorsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListConnectorsInput) SetNextToken(v string) *ListConnectorsInput
SetNextToken sets the NextToken field's value.
func (s ListConnectorsInput) 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 (s *ListConnectorsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListConnectorsOutput struct { // Returns an array, where each item contains the details of a connector. // // Connectors is a required field Connectors []*ListedConnector `type:"list" required:"true"` // Returns a token that you can use to call ListConnectors again and receive // additional results, if there are any. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s ListConnectorsOutput) 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 (s *ListConnectorsOutput) SetConnectors(v []*ListedConnector) *ListConnectorsOutput
SetConnectors sets the Connectors field's value.
func (s *ListConnectorsOutput) SetNextToken(v string) *ListConnectorsOutput
SetNextToken sets the NextToken field's value.
func (s ListConnectorsOutput) 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 struct { // Specifies the maximum 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, call the API by // specifying 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, supplying // 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 (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 (s *ListExecutionsInput) SetMaxResults(v int64) *ListExecutionsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListExecutionsInput) SetNextToken(v string) *ListExecutionsInput
SetNextToken sets the NextToken field's value.
func (s *ListExecutionsInput) SetWorkflowId(v string) *ListExecutionsInput
SetWorkflowId sets the WorkflowId field's value.
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 (s *ListExecutionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListExecutionsOutput struct { // Returns the details for each execution, in a ListedExecution array. // // 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 (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 (s *ListExecutionsOutput) SetExecutions(v []*ListedExecution) *ListExecutionsOutput
SetExecutions sets the Executions field's value.
func (s *ListExecutionsOutput) SetNextToken(v string) *ListExecutionsOutput
SetNextToken sets the NextToken field's value.
func (s *ListExecutionsOutput) SetWorkflowId(v string) *ListExecutionsOutput
SetWorkflowId sets the WorkflowId field's value.
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 ListHostKeysInput struct { // The maximum number of host keys to return. MaxResults *int64 `min:"1" type:"integer"` // When there are additional results that were not returned, a NextToken parameter // is returned. You can use that value for a subsequent call to ListHostKeys // to continue listing results. NextToken *string `min:"1" type:"string"` // The identifier of the server that contains the host keys that you want to // view. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s ListHostKeysInput) 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 (s *ListHostKeysInput) SetMaxResults(v int64) *ListHostKeysInput
SetMaxResults sets the MaxResults field's value.
func (s *ListHostKeysInput) SetNextToken(v string) *ListHostKeysInput
SetNextToken sets the NextToken field's value.
func (s *ListHostKeysInput) SetServerId(v string) *ListHostKeysInput
SetServerId sets the ServerId field's value.
func (s ListHostKeysInput) 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 (s *ListHostKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListHostKeysOutput struct { // Returns an array, where each item contains the details of a host key. // // HostKeys is a required field HostKeys []*ListedHostKey `type:"list" required:"true"` // Returns a token that you can use to call ListHostKeys again and receive additional // results, if there are any. NextToken *string `min:"1" type:"string"` // Returns the server identifier that contains the listed host keys. // // ServerId is a required field ServerId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s ListHostKeysOutput) 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 (s *ListHostKeysOutput) SetHostKeys(v []*ListedHostKey) *ListHostKeysOutput
SetHostKeys sets the HostKeys field's value.
func (s *ListHostKeysOutput) SetNextToken(v string) *ListHostKeysOutput
SetNextToken sets the NextToken field's value.
func (s *ListHostKeysOutput) SetServerId(v string) *ListHostKeysOutput
SetServerId sets the ServerId field's value.
func (s ListHostKeysOutput) 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 ListProfilesInput struct { // The maximum number of profiles to return. MaxResults *int64 `min:"1" type:"integer"` // When there are additional results that were not returned, a NextToken parameter // is returned. You can use that value for a subsequent call to ListProfiles // to continue listing results. NextToken *string `min:"1" type:"string"` // Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. // If not supplied in the request, the command lists all types of profiles. ProfileType *string `type:"string" enum:"ProfileType"` // contains filtered or unexported fields }
func (s ListProfilesInput) 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 (s *ListProfilesInput) SetMaxResults(v int64) *ListProfilesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListProfilesInput) SetNextToken(v string) *ListProfilesInput
SetNextToken sets the NextToken field's value.
func (s *ListProfilesInput) SetProfileType(v string) *ListProfilesInput
SetProfileType sets the ProfileType field's value.
func (s ListProfilesInput) 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 (s *ListProfilesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListProfilesOutput struct { // Returns a token that you can use to call ListProfiles again and receive additional // results, if there are any. NextToken *string `min:"1" type:"string"` // Returns an array, where each item contains the details of a profile. // // Profiles is a required field Profiles []*ListedProfile `type:"list" required:"true"` // contains filtered or unexported fields }
func (s ListProfilesOutput) 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 (s *ListProfilesOutput) SetNextToken(v string) *ListProfilesOutput
SetNextToken sets the NextToken field's value.
func (s *ListProfilesOutput) SetProfiles(v []*ListedProfile) *ListProfilesOutput
SetProfiles sets the Profiles field's value.
func (s ListProfilesOutput) 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 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 (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 (s *ListSecurityPoliciesInput) SetMaxResults(v int64) *ListSecurityPoliciesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListSecurityPoliciesInput) SetNextToken(v string) *ListSecurityPoliciesInput
SetNextToken sets the NextToken field's value.
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 (s *ListSecurityPoliciesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListSecurityPoliciesOutput) SetNextToken(v string) *ListSecurityPoliciesOutput
SetNextToken sets the NextToken field's value.
func (s *ListSecurityPoliciesOutput) SetSecurityPolicyNames(v []*string) *ListSecurityPoliciesOutput
SetSecurityPolicyNames sets the SecurityPolicyNames field's value.
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 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 (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 (s *ListServersInput) SetMaxResults(v int64) *ListServersInput
SetMaxResults sets the MaxResults field's value.
func (s *ListServersInput) SetNextToken(v string) *ListServersInput
SetNextToken sets the NextToken field's value.
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 (s *ListServersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListServersOutput) SetNextToken(v string) *ListServersOutput
SetNextToken sets the NextToken field's value.
func (s *ListServersOutput) SetServers(v []*ListedServer) *ListServersOutput
SetServers sets the Servers field's value.
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 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 (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 (s *ListTagsForResourceInput) SetArn(v string) *ListTagsForResourceInput
SetArn sets the Arn field's value.
func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput
SetMaxResults sets the MaxResults field's value.
func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput
SetNextToken sets the NextToken field's value.
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 (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListTagsForResourceOutput) SetArn(v string) *ListTagsForResourceOutput
SetArn sets the Arn field's value.
func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput
SetNextToken sets the NextToken field's value.
func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
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 struct { // Specifies the number of users to return as a response to the ListUsers request. MaxResults *int64 `min:"1" type:"integer"` // If there are additional results from the ListUsers call, a NextToken parameter // is returned in the output. You can then pass the NextToken to a subsequent // ListUsers command, 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 (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 (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput
SetMaxResults sets the MaxResults field's value.
func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput
SetNextToken sets the NextToken field's value.
func (s *ListUsersInput) SetServerId(v string) *ListUsersInput
SetServerId sets the ServerId field's value.
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 (s *ListUsersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 Transfer Family users 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 (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 (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput
SetNextToken sets the NextToken field's value.
func (s *ListUsersOutput) SetServerId(v string) *ListUsersOutput
SetServerId sets the ServerId field's value.
func (s *ListUsersOutput) SetUsers(v []*ListedUser) *ListUsersOutput
SetUsers sets the Users field's value.
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 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 (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 (s *ListWorkflowsInput) SetMaxResults(v int64) *ListWorkflowsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListWorkflowsInput) SetNextToken(v string) *ListWorkflowsInput
SetNextToken sets the NextToken field's value.
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 (s *ListWorkflowsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListWorkflowsOutput) SetNextToken(v string) *ListWorkflowsOutput
SetNextToken sets the NextToken field's value.
func (s *ListWorkflowsOutput) SetWorkflows(v []*ListedWorkflow) *ListWorkflowsOutput
SetWorkflows sets the Workflows field's value.
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 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 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 regular expression 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. // // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. HomeDirectory *string `type:"string"` // The type of landing directory (folder) that you want your users' home directory // to be when they log in to the server. If you set it to PATH, the user will // see the absolute Amazon S3 bucket or Amazon EFS path as is in their file // transfer protocol clients. If you set it to LOGICAL, you need to provide // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 // or Amazon EFS paths visible to your users. // // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide // an absolute path using the HomeDirectory parameter. You cannot have both // HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that controls your users' access to your Amazon S3 bucket or Amazon // 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 Amazon 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 (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 (s *ListedAccess) SetExternalId(v string) *ListedAccess
SetExternalId sets the ExternalId field's value.
func (s *ListedAccess) SetHomeDirectory(v string) *ListedAccess
SetHomeDirectory sets the HomeDirectory field's value.
func (s *ListedAccess) SetHomeDirectoryType(v string) *ListedAccess
SetHomeDirectoryType sets the HomeDirectoryType field's value.
func (s *ListedAccess) SetRole(v string) *ListedAccess
SetRole sets the Role field's value.
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 ListedAgreement struct { // A unique identifier for the agreement. This identifier is returned when you // create an agreement. AgreementId *string `min:"19" type:"string"` // The Amazon Resource Name (ARN) of the specified agreement. Arn *string `min:"20" type:"string"` // The current description for the agreement. You can change it by calling the // UpdateAgreement operation and providing a new description. Description *string `min:"1" type:"string"` // A unique identifier for the AS2 local profile. LocalProfileId *string `min:"19" type:"string"` // A unique identifier for the partner profile. PartnerProfileId *string `min:"19" type:"string"` // The unique identifier for the agreement. ServerId *string `min:"19" type:"string"` // The agreement can be either ACTIVE or INACTIVE. Status *string `type:"string" enum:"AgreementStatusType"` // contains filtered or unexported fields }
Describes the properties of an agreement.
func (s ListedAgreement) 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 (s *ListedAgreement) SetAgreementId(v string) *ListedAgreement
SetAgreementId sets the AgreementId field's value.
func (s *ListedAgreement) SetArn(v string) *ListedAgreement
SetArn sets the Arn field's value.
func (s *ListedAgreement) SetDescription(v string) *ListedAgreement
SetDescription sets the Description field's value.
func (s *ListedAgreement) SetLocalProfileId(v string) *ListedAgreement
SetLocalProfileId sets the LocalProfileId field's value.
func (s *ListedAgreement) SetPartnerProfileId(v string) *ListedAgreement
SetPartnerProfileId sets the PartnerProfileId field's value.
func (s *ListedAgreement) SetServerId(v string) *ListedAgreement
SetServerId sets the ServerId field's value.
func (s *ListedAgreement) SetStatus(v string) *ListedAgreement
SetStatus sets the Status field's value.
func (s ListedAgreement) 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 ListedCertificate struct { // An optional date that specifies when the certificate becomes active. ActiveDate *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) of the specified certificate. Arn *string `min:"20" type:"string"` // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. CertificateId *string `min:"22" type:"string"` // The name or short description that's used to identify the certificate. Description *string `min:"1" type:"string"` // An optional date that specifies when the certificate becomes inactive. InactiveDate *time.Time `type:"timestamp"` // The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION // means that this certificate will replace the current certificate when it // expires. Status *string `type:"string" enum:"CertificateStatusType"` // The type for the certificate. If a private key has been specified for the // certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private // key, the type is CERTIFICATE. Type *string `type:"string" enum:"CertificateType"` // Specifies how this certificate is used. It can be used in the following ways: // // * SIGNING: For signing AS2 messages // // * ENCRYPTION: For encrypting AS2 messages // // * TLS: For securing AS2 communications sent over HTTPS Usage *string `type:"string" enum:"CertificateUsageType"` // contains filtered or unexported fields }
Describes the properties of a certificate.
func (s ListedCertificate) 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 (s *ListedCertificate) SetActiveDate(v time.Time) *ListedCertificate
SetActiveDate sets the ActiveDate field's value.
func (s *ListedCertificate) SetArn(v string) *ListedCertificate
SetArn sets the Arn field's value.
func (s *ListedCertificate) SetCertificateId(v string) *ListedCertificate
SetCertificateId sets the CertificateId field's value.
func (s *ListedCertificate) SetDescription(v string) *ListedCertificate
SetDescription sets the Description field's value.
func (s *ListedCertificate) SetInactiveDate(v time.Time) *ListedCertificate
SetInactiveDate sets the InactiveDate field's value.
func (s *ListedCertificate) SetStatus(v string) *ListedCertificate
SetStatus sets the Status field's value.
func (s *ListedCertificate) SetType(v string) *ListedCertificate
SetType sets the Type field's value.
func (s *ListedCertificate) SetUsage(v string) *ListedCertificate
SetUsage sets the Usage field's value.
func (s ListedCertificate) 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 ListedConnector struct { // The Amazon Resource Name (ARN) of the specified connector. Arn *string `min:"20" type:"string"` // The unique identifier for the connector. ConnectorId *string `min:"19" type:"string"` // The URL of the partner's AS2 or SFTP endpoint. Url *string `type:"string"` // contains filtered or unexported fields }
Returns details of the connector that is specified.
func (s ListedConnector) 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 (s *ListedConnector) SetArn(v string) *ListedConnector
SetArn sets the Arn field's value.
func (s *ListedConnector) SetConnectorId(v string) *ListedConnector
SetConnectorId sets the ConnectorId field's value.
func (s *ListedConnector) SetUrl(v string) *ListedConnector
SetUrl sets the Url field's value.
func (s ListedConnector) 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 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 that are 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 (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 (s *ListedExecution) SetExecutionId(v string) *ListedExecution
SetExecutionId sets the ExecutionId field's value.
func (s *ListedExecution) SetInitialFileLocation(v *FileLocation) *ListedExecution
SetInitialFileLocation sets the InitialFileLocation field's value.
func (s *ListedExecution) SetServiceMetadata(v *ServiceMetadata) *ListedExecution
SetServiceMetadata sets the ServiceMetadata field's value.
func (s *ListedExecution) SetStatus(v string) *ListedExecution
SetStatus sets the Status field's value.
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 ListedHostKey struct { // The unique Amazon Resource Name (ARN) of the host key. // // Arn is a required field Arn *string `min:"20" type:"string" required:"true"` // The date on which the host key was added to the server. DateImported *time.Time `type:"timestamp"` // The current description for the host key. You can change it by calling the // UpdateHostKey operation and providing a new description. Description *string `type:"string"` // The public key fingerprint, which is a short sequence of bytes used to identify // the longer public key. Fingerprint *string `type:"string"` // A unique identifier for the host key. HostKeyId *string `min:"25" type:"string"` // The encryption algorithm that is used for the host key. The Type parameter // is specified by using one of the following values: // // * ssh-rsa // // * ssh-ed25519 // // * ecdsa-sha2-nistp256 // // * ecdsa-sha2-nistp384 // // * ecdsa-sha2-nistp521 Type *string `type:"string"` // contains filtered or unexported fields }
Returns properties of the host key that's specified.
func (s ListedHostKey) 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 (s *ListedHostKey) SetArn(v string) *ListedHostKey
SetArn sets the Arn field's value.
func (s *ListedHostKey) SetDateImported(v time.Time) *ListedHostKey
SetDateImported sets the DateImported field's value.
func (s *ListedHostKey) SetDescription(v string) *ListedHostKey
SetDescription sets the Description field's value.
func (s *ListedHostKey) SetFingerprint(v string) *ListedHostKey
SetFingerprint sets the Fingerprint field's value.
func (s *ListedHostKey) SetHostKeyId(v string) *ListedHostKey
SetHostKeyId sets the HostKeyId field's value.
func (s *ListedHostKey) SetType(v string) *ListedHostKey
SetType sets the Type field's value.
func (s ListedHostKey) 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 ListedProfile struct { // The Amazon Resource Name (ARN) of the specified profile. Arn *string `min:"20" type:"string"` // The As2Id is the AS2-name, as defined in the RFC 4130 (https://datatracker.ietf.org/doc/html/rfc4130). // For inbound transfers, this is the AS2-From header for the AS2 messages sent // from the partner. For outbound connectors, this is the AS2-To header for // the AS2 messages sent to the partner using the StartFileTransfer API operation. // This ID cannot include spaces. As2Id *string `min:"1" type:"string"` // A unique identifier for the local or partner AS2 profile. ProfileId *string `min:"19" type:"string"` // Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. // If not supplied in the request, the command lists all types of profiles. ProfileType *string `type:"string" enum:"ProfileType"` // contains filtered or unexported fields }
Returns the properties of the profile that was specified.
func (s ListedProfile) 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 (s *ListedProfile) SetArn(v string) *ListedProfile
SetArn sets the Arn field's value.
func (s *ListedProfile) SetAs2Id(v string) *ListedProfile
SetAs2Id sets the As2Id field's value.
func (s *ListedProfile) SetProfileId(v string) *ListedProfile
SetProfileId sets the ProfileId field's value.
func (s *ListedProfile) SetProfileType(v string) *ListedProfile
SetProfileType sets the ProfileType field's value.
func (s ListedProfile) 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 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. // There are two domains available: Amazon Simple Storage Service (Amazon S3) // and Amazon Elastic File System (Amazon EFS). The default value is S3. 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"` // The mode of authentication for a server. The default value is SERVICE_MANAGED, // which allows you to store and access user credentials within the Transfer // Family service. // // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in // Directory Service for Microsoft Active Directory or Microsoft Active Directory // in your on-premises environment or in Amazon Web Services using AD Connector. // This option also requires you to provide a Directory ID by 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 Amazon API Gateway // endpoint URL to call for authentication by using the IdentityProviderDetails // parameter. // // Use the AWS_LAMBDA value to directly use an Lambda function as your identity // provider. If you choose this value, you must specify the ARN for the Lambda // function in the Function parameter for the IdentityProviderDetails data type. IdentityProviderType *string `type:"string" enum:"IdentityProviderType"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that allows a server to turn on Amazon CloudWatch logging for Amazon // S3 or Amazon EFSevents. When set, you can view user activity 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"` // The condition of 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 (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 (s *ListedServer) SetArn(v string) *ListedServer
SetArn sets the Arn field's value.
func (s *ListedServer) SetDomain(v string) *ListedServer
SetDomain sets the Domain field's value.
func (s *ListedServer) SetEndpointType(v string) *ListedServer
SetEndpointType sets the EndpointType field's value.
func (s *ListedServer) SetIdentityProviderType(v string) *ListedServer
SetIdentityProviderType sets the IdentityProviderType field's value.
func (s *ListedServer) SetLoggingRole(v string) *ListedServer
SetLoggingRole sets the LoggingRole field's value.
func (s *ListedServer) SetServerId(v string) *ListedServer
SetServerId sets the ServerId field's value.
func (s *ListedServer) SetState(v string) *ListedServer
SetState sets the State field's value.
func (s *ListedServer) SetUserCount(v int64) *ListedServer
SetUserCount sets the UserCount field's value.
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 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. // // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH. HomeDirectory *string `type:"string"` // The type of landing directory (folder) that you want your users' home directory // to be when they log in to the server. If you set it to PATH, the user will // see the absolute Amazon S3 bucket or Amazon EFS path as is in their file // transfer protocol clients. If you set it to LOGICAL, you need to provide // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 // or Amazon EFS paths visible to your users. // // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide // an absolute path using the HomeDirectory parameter. You cannot have both // HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that controls your users' access to your Amazon S3 bucket or Amazon // 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 Amazon 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 (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 (s *ListedUser) SetArn(v string) *ListedUser
SetArn sets the Arn field's value.
func (s *ListedUser) SetHomeDirectory(v string) *ListedUser
SetHomeDirectory sets the HomeDirectory field's value.
func (s *ListedUser) SetHomeDirectoryType(v string) *ListedUser
SetHomeDirectoryType sets the HomeDirectoryType field's value.
func (s *ListedUser) SetRole(v string) *ListedUser
SetRole sets the Role field's value.
func (s *ListedUser) SetSshPublicKeyCount(v int64) *ListedUser
SetSshPublicKeyCount sets the SshPublicKeyCount field's value.
func (s *ListedUser) SetUserName(v string) *ListedUser
SetUserName sets the UserName field's value.
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 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 identifier, text description, and Amazon Resource Name (ARN) for the workflow.
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 (s *ListedWorkflow) SetArn(v string) *ListedWorkflow
SetArn sets the Arn field's value.
func (s *ListedWorkflow) SetDescription(v string) *ListedWorkflow
SetDescription sets the Description field's value.
func (s *ListedWorkflow) SetWorkflowId(v string) *ListedWorkflow
SetWorkflowId sets the WorkflowId field's value.
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 struct { // The name of the CloudWatch logging group for the Transfer Family server to // which this workflow belongs. LogGroupName *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // role that allows a server to turn on Amazon CloudWatch logging for Amazon // S3 or Amazon EFSevents. When set, you can view user activity 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 (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 (s *LoggingConfiguration) SetLogGroupName(v string) *LoggingConfiguration
SetLogGroupName sets the LogGroupName field's value.
func (s *LoggingConfiguration) SetLoggingRole(v string) *LoggingConfiguration
SetLoggingRole sets the LoggingRole field's value.
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 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 (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 (s *PosixProfile) SetGid(v int64) *PosixProfile
SetGid sets the Gid field's value.
func (s *PosixProfile) SetSecondaryGids(v []*int64) *PosixProfile
SetSecondaryGids sets the SecondaryGids field's value.
func (s *PosixProfile) SetUid(v int64) *PosixProfile
SetUid sets the Uid field's value.
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 (s *PosixProfile) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ProtocolDetails struct { // Indicates the transport method for the AS2 messages. Currently, only HTTP // is supported. As2Transports []*string `min:"1" type:"list" enum:"As2Transport"` // Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, // such as the public 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 // Family server for the change to take effect. For details on using passive // mode (PASV) in a NAT environment, see Configuring your FTPS server behind // a firewall or NAT with Transfer Family (http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/). // // Special values // // The AUTO and 0.0.0.0 are special values for the PassiveIp parameter. The // value PassiveIp=AUTO is assigned by default to FTP and FTPS type servers. // In this case, the server automatically responds with one of the endpoint // IPs within the PASV response. PassiveIp=0.0.0.0 has a more unique application // for its usage. For example, if you have a High Availability (HA) Network // Load Balancer (NLB) environment, where you have 3 subnets, you can only specify // a single IP address using the PassiveIp parameter. This reduces the effectiveness // of having High Availability. In this case, you can specify PassiveIp=0.0.0.0. // This tells the client to use the same IP address as the Control connection // and utilize all AZs for their connections. Note, however, that not all FTP // clients support the PassiveIp=0.0.0.0 response. FileZilla and WinSCP do support // it. If you are using other clients, check to see if your client supports // the PassiveIp=0.0.0.0 response. PassiveIp *string `type:"string"` // Use the SetStatOption to ignore the error that is generated when the client // attempts to use SETSTAT on a file you are uploading to an S3 bucket. // // Some SFTP file transfer clients can attempt to change the attributes of remote // files, including timestamp and permissions, using commands, such as SETSTAT // when uploading the file. However, these commands are not compatible with // object storage systems, such as Amazon S3. Due to this incompatibility, file // uploads from these clients can result in errors even when the file is otherwise // successfully uploaded. // // Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the // SETSTAT command, and upload files without needing to make any changes to // your SFTP client. While the SetStatOption ENABLE_NO_OP setting ignores the // error, it does generate a log entry in Amazon CloudWatch Logs, so you can // determine when the client is making a SETSTAT call. // // If you want to preserve the original timestamp for your file, and modify // other file attributes using SETSTAT, you can use Amazon EFS as backend storage // with Transfer Family. SetStatOption *string `type:"string" enum:"SetStatOption"` // A property used with Transfer Family servers that use the FTPS protocol. // TLS Session Resumption provides a mechanism to resume or share a negotiated // secret key between the control and data connection for an FTPS session. TlsSessionResumptionMode // determines whether or not the server resumes recent, negotiated sessions // through a unique session ID. This property is available during CreateServer // and UpdateServer calls. If a TlsSessionResumptionMode value is not specified // during CreateServer, it is set to ENFORCED by default. // // * DISABLED: the server does not process TLS session resumption client // requests and creates a new TLS session for each request. // // * ENABLED: the server processes and accepts clients that are performing // TLS session resumption. The server doesn't reject client data connections // that do not perform the TLS session resumption client processing. // // * ENFORCED: the server processes and accepts clients that are performing // TLS session resumption. The server rejects client data connections that // do not perform the TLS session resumption client processing. Before you // set the value to ENFORCED, test your clients. Not all FTPS clients perform // TLS session resumption. So, if you choose to enforce TLS session resumption, // you prevent any connections from FTPS clients that don't perform the protocol // negotiation. To determine whether or not you can use the ENFORCED value, // you need to test your clients. TlsSessionResumptionMode *string `type:"string" enum:"TlsSessionResumptionMode"` // contains filtered or unexported fields }
The protocol settings that are configured for your server.
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 (s *ProtocolDetails) SetAs2Transports(v []*string) *ProtocolDetails
SetAs2Transports sets the As2Transports field's value.
func (s *ProtocolDetails) SetPassiveIp(v string) *ProtocolDetails
SetPassiveIp sets the PassiveIp field's value.
func (s *ProtocolDetails) SetSetStatOption(v string) *ProtocolDetails
SetSetStatOption sets the SetStatOption field's value.
func (s *ProtocolDetails) SetTlsSessionResumptionMode(v string) *ProtocolDetails
SetTlsSessionResumptionMode sets the TlsSessionResumptionMode field's value.
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".
func (s *ProtocolDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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, or exists in a region other than the one specified for the command.
func (s *ResourceExistsException) Code() string
Code returns the exception type name.
func (s *ResourceExistsException) Error() string
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 (s *ResourceExistsException) Message() string
Message returns the exception's message.
func (s *ResourceExistsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceExistsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceExistsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 Amazon 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 that's being used in the workflow. Only applicable if you are using S3 storage.
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 (s *S3FileLocation) SetBucket(v string) *S3FileLocation
SetBucket sets the Bucket field's value.
func (s *S3FileLocation) SetEtag(v string) *S3FileLocation
SetEtag sets the Etag field's value.
func (s *S3FileLocation) SetKey(v string) *S3FileLocation
SetKey sets the Key field's value.
func (s *S3FileLocation) SetVersionId(v string) *S3FileLocation
SetVersionId sets the VersionId field's value.
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 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 Amazon S3. You use the // object key to retrieve the object. Key *string `type:"string"` // contains filtered or unexported fields }
Specifies the customer input Amazon 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 (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 (s *S3InputFileLocation) SetBucket(v string) *S3InputFileLocation
SetBucket sets the Bucket field's value.
func (s *S3InputFileLocation) SetKey(v string) *S3InputFileLocation
SetKey sets the Key field's value.
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 (s *S3InputFileLocation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3StorageOptions struct { // Specifies whether or not performance for your Amazon S3 directories is optimized. // This is disabled by default. // // By default, home directory mappings have a TYPE of DIRECTORY. If you enable // this option, you would then need to explicitly set the HomeDirectoryMapEntry // Type to FILE if you want a mapping to have a file target. DirectoryListingOptimization *string `type:"string" enum:"DirectoryListingOptimization"` // contains filtered or unexported fields }
The Amazon S3 storage options that are configured for your server.
func (s S3StorageOptions) 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 (s *S3StorageOptions) SetDirectoryListingOptimization(v string) *S3StorageOptions
SetDirectoryListingOptimization sets the DirectoryListingOptimization field's value.
func (s S3StorageOptions) 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 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 (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 (s *S3Tag) SetKey(v string) *S3Tag
SetKey sets the Key field's value.
func (s *S3Tag) SetValue(v string) *S3Tag
SetValue sets the Value field's value.
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 (s *S3Tag) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *SendWorkflowStepStateInput) SetExecutionId(v string) *SendWorkflowStepStateInput
SetExecutionId sets the ExecutionId field's value.
func (s *SendWorkflowStepStateInput) SetStatus(v string) *SendWorkflowStepStateInput
SetStatus sets the Status field's value.
func (s *SendWorkflowStepStateInput) SetToken(v string) *SendWorkflowStepStateInput
SetToken sets the Token field's value.
func (s *SendWorkflowStepStateInput) SetWorkflowId(v string) *SendWorkflowStepStateInput
SetWorkflowId sets the WorkflowId field's value.
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 (s *SendWorkflowStepStateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendWorkflowStepStateOutput struct {
// contains filtered or unexported fields
}
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 (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 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 that are associated with a workflow.
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 (s *ServiceMetadata) SetUserDetails(v *UserDetails) *ServiceMetadata
SetUserDetails sets the UserDetails field's value.
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 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 (s *ServiceUnavailableException) Code() string
Code returns the exception type name.
func (s *ServiceUnavailableException) Error() string
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 (s *ServiceUnavailableException) Message() string
Message returns the exception's message.
func (s *ServiceUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 SftpConnectorConfig struct { // The public portion of the host key, or keys, that are used to identify the // external server to which you are connecting. You can use the ssh-keyscan // command against the SFTP server to retrieve the necessary key. // // The three standard SSH public key format elements are <key type>, <body base64>, // and an optional <comment>, with spaces between each element. Specify only // the <key type> and <body base64>: do not enter the <comment> portion of the // key. // // For the trusted host key, Transfer Family accepts RSA and ECDSA keys. // // * For RSA keys, the <key type> string is ssh-rsa. // // * For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256, // ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of // the key you generated. // // Run this command to retrieve the SFTP server host key, where your SFTP server // name is ftp.host.com. // // ssh-keyscan ftp.host.com // // This prints the public host key to standard output. // // ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key // // Copy and paste this string into the TrustedHostKeys field for the create-connector // command or into the Trusted host keys field in the console. TrustedHostKeys []*string `min:"1" type:"list"` // The identifier for the secret (in Amazon Web Services Secrets Manager) that // contains the SFTP user's private key, password, or both. The identifier must // be the Amazon Resource Name (ARN) of the secret. UserSecretId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.
Because the SftpConnectorConfig data type is used for both creating and updating SFTP connectors, its parameters, TrustedHostKeys and UserSecretId are marked as not required. This is a bit misleading, as they are not required when you are updating an existing SFTP connector, but are required when you are creating a new SFTP connector.
func (s SftpConnectorConfig) 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 (s *SftpConnectorConfig) SetTrustedHostKeys(v []*string) *SftpConnectorConfig
SetTrustedHostKeys sets the TrustedHostKeys field's value.
func (s *SftpConnectorConfig) SetUserSecretId(v string) *SftpConnectorConfig
SetUserSecretId sets the UserSecretId field's value.
func (s SftpConnectorConfig) 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 (s *SftpConnectorConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SshPublicKey struct { // Specifies the date that the public key was added to the Transfer Family user. // // 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. // // Transfer Family accepts RSA, ECDSA, and ED25519 keys. // // 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 Transfer Family user 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 (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 (s *SshPublicKey) SetDateImported(v time.Time) *SshPublicKey
SetDateImported sets the DateImported field's value.
func (s *SshPublicKey) SetSshPublicKeyBody(v string) *SshPublicKey
SetSshPublicKeyBody sets the SshPublicKeyBody field's value.
func (s *SshPublicKey) SetSshPublicKeyId(v string) *SshPublicKey
SetSshPublicKeyId sets the SshPublicKeyId field's value.
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 StartDirectoryListingInput struct { // The unique identifier for the connector. // // ConnectorId is a required field ConnectorId *string `min:"19" type:"string" required:"true"` // An optional parameter where you can specify the maximum number of file/directory // names to retrieve. The default value is 1,000. MaxItems *int64 `min:"1" type:"integer"` // Specifies the path (bucket and prefix) in Amazon S3 storage to store the // results of the directory listing. // // OutputDirectoryPath is a required field OutputDirectoryPath *string `min:"1" type:"string" required:"true"` // Specifies the directory on the remote SFTP server for which you want to list // its contents. // // RemoteDirectoryPath is a required field RemoteDirectoryPath *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s StartDirectoryListingInput) 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 (s *StartDirectoryListingInput) SetConnectorId(v string) *StartDirectoryListingInput
SetConnectorId sets the ConnectorId field's value.
func (s *StartDirectoryListingInput) SetMaxItems(v int64) *StartDirectoryListingInput
SetMaxItems sets the MaxItems field's value.
func (s *StartDirectoryListingInput) SetOutputDirectoryPath(v string) *StartDirectoryListingInput
SetOutputDirectoryPath sets the OutputDirectoryPath field's value.
func (s *StartDirectoryListingInput) SetRemoteDirectoryPath(v string) *StartDirectoryListingInput
SetRemoteDirectoryPath sets the RemoteDirectoryPath field's value.
func (s StartDirectoryListingInput) 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 (s *StartDirectoryListingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartDirectoryListingOutput struct { // Returns a unique identifier for the directory listing call. // // ListingId is a required field ListingId *string `min:"1" type:"string" required:"true"` // Returns the file name where the results are stored. This is a combination // of the connector ID and the listing ID: <connector-id>-<listing-id>.json. // // OutputFileName is a required field OutputFileName *string `min:"26" type:"string" required:"true"` // contains filtered or unexported fields }
func (s StartDirectoryListingOutput) 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 (s *StartDirectoryListingOutput) SetListingId(v string) *StartDirectoryListingOutput
SetListingId sets the ListingId field's value.
func (s *StartDirectoryListingOutput) SetOutputFileName(v string) *StartDirectoryListingOutput
SetOutputFileName sets the OutputFileName field's value.
func (s StartDirectoryListingOutput) 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 StartFileTransferInput struct { // The unique identifier for the connector. // // ConnectorId is a required field ConnectorId *string `min:"19" type:"string" required:"true"` // For an inbound transfer, the LocaDirectoryPath specifies the destination // for one or more files that are transferred from the partner's SFTP server. LocalDirectoryPath *string `min:"1" type:"string"` // For an outbound transfer, the RemoteDirectoryPath specifies the destination // for one or more files that are transferred to the partner's SFTP server. // If you don't specify a RemoteDirectoryPath, the destination for transferred // files is the SFTP user's home directory. RemoteDirectoryPath *string `min:"1" type:"string"` // One or more source paths for the partner's SFTP server. Each string represents // a source file path for one inbound file transfer. RetrieveFilePaths []*string `min:"1" type:"list"` // One or more source paths for the Amazon S3 storage. Each string represents // a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt . // // Replace DOC-EXAMPLE-BUCKET with one of your actual buckets. SendFilePaths []*string `min:"1" type:"list"` // contains filtered or unexported fields }
func (s StartFileTransferInput) 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 (s *StartFileTransferInput) SetConnectorId(v string) *StartFileTransferInput
SetConnectorId sets the ConnectorId field's value.
func (s *StartFileTransferInput) SetLocalDirectoryPath(v string) *StartFileTransferInput
SetLocalDirectoryPath sets the LocalDirectoryPath field's value.
func (s *StartFileTransferInput) SetRemoteDirectoryPath(v string) *StartFileTransferInput
SetRemoteDirectoryPath sets the RemoteDirectoryPath field's value.
func (s *StartFileTransferInput) SetRetrieveFilePaths(v []*string) *StartFileTransferInput
SetRetrieveFilePaths sets the RetrieveFilePaths field's value.
func (s *StartFileTransferInput) SetSendFilePaths(v []*string) *StartFileTransferInput
SetSendFilePaths sets the SendFilePaths field's value.
func (s StartFileTransferInput) 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 (s *StartFileTransferInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartFileTransferOutput struct { // Returns the unique identifier for the file transfer. // // TransferId is a required field TransferId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s StartFileTransferOutput) 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 (s *StartFileTransferOutput) SetTransferId(v string) *StartFileTransferOutput
SetTransferId sets the TransferId field's value.
func (s StartFileTransferOutput) 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 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 (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 (s *StartServerInput) SetServerId(v string) *StartServerInput
SetServerId sets the ServerId field's value.
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 (s *StartServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartServerOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *StopServerInput) SetServerId(v string) *StopServerInput
SetServerId sets the ServerId field's value.
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 (s *StopServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopServerOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *Tag) SetKey(v string) *Tag
SetKey sets the Key field's value.
func (s *Tag) SetValue(v string) *Tag
SetValue sets the Value field's value.
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 (s *Tag) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 resources (servers, users, // workflows, and so on) for any purpose. // // Tags is a required field Tags []*Tag `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
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 (s *TagResourceInput) SetArn(v string) *TagResourceInput
SetArn sets the Arn field's value.
func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput
SetTags sets the Tags field's value.
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 (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput struct {
// contains filtered or unexported fields
}
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 (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 struct { // The name of the step, used as an identifier. Name *string `type:"string"` // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. // // * To use the previous file as the input, enter ${previous.file}. In this // case, this workflow step uses the output file from the previous workflow // step as input. This is the default value. // // * To use the originally uploaded file location as input for this step, // enter ${original.file}. SourceFileLocation *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 (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 (s *TagStepDetails) SetName(v string) *TagStepDetails
SetName sets the Name field's value.
func (s *TagStepDetails) SetSourceFileLocation(v string) *TagStepDetails
SetSourceFileLocation sets the SourceFileLocation field's value.
func (s *TagStepDetails) SetTags(v []*S3Tag) *TagStepDetails
SetTags sets the Tags field's value.
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 (s *TagStepDetails) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TestConnectionInput struct { // The unique identifier for the connector. // // ConnectorId is a required field ConnectorId *string `min:"19" type:"string" required:"true"` // contains filtered or unexported fields }
func (s TestConnectionInput) 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 (s *TestConnectionInput) SetConnectorId(v string) *TestConnectionInput
SetConnectorId sets the ConnectorId field's value.
func (s TestConnectionInput) 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 (s *TestConnectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TestConnectionOutput struct { // Returns the identifier of the connector object that you are testing. ConnectorId *string `min:"19" type:"string"` // Returns OK for successful test, or ERROR if the test fails. Status *string `type:"string"` // Returns Connection succeeded if the test is successful. Or, returns a descriptive // error message if the test fails. The following list provides troubleshooting // details, depending on the error message that you receive. // // * Verify that your secret name aligns with the one in Transfer Role permissions. // // * Verify the server URL in the connector configuration , and verify that // the login credentials work successfully outside of the connector. // // * Verify that the secret exists and is formatted correctly. // // * Verify that the trusted host key in the connector configuration matches // the ssh-keyscan output. StatusMessage *string `type:"string"` // contains filtered or unexported fields }
func (s TestConnectionOutput) 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 (s *TestConnectionOutput) SetConnectorId(v string) *TestConnectionOutput
SetConnectorId sets the ConnectorId field's value.
func (s *TestConnectionOutput) SetStatus(v string) *TestConnectionOutput
SetStatus sets the Status field's value.
func (s *TestConnectionOutput) SetStatusMessage(v string) *TestConnectionOutput
SetStatusMessage sets the StatusMessage field's value.
func (s TestConnectionOutput) 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 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) // // * Applicability Statement 2 (AS2) ServerProtocol *string `type:"string" enum:"Protocol"` // The source IP address of the account to be tested. SourceIp *string `type:"string"` // The name of the account to be tested. // // UserName is a required field UserName *string `min:"3" type:"string" required:"true"` // The password of the 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 (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 (s *TestIdentityProviderInput) SetServerId(v string) *TestIdentityProviderInput
SetServerId sets the ServerId field's value.
func (s *TestIdentityProviderInput) SetServerProtocol(v string) *TestIdentityProviderInput
SetServerProtocol sets the ServerProtocol field's value.
func (s *TestIdentityProviderInput) SetSourceIp(v string) *TestIdentityProviderInput
SetSourceIp sets the SourceIp field's value.
func (s *TestIdentityProviderInput) SetUserName(v string) *TestIdentityProviderInput
SetUserName sets the UserName field's value.
func (s *TestIdentityProviderInput) SetUserPassword(v string) *TestIdentityProviderInput
SetUserPassword sets the UserPassword field's value.
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 (s *TestIdentityProviderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TestIdentityProviderOutput struct { // A message that indicates whether the test was successful or not. // // If an empty string is returned, the most likely cause is that the authentication // failed due to an incorrect username or password. Message *string `type:"string"` // The response that is returned from your API Gateway or your Lambda function. Response *string `type:"string"` // The HTTP status code that is the response from your API Gateway or your Lambda // function. // // 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 (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 (s *TestIdentityProviderOutput) SetMessage(v string) *TestIdentityProviderOutput
SetMessage sets the Message field's value.
func (s *TestIdentityProviderOutput) SetResponse(v string) *TestIdentityProviderOutput
SetResponse sets the Response field's value.
func (s *TestIdentityProviderOutput) SetStatusCode(v int64) *TestIdentityProviderOutput
SetStatusCode sets the StatusCode field's value.
func (s *TestIdentityProviderOutput) SetUrl(v string) *TestIdentityProviderOutput
SetUrl sets the Url field's value.
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 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.
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
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 (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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(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 (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 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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateAccess
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 (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 (c *Transfer) CreateAgreement(input *CreateAgreementInput) (*CreateAgreementOutput, error)
CreateAgreement API operation for AWS Transfer Family.
Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.
The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.
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 CreateAgreement for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateAgreement
func (c *Transfer) CreateAgreementRequest(input *CreateAgreementInput) (req *request.Request, output *CreateAgreementOutput)
CreateAgreementRequest generates a "aws/request.Request" representing the client's request for the CreateAgreement 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 CreateAgreement for more information on using the CreateAgreement 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 CreateAgreementRequest method. req, resp := client.CreateAgreementRequest(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/CreateAgreement
func (c *Transfer) CreateAgreementWithContext(ctx aws.Context, input *CreateAgreementInput, opts ...request.Option) (*CreateAgreementOutput, error)
CreateAgreementWithContext is the same as CreateAgreement with the addition of the ability to pass a context and additional request options.
See CreateAgreement 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 (c *Transfer) CreateConnector(input *CreateConnectorInput) (*CreateConnectorOutput, error)
CreateConnector API operation for AWS Transfer Family.
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors (https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html) and Create SFTP connectors (https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html).
You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).
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 CreateConnector for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateConnector
func (c *Transfer) CreateConnectorRequest(input *CreateConnectorInput) (req *request.Request, output *CreateConnectorOutput)
CreateConnectorRequest generates a "aws/request.Request" representing the client's request for the CreateConnector 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 CreateConnector for more information on using the CreateConnector 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 CreateConnectorRequest method. req, resp := client.CreateConnectorRequest(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/CreateConnector
func (c *Transfer) CreateConnectorWithContext(ctx aws.Context, input *CreateConnectorInput, opts ...request.Option) (*CreateConnectorOutput, error)
CreateConnectorWithContext is the same as CreateConnector with the addition of the ability to pass a context and additional request options.
See CreateConnector 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 (c *Transfer) CreateProfile(input *CreateProfileInput) (*CreateProfileOutput, error)
CreateProfile API operation for AWS Transfer Family.
Creates the local or partner profile to use for AS2 transfers.
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 CreateProfile for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateProfile
func (c *Transfer) CreateProfileRequest(input *CreateProfileInput) (req *request.Request, output *CreateProfileOutput)
CreateProfileRequest generates a "aws/request.Request" representing the client's request for the CreateProfile 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 CreateProfile for more information on using the CreateProfile 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 CreateProfileRequest method. req, resp := client.CreateProfileRequest(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/CreateProfile
func (c *Transfer) CreateProfileWithContext(ctx aws.Context, input *CreateProfileInput, opts ...request.Option) (*CreateProfileOutput, error)
CreateProfileWithContext is the same as CreateProfile with the addition of the ability to pass a context and additional request options.
See CreateProfile 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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServer
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 (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 (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 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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUser
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 (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 (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:
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateWorkflow
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteAccess
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 (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 (c *Transfer) DeleteAgreement(input *DeleteAgreementInput) (*DeleteAgreementOutput, error)
DeleteAgreement API operation for AWS Transfer Family.
Delete the agreement that's specified in the provided AgreementId.
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 DeleteAgreement for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteAgreement
func (c *Transfer) DeleteAgreementRequest(input *DeleteAgreementInput) (req *request.Request, output *DeleteAgreementOutput)
DeleteAgreementRequest generates a "aws/request.Request" representing the client's request for the DeleteAgreement 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 DeleteAgreement for more information on using the DeleteAgreement 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 DeleteAgreementRequest method. req, resp := client.DeleteAgreementRequest(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/DeleteAgreement
func (c *Transfer) DeleteAgreementWithContext(ctx aws.Context, input *DeleteAgreementInput, opts ...request.Option) (*DeleteAgreementOutput, error)
DeleteAgreementWithContext is the same as DeleteAgreement with the addition of the ability to pass a context and additional request options.
See DeleteAgreement 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 (c *Transfer) DeleteCertificate(input *DeleteCertificateInput) (*DeleteCertificateOutput, error)
DeleteCertificate API operation for AWS Transfer Family.
Deletes the certificate that's specified in the CertificateId 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 DeleteCertificate for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteCertificate
func (c *Transfer) DeleteCertificateRequest(input *DeleteCertificateInput) (req *request.Request, output *DeleteCertificateOutput)
DeleteCertificateRequest generates a "aws/request.Request" representing the client's request for the DeleteCertificate 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 DeleteCertificate for more information on using the DeleteCertificate 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 DeleteCertificateRequest method. req, resp := client.DeleteCertificateRequest(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/DeleteCertificate
func (c *Transfer) DeleteCertificateWithContext(ctx aws.Context, input *DeleteCertificateInput, opts ...request.Option) (*DeleteCertificateOutput, error)
DeleteCertificateWithContext is the same as DeleteCertificate with the addition of the ability to pass a context and additional request options.
See DeleteCertificate 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 (c *Transfer) DeleteConnector(input *DeleteConnectorInput) (*DeleteConnectorOutput, error)
DeleteConnector API operation for AWS Transfer Family.
Deletes the connector that's specified in the provided ConnectorId.
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 DeleteConnector for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteConnector
func (c *Transfer) DeleteConnectorRequest(input *DeleteConnectorInput) (req *request.Request, output *DeleteConnectorOutput)
DeleteConnectorRequest generates a "aws/request.Request" representing the client's request for the DeleteConnector 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 DeleteConnector for more information on using the DeleteConnector 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 DeleteConnectorRequest method. req, resp := client.DeleteConnectorRequest(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/DeleteConnector
func (c *Transfer) DeleteConnectorWithContext(ctx aws.Context, input *DeleteConnectorInput, opts ...request.Option) (*DeleteConnectorOutput, error)
DeleteConnectorWithContext is the same as DeleteConnector with the addition of the ability to pass a context and additional request options.
See DeleteConnector 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 (c *Transfer) DeleteHostKey(input *DeleteHostKeyInput) (*DeleteHostKeyOutput, error)
DeleteHostKey API operation for AWS Transfer Family.
Deletes the host key that's specified in the HostKeyId 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 DeleteHostKey for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteHostKey
func (c *Transfer) DeleteHostKeyRequest(input *DeleteHostKeyInput) (req *request.Request, output *DeleteHostKeyOutput)
DeleteHostKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteHostKey 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 DeleteHostKey for more information on using the DeleteHostKey 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 DeleteHostKeyRequest method. req, resp := client.DeleteHostKeyRequest(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/DeleteHostKey
func (c *Transfer) DeleteHostKeyWithContext(ctx aws.Context, input *DeleteHostKeyInput, opts ...request.Option) (*DeleteHostKeyOutput, error)
DeleteHostKeyWithContext is the same as DeleteHostKey with the addition of the ability to pass a context and additional request options.
See DeleteHostKey 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 (c *Transfer) DeleteProfile(input *DeleteProfileInput) (*DeleteProfileOutput, error)
DeleteProfile API operation for AWS Transfer Family.
Deletes the profile that's specified in the ProfileId 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 DeleteProfile for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteProfile
func (c *Transfer) DeleteProfileRequest(input *DeleteProfileInput) (req *request.Request, output *DeleteProfileOutput)
DeleteProfileRequest generates a "aws/request.Request" representing the client's request for the DeleteProfile 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 DeleteProfile for more information on using the DeleteProfile 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 DeleteProfileRequest method. req, resp := client.DeleteProfileRequest(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/DeleteProfile
func (c *Transfer) DeleteProfileWithContext(ctx aws.Context, input *DeleteProfileInput, opts ...request.Option) (*DeleteProfileOutput, error)
DeleteProfileWithContext is the same as DeleteProfile with the addition of the ability to pass a context and additional request options.
See DeleteProfile 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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServer
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKey
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUser
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
AccessDeniedException You do not have sufficient access to perform this action.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteWorkflow
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeAccess
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 (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 (c *Transfer) DescribeAgreement(input *DescribeAgreementInput) (*DescribeAgreementOutput, error)
DescribeAgreement API operation for AWS Transfer Family.
Describes the agreement that's identified by the AgreementId.
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 DescribeAgreement for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeAgreement
func (c *Transfer) DescribeAgreementRequest(input *DescribeAgreementInput) (req *request.Request, output *DescribeAgreementOutput)
DescribeAgreementRequest generates a "aws/request.Request" representing the client's request for the DescribeAgreement 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 DescribeAgreement for more information on using the DescribeAgreement 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 DescribeAgreementRequest method. req, resp := client.DescribeAgreementRequest(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/DescribeAgreement
func (c *Transfer) DescribeAgreementWithContext(ctx aws.Context, input *DescribeAgreementInput, opts ...request.Option) (*DescribeAgreementOutput, error)
DescribeAgreementWithContext is the same as DescribeAgreement with the addition of the ability to pass a context and additional request options.
See DescribeAgreement 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 (c *Transfer) DescribeCertificate(input *DescribeCertificateInput) (*DescribeCertificateOutput, error)
DescribeCertificate API operation for AWS Transfer Family.
Describes the certificate that's identified by the CertificateId.
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 DescribeCertificate for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeCertificate
func (c *Transfer) DescribeCertificateRequest(input *DescribeCertificateInput) (req *request.Request, output *DescribeCertificateOutput)
DescribeCertificateRequest generates a "aws/request.Request" representing the client's request for the DescribeCertificate 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 DescribeCertificate for more information on using the DescribeCertificate 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 DescribeCertificateRequest method. req, resp := client.DescribeCertificateRequest(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/DescribeCertificate
func (c *Transfer) DescribeCertificateWithContext(ctx aws.Context, input *DescribeCertificateInput, opts ...request.Option) (*DescribeCertificateOutput, error)
DescribeCertificateWithContext is the same as DescribeCertificate with the addition of the ability to pass a context and additional request options.
See DescribeCertificate 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 (c *Transfer) DescribeConnector(input *DescribeConnectorInput) (*DescribeConnectorOutput, error)
DescribeConnector API operation for AWS Transfer Family.
Describes the connector that's identified by the ConnectorId.
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 DescribeConnector for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeConnector
func (c *Transfer) DescribeConnectorRequest(input *DescribeConnectorInput) (req *request.Request, output *DescribeConnectorOutput)
DescribeConnectorRequest generates a "aws/request.Request" representing the client's request for the DescribeConnector 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 DescribeConnector for more information on using the DescribeConnector 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 DescribeConnectorRequest method. req, resp := client.DescribeConnectorRequest(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/DescribeConnector
func (c *Transfer) DescribeConnectorWithContext(ctx aws.Context, input *DescribeConnectorInput, opts ...request.Option) (*DescribeConnectorOutput, error)
DescribeConnectorWithContext is the same as DescribeConnector with the addition of the ability to pass a context and additional request options.
See DescribeConnector 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 (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.
This API call only returns details for in-progress workflows.
If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.
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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeExecution
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 (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 (c *Transfer) DescribeHostKey(input *DescribeHostKeyInput) (*DescribeHostKeyOutput, error)
DescribeHostKey API operation for AWS Transfer Family.
Returns the details of the host key that's specified by the HostKeyId and ServerId.
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 DescribeHostKey for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeHostKey
func (c *Transfer) DescribeHostKeyRequest(input *DescribeHostKeyInput) (req *request.Request, output *DescribeHostKeyOutput)
DescribeHostKeyRequest generates a "aws/request.Request" representing the client's request for the DescribeHostKey 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 DescribeHostKey for more information on using the DescribeHostKey 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 DescribeHostKeyRequest method. req, resp := client.DescribeHostKeyRequest(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/DescribeHostKey
func (c *Transfer) DescribeHostKeyWithContext(ctx aws.Context, input *DescribeHostKeyInput, opts ...request.Option) (*DescribeHostKeyOutput, error)
DescribeHostKeyWithContext is the same as DescribeHostKey with the addition of the ability to pass a context and additional request options.
See DescribeHostKey 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 (c *Transfer) DescribeProfile(input *DescribeProfileInput) (*DescribeProfileOutput, error)
DescribeProfile API operation for AWS Transfer Family.
Returns the details of the profile that's specified by the ProfileId.
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 DescribeProfile for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeProfile
func (c *Transfer) DescribeProfileRequest(input *DescribeProfileInput) (req *request.Request, output *DescribeProfileOutput)
DescribeProfileRequest generates a "aws/request.Request" representing the client's request for the DescribeProfile 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 DescribeProfile for more information on using the DescribeProfile 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 DescribeProfileRequest method. req, resp := client.DescribeProfileRequest(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/DescribeProfile
func (c *Transfer) DescribeProfileWithContext(ctx aws.Context, input *DescribeProfileInput, opts ...request.Option) (*DescribeProfileOutput, error)
DescribeProfileWithContext is the same as DescribeProfile with the addition of the ability to pass a context and additional request options.
See DescribeProfile 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 (c *Transfer) DescribeSecurityPolicy(input *DescribeSecurityPolicyInput) (*DescribeSecurityPolicyOutput, error)
DescribeSecurityPolicy API operation for AWS Transfer Family.
Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) or Working with security policies for SFTP connectors (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeSecurityPolicy
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUser
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeWorkflow
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 (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 (c *Transfer) ImportCertificate(input *ImportCertificateInput) (*ImportCertificateOutput, error)
ImportCertificate API operation for AWS Transfer Family.
Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.
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 ImportCertificate for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportCertificate
func (c *Transfer) ImportCertificateRequest(input *ImportCertificateInput) (req *request.Request, output *ImportCertificateOutput)
ImportCertificateRequest generates a "aws/request.Request" representing the client's request for the ImportCertificate 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 ImportCertificate for more information on using the ImportCertificate 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 ImportCertificateRequest method. req, resp := client.ImportCertificateRequest(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/ImportCertificate
func (c *Transfer) ImportCertificateWithContext(ctx aws.Context, input *ImportCertificateInput, opts ...request.Option) (*ImportCertificateOutput, error)
ImportCertificateWithContext is the same as ImportCertificate with the addition of the ability to pass a context and additional request options.
See ImportCertificate 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 (c *Transfer) ImportHostKey(input *ImportHostKeyInput) (*ImportHostKeyOutput, error)
ImportHostKey API operation for AWS Transfer Family.
Adds a host key to the server that's specified by 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 ImportHostKey for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportHostKey
func (c *Transfer) ImportHostKeyRequest(input *ImportHostKeyInput) (req *request.Request, output *ImportHostKeyOutput)
ImportHostKeyRequest generates a "aws/request.Request" representing the client's request for the ImportHostKey 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 ImportHostKey for more information on using the ImportHostKey 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 ImportHostKeyRequest method. req, resp := client.ImportHostKeyRequest(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/ImportHostKey
func (c *Transfer) ImportHostKeyWithContext(ctx aws.Context, input *ImportHostKeyInput, opts ...request.Option) (*ImportHostKeyOutput, error)
ImportHostKeyWithContext is the same as ImportHostKey with the addition of the ability to pass a context and additional request options.
See ImportHostKey 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 (c *Transfer) ImportSshPublicKey(input *ImportSshPublicKeyInput) (*ImportSshPublicKeyOutput, error)
ImportSshPublicKey API operation for AWS Transfer Family.
Adds a Secure Shell (SSH) public key to a Transfer Family user 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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
ThrottlingException The request was denied due to request throttling.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ResourceExistsException The requested resource does not exist, or exists in a region other than the one specified for the command.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKey
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 (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 (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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InvalidNextTokenException The NextToken parameter that was passed is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListAccesses
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 (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 (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 (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 (c *Transfer) ListAgreements(input *ListAgreementsInput) (*ListAgreementsOutput, error)
ListAgreements API operation for AWS Transfer Family.
Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.
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 ListAgreements for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InvalidNextTokenException The NextToken parameter that was passed is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListAgreements
func (c *Transfer) ListAgreementsPages(input *ListAgreementsInput, fn func(*ListAgreementsOutput, bool) bool) error
ListAgreementsPages iterates over the pages of a ListAgreements operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListAgreements 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 ListAgreements operation. pageNum := 0 err := client.ListAgreementsPages(params, func(page *transfer.ListAgreementsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Transfer) ListAgreementsPagesWithContext(ctx aws.Context, input *ListAgreementsInput, fn func(*ListAgreementsOutput, bool) bool, opts ...request.Option) error
ListAgreementsPagesWithContext same as ListAgreementsPages 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 (c *Transfer) ListAgreementsRequest(input *ListAgreementsInput) (req *request.Request, output *ListAgreementsOutput)
ListAgreementsRequest generates a "aws/request.Request" representing the client's request for the ListAgreements 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 ListAgreements for more information on using the ListAgreements 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 ListAgreementsRequest method. req, resp := client.ListAgreementsRequest(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/ListAgreements
func (c *Transfer) ListAgreementsWithContext(ctx aws.Context, input *ListAgreementsInput, opts ...request.Option) (*ListAgreementsOutput, error)
ListAgreementsWithContext is the same as ListAgreements with the addition of the ability to pass a context and additional request options.
See ListAgreements 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 (c *Transfer) ListCertificates(input *ListCertificatesInput) (*ListCertificatesOutput, error)
ListCertificates API operation for AWS Transfer Family.
Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.
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 ListCertificates for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InvalidNextTokenException The NextToken parameter that was passed is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListCertificates
func (c *Transfer) ListCertificatesPages(input *ListCertificatesInput, fn func(*ListCertificatesOutput, bool) bool) error
ListCertificatesPages iterates over the pages of a ListCertificates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListCertificates 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 ListCertificates operation. pageNum := 0 err := client.ListCertificatesPages(params, func(page *transfer.ListCertificatesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Transfer) ListCertificatesPagesWithContext(ctx aws.Context, input *ListCertificatesInput, fn func(*ListCertificatesOutput, bool) bool, opts ...request.Option) error
ListCertificatesPagesWithContext same as ListCertificatesPages 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 (c *Transfer) ListCertificatesRequest(input *ListCertificatesInput) (req *request.Request, output *ListCertificatesOutput)
ListCertificatesRequest generates a "aws/request.Request" representing the client's request for the ListCertificates 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 ListCertificates for more information on using the ListCertificates 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 ListCertificatesRequest method. req, resp := client.ListCertificatesRequest(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/ListCertificates
func (c *Transfer) ListCertificatesWithContext(ctx aws.Context, input *ListCertificatesInput, opts ...request.Option) (*ListCertificatesOutput, error)
ListCertificatesWithContext is the same as ListCertificates with the addition of the ability to pass a context and additional request options.
See ListCertificates 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 (c *Transfer) ListConnectors(input *ListConnectorsInput) (*ListConnectorsOutput, error)
ListConnectors API operation for AWS Transfer Family.
Lists the connectors for the specified Region.
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 ListConnectors for usage and error information.
Returned Error Types:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InvalidNextTokenException The NextToken parameter that was passed is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListConnectors
func (c *Transfer) ListConnectorsPages(input *ListConnectorsInput, fn func(*ListConnectorsOutput, bool) bool) error
ListConnectorsPages iterates over the pages of a ListConnectors operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListConnectors 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 ListConnectors operation. pageNum := 0 err := client.ListConnectorsPages(params, func(page *transfer.ListConnectorsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Transfer) ListConnectorsPagesWithContext(ctx aws.Context, input *ListConnectorsInput, fn func(*ListConnectorsOutput, bool) bool, opts ...request.Option) error
ListConnectorsPagesWithContext same as ListConnectorsPages 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 (c *Transfer) ListConnectorsRequest(input *ListConnectorsInput) (req *request.Request, output *ListConnectorsOutput)
ListConnectorsRequest generates a "aws/request.Request" representing the client's request for the ListConnectors 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 ListConnectors for more information on using the ListConnectors 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 ListConnectorsRequest method. req, resp := client.ListConnectorsRequest(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/ListConnectors
func (c *Transfer) ListConnectorsWithContext(ctx aws.Context, input *ListConnectorsInput, opts ...request.Option) (*ListConnectorsOutput, error)
ListConnectorsWithContext is the same as ListConnectors with the addition of the ability to pass a context and additional request options.
See ListConnectors 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 (c *Transfer) ListExecutions(input *ListExecutionsInput) (*ListExecutionsOutput, error)
ListExecutions API operation for AWS Transfer Family.
Lists all in-progress executions for the specified workflow.
If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.
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:
ResourceNotFoundException This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
InvalidRequestException This exception is thrown when the client submits a malformed request.
InternalServiceError This exception is thrown when an error occurs in the Transfer Family service.
ServiceUnavailableException The request has failed because the Amazon Web ServicesTransfer Family service is not available.
InvalidNextTokenException The NextToken parameter that was passed is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListExecutions
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 (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.