package types
import "github.com/aws/aws-sdk-go-v2/service/transfer/types"
Index ¶
- type AccessDeniedException
- func (e *AccessDeniedException) Error() string
- func (e *AccessDeniedException) ErrorCode() string
- func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
- func (e *AccessDeniedException) ErrorMessage() string
- type AgreementStatusType
- type As2ConnectorConfig
- type As2Transport
- type CertificateStatusType
- type CertificateType
- type CertificateUsageType
- type CompressionEnum
- type ConflictException
- func (e *ConflictException) Error() string
- func (e *ConflictException) ErrorCode() string
- func (e *ConflictException) ErrorFault() smithy.ErrorFault
- func (e *ConflictException) ErrorMessage() string
- type ConnectorFileTransferResult
- type CopyStepDetails
- type CustomDirectoriesType
- type CustomStepDetails
- type CustomStepStatus
- type DecryptStepDetails
- type DeleteStepDetails
- type DescribedAccess
- type DescribedAgreement
- type DescribedCertificate
- type DescribedConnector
- type DescribedExecution
- type DescribedHostKey
- type DescribedIdentityCenterConfig
- type DescribedProfile
- type DescribedSecurityPolicy
- type DescribedServer
- type DescribedUser
- type DescribedWebApp
- type DescribedWebAppCustomization
- type DescribedWebAppIdentityProviderDetails
- type DescribedWebAppIdentityProviderDetailsMemberIdentityCenterConfig
- type DescribedWorkflow
- type DirectoryListingOptimization
- type Domain
- type EfsFileLocation
- type EncryptionAlg
- type EncryptionType
- type EndpointDetails
- type EndpointType
- type EnforceMessageSigningType
- type ExecutionError
- type ExecutionErrorType
- type ExecutionResults
- type ExecutionStatus
- type ExecutionStepResult
- type FileLocation
- type HomeDirectoryMapEntry
- type HomeDirectoryType
- type IdentityCenterConfig
- type IdentityProviderDetails
- type IdentityProviderType
- type InputFileLocation
- type InternalServiceError
- func (e *InternalServiceError) Error() string
- func (e *InternalServiceError) ErrorCode() string
- func (e *InternalServiceError) ErrorFault() smithy.ErrorFault
- func (e *InternalServiceError) ErrorMessage() string
- type InvalidNextTokenException
- func (e *InvalidNextTokenException) Error() string
- func (e *InvalidNextTokenException) ErrorCode() string
- func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault
- func (e *InvalidNextTokenException) ErrorMessage() string
- type InvalidRequestException
- func (e *InvalidRequestException) Error() string
- func (e *InvalidRequestException) ErrorCode() string
- func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
- func (e *InvalidRequestException) ErrorMessage() string
- type ListedAccess
- type ListedAgreement
- type ListedCertificate
- type ListedConnector
- type ListedExecution
- type ListedHostKey
- type ListedProfile
- type ListedServer
- type ListedUser
- type ListedWebApp
- type ListedWorkflow
- type LoggingConfiguration
- type MapType
- type MdnResponse
- type MdnSigningAlg
- type OverwriteExisting
- type PosixProfile
- type PreserveContentType
- type PreserveFilenameType
- type ProfileType
- type Protocol
- type ProtocolDetails
- type ResourceExistsException
- func (e *ResourceExistsException) Error() string
- func (e *ResourceExistsException) ErrorCode() string
- func (e *ResourceExistsException) ErrorFault() smithy.ErrorFault
- func (e *ResourceExistsException) ErrorMessage() string
- type ResourceNotFoundException
- func (e *ResourceNotFoundException) Error() string
- func (e *ResourceNotFoundException) ErrorCode() string
- func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *ResourceNotFoundException) ErrorMessage() string
- type S3FileLocation
- type S3InputFileLocation
- type S3StorageOptions
- type S3Tag
- type SecurityPolicyProtocol
- type SecurityPolicyResourceType
- type ServiceMetadata
- type ServiceUnavailableException
- func (e *ServiceUnavailableException) Error() string
- func (e *ServiceUnavailableException) ErrorCode() string
- func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault
- func (e *ServiceUnavailableException) ErrorMessage() string
- type SetStatOption
- type SftpAuthenticationMethods
- type SftpConnectorConfig
- type SftpConnectorConnectionDetails
- type SigningAlg
- type SshPublicKey
- type State
- type Tag
- type TagStepDetails
- type ThrottlingException
- func (e *ThrottlingException) Error() string
- func (e *ThrottlingException) ErrorCode() string
- func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
- func (e *ThrottlingException) ErrorMessage() string
- type TlsSessionResumptionMode
- type TransferTableStatus
- type UnknownUnionMember
- type UpdateWebAppIdentityCenterConfig
- type UpdateWebAppIdentityProviderDetails
- type UpdateWebAppIdentityProviderDetailsMemberIdentityCenterConfig
- type UserDetails
- type WebAppEndpointPolicy
- type WebAppIdentityProviderDetails
- type WebAppIdentityProviderDetailsMemberIdentityCenterConfig
- type WebAppUnits
- type WebAppUnitsMemberProvisioned
- type WorkflowDetail
- type WorkflowDetails
- type WorkflowStep
- type WorkflowStepType
Examples ¶
- DescribedWebAppIdentityProviderDetails (OutputUsage)
- UpdateWebAppIdentityProviderDetails (OutputUsage)
- WebAppIdentityProviderDetails (OutputUsage)
- WebAppUnits (OutputUsage)
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You do not have sufficient access to perform this action.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type AgreementStatusType ¶
type AgreementStatusType string
const ( AgreementStatusTypeActive AgreementStatusType = "ACTIVE" AgreementStatusTypeInactive AgreementStatusType = "INACTIVE" )
Enum values for AgreementStatusType
func (AgreementStatusType) Values ¶
func (AgreementStatusType) Values() []AgreementStatusType
Values returns all known values for AgreementStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type As2ConnectorConfig ¶
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 // Specifies whether the AS2 file is compressed. Compression 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 EncryptionAlg // A unique identifier for the AS2 local profile. LocalProfileId *string // Used for outbound requests (from an Transfer Family connector 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 MdnResponse // The signing algorithm for the MDN response. // // If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used. MdnSigningAlgorithm MdnSigningAlg // Used as the Subject HTTP header attribute in AS2 messages that are being sent // with the connector. MessageSubject *string // A unique identifier for the partner profile for the connector. PartnerProfileId *string // Allows you to use the Amazon S3 Content-Type that is associated with objects in // S3 instead of having the content type mapped based on the file extension. This // parameter is enabled by default when you create an AS2 connector from the // console, but disabled by default when you create an AS2 connector by calling the // API directly. PreserveContentType PreserveContentType // The algorithm that is used to sign the AS2 messages sent with the connector. SigningAlgorithm 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.
type As2Transport ¶
type As2Transport string
const ( As2TransportHttp As2Transport = "HTTP" )
Enum values for As2Transport
func (As2Transport) Values ¶
func (As2Transport) Values() []As2Transport
Values returns all known values for As2Transport. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type CertificateStatusType ¶
type CertificateStatusType string
const ( CertificateStatusTypeActive CertificateStatusType = "ACTIVE" CertificateStatusTypePendingRotation CertificateStatusType = "PENDING_ROTATION" CertificateStatusTypeInactive CertificateStatusType = "INACTIVE" )
Enum values for CertificateStatusType
func (CertificateStatusType) Values ¶
func (CertificateStatusType) Values() []CertificateStatusType
Values returns all known values for CertificateStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type CertificateType ¶
type CertificateType string
const ( CertificateTypeCertificate CertificateType = "CERTIFICATE" CertificateTypeCertificateWithPrivateKey CertificateType = "CERTIFICATE_WITH_PRIVATE_KEY" )
Enum values for CertificateType
func (CertificateType) Values ¶
func (CertificateType) Values() []CertificateType
Values returns all known values for CertificateType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type CertificateUsageType ¶
type CertificateUsageType string
const ( CertificateUsageTypeSigning CertificateUsageType = "SIGNING" CertificateUsageTypeEncryption CertificateUsageType = "ENCRYPTION" CertificateUsageTypeTls CertificateUsageType = "TLS" )
Enum values for CertificateUsageType
func (CertificateUsageType) Values ¶
func (CertificateUsageType) Values() []CertificateUsageType
Values returns all known values for CertificateUsageType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type CompressionEnum ¶
type CompressionEnum string
const ( CompressionEnumZlib CompressionEnum = "ZLIB" CompressionEnumDisabled CompressionEnum = "DISABLED" )
Enum values for CompressionEnum
func (CompressionEnum) Values ¶
func (CompressionEnum) Values() []CompressionEnum
Values returns all known values for CompressionEnum. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type ConnectorFileTransferResult ¶
type ConnectorFileTransferResult struct { // The filename and path to where the file was sent to or retrieved from. // // This member is required. FilePath *string // The current status for the transfer. // // This member is required. StatusCode TransferTableStatus // For transfers that fail, this parameter contains a code indicating the reason. // For example, RETRIEVE_FILE_NOT_FOUND FailureCode *string // For transfers that fail, this parameter describes the reason for the failure. FailureMessage *string // contains filtered or unexported fields }
A structure that contains the details for files transferred using an SFTP connector, during a single transfer.
type CopyStepDetails ¶
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 // The name of the step, used as an identifier. Name *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 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 // contains filtered or unexported fields }
Each step type has its own StepDetails structure.
type CustomDirectoriesType ¶
type CustomDirectoriesType struct { // Specifies a location to store failed AS2 message files. // // This member is required. FailedFilesDirectory *string // Specifies a location to store MDN files. // // This member is required. MdnFilesDirectory *string // Specifies a location to store the payload for AS2 message files. // // This member is required. PayloadFilesDirectory *string // Specifies a location to store AS2 status messages. // // This member is required. StatusFilesDirectory *string // Specifies a location to store temporary AS2 message files. // // This member is required. TemporaryFilesDirectory *string // contains filtered or unexported fields }
Contains Amazon S3 locations for storing specific types of AS2 message files.
type CustomStepDetails ¶
type CustomStepDetails struct { // The name of the step, used as an identifier. Name *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 // The ARN for the Lambda function that is being called. Target *string // Timeout, in seconds, for the step. TimeoutSeconds *int32 // contains filtered or unexported fields }
Each step type has its own StepDetails structure.
type CustomStepStatus ¶
type CustomStepStatus string
const ( CustomStepStatusSuccess CustomStepStatus = "SUCCESS" CustomStepStatusFailure CustomStepStatus = "FAILURE" )
Enum values for CustomStepStatus
func (CustomStepStatus) Values ¶
func (CustomStepStatus) Values() []CustomStepStatus
Values returns all known values for CustomStepStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DecryptStepDetails ¶
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. // // This member is required. DestinationFileLocation *InputFileLocation // The type of encryption used. Currently, this value must be PGP . // // This member is required. Type EncryptionType // The name of the step, used as an identifier. Name *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 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 // contains filtered or unexported fields }
Each step type has its own StepDetails structure.
type DeleteStepDetails ¶
type DeleteStepDetails struct { // The name of the step, used as an identifier. Name *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 // contains filtered or unexported fields }
The name of the step, used to identify the delete step.
type DescribedAccess ¶
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 // 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 // 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 // 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 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 // 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 // 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 // contains filtered or unexported fields }
Describes the properties of the access that was specified.
type DescribedAgreement ¶
type DescribedAgreement struct { // The unique Amazon Resource Name (ARN) for the agreement. // // This member is required. Arn *string // 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 // A unique identifier for the agreement. This identifier is returned when you // create an agreement. AgreementId *string // The landing directory (folder) for files that are transferred by using the AS2 // protocol. BaseDirectory *string // A CustomDirectoriesType structure. This structure specifies custom directories // for storing various AS2 message files. You can specify directories for the // following types of files. // // - Failed files // // - MDN files // // - Payload files // // - Status files // // - Temporary files CustomDirectories *CustomDirectoriesType // The name or short description that's used to identify the agreement. Description *string // Determines whether or not unsigned messages from your trading partners will be // accepted. // // - ENABLED : Transfer Family rejects unsigned messages from your trading // partner. // // - DISABLED (default value): Transfer Family accepts unsigned messages from // your trading partner. EnforceMessageSigning EnforceMessageSigningType // A unique identifier for the AS2 local profile. LocalProfileId *string // A unique identifier for the partner profile used in the agreement. PartnerProfileId *string // Determines whether or not Transfer Family appends a unique string of // characters to the end of the AS2 message payload filename when saving it. // // - ENABLED : the filename provided by your trading parter is preserved when the // file is saved. // // - DISABLED (default value): when Transfer Family saves the file, the filename // is adjusted, as described in [File names and locations]. // // [File names and locations]: https://docs.aws.amazon.com/transfer/latest/userguide/send-as2-messages.html#file-names-as2 PreserveFilename PreserveFilenameType // A system-assigned unique identifier for a server instance. This identifier // indicates the specific server that the agreement uses. ServerId *string // The current status of the agreement, either ACTIVE or INACTIVE . Status AgreementStatusType // Key-value pairs that can be used to group and search for agreements. Tags []Tag // contains filtered or unexported fields }
Describes the properties of an agreement.
type DescribedCertificate ¶
type DescribedCertificate struct { // The unique Amazon Resource Name (ARN) for the certificate. // // This member is required. Arn *string // An optional date that specifies when the certificate becomes active. If you do // not specify a value, ActiveDate takes the same value as NotBeforeDate , which is // specified by the CA. ActiveDate *time.Time // The file name for the certificate. Certificate *string // The list of certificates that make up the chain for the certificate. CertificateChain *string // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. CertificateId *string // The name or description that's used to identity the certificate. Description *string // An optional date that specifies when the certificate becomes inactive. If you // do not specify a value, InactiveDate takes the same value as NotAfterDate , // which is specified by the CA. InactiveDate *time.Time // The final date that the certificate is valid. NotAfterDate *time.Time // The earliest date that the certificate is valid. NotBeforeDate *time.Time // The serial number for the certificate. Serial *string // A certificate's status can be either ACTIVE or INACTIVE . // // You can set ActiveDate and InactiveDate in the UpdateCertificate call. If you // set values for these parameters, those values are used to determine whether the // certificate has a status of ACTIVE or INACTIVE . // // If you don't set values for ActiveDate and InactiveDate , we use the NotBefore // and NotAfter date as specified on the X509 certificate to determine when a // certificate is active and when it is inactive. Status CertificateStatusType // Key-value pairs that can be used to group and search for certificates. Tags []Tag // 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 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 CertificateUsageType // contains filtered or unexported fields }
Describes the properties of a certificate.
type DescribedConnector ¶
type DescribedConnector struct { // The unique Amazon Resource Name (ARN) for the connector. // // This member is required. Arn *string // 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 // A structure that contains the parameters for an AS2 connector object. As2Config *As2ConnectorConfig // The unique identifier for the connector. ConnectorId *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 // The text name of the security policy for the specified connector. SecurityPolicyName *string // The list of egress IP addresses of this connector. These IP addresses are // assigned automatically when you create the connector. ServiceManagedEgressIpAddresses []string // A structure that contains the parameters for an SFTP connector object. SftpConfig *SftpConnectorConfig // Key-value pairs that can be used to group and search for connectors. Tags []Tag // The URL of the partner's AS2 or SFTP endpoint. Url *string // contains filtered or unexported fields }
Describes the parameters for the connector, as identified by the ConnectorId .
type DescribedExecution ¶
type DescribedExecution struct { // A unique identifier for the execution of a workflow. ExecutionId *string // The IAM role associated with the execution. ExecutionRole *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 // The IAM logging role associated with the execution. LoggingConfiguration *LoggingConfiguration // 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 // 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 // A container object for the session details that are associated with a workflow. ServiceMetadata *ServiceMetadata // The status is one of the execution. Can be in progress, completed, exception // encountered, or handling the exception. Status ExecutionStatus // contains filtered or unexported fields }
The details for an execution object.
type DescribedHostKey ¶
type DescribedHostKey struct { // The unique Amazon Resource Name (ARN) for the host key. // // This member is required. Arn *string // The date on which the host key was added to the server. DateImported *time.Time // The text description for this host key. Description *string // The public key fingerprint, which is a short sequence of bytes used to identify // the longer public key. HostKeyFingerprint *string // A unique identifier for the host key. HostKeyId *string // Key-value pairs that can be used to group and search for host keys. Tags []Tag // 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 // contains filtered or unexported fields }
The details for a server host key.
type DescribedIdentityCenterConfig ¶
type DescribedIdentityCenterConfig struct { // The Amazon Resource Name (ARN) for the IAM Identity Center application: this // value is set automatically when you create your web app. ApplicationArn *string // The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app. InstanceArn *string // The IAM role in IAM Identity Center used for the web app. Role *string // contains filtered or unexported fields }
A structure that contains the details of the IAM Identity Center used for your web app. Returned during a call to DescribeWebApp .
type DescribedProfile ¶
type DescribedProfile struct { // The unique Amazon Resource Name (ARN) for the profile. // // This member is required. Arn *string // The As2Id is the AS2-name, as defined in the [RFC 4130]. 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. // // [RFC 4130]: https://datatracker.ietf.org/doc/html/rfc4130 As2Id *string // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. CertificateIds []string // A unique identifier for the local or partner AS2 profile. ProfileId *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 ProfileType // Key-value pairs that can be used to group and search for profiles. Tags []Tag // contains filtered or unexported fields }
The details for a local or partner AS2 profile.
type DescribedSecurityPolicy ¶
type DescribedSecurityPolicy struct { // The text name of the specified security policy. // // This member is required. SecurityPolicyName *string // Specifies whether this policy enables Federal Information Processing Standards // (FIPS). This parameter applies to both server and connector security policies. Fips *bool // Lists the file transfer protocols that the security policy applies to. Protocols []SecurityPolicyProtocol // 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 // Lists the host key algorithms for the security policy. // // This parameter only applies to security policies for connectors. SshHostKeyAlgorithms []string // 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 // 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 // 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 // The resource type to which the security policy applies, either server or // connector. Type 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 serversor Working with security policies for SFTP connectors.
type DescribedServer ¶
type DescribedServer struct { // Specifies the unique Amazon Resource Name (ARN) of the server. // // This member is required. Arn *string // 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 // Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) // certificate. Required when Protocols is set to FTPS . Certificate *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 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 // 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 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 // 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 // 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 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 EFS events. When set, you can view user activity in your CloudWatch logs. LoggingRole *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 // 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 // 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 // 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 []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 // Specifies the name of the security policy for the server. SecurityPolicyName *string // Specifies the unique system-assigned identifier for a server that you // instantiate. ServerId *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 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 // 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 // Specifies the number of users that are assigned to a server you specified with // the ServerId . UserCount *int32 // 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 // contains filtered or unexported fields }
Describes the properties of a file transfer protocol-enabled server that was specified.
type DescribedUser ¶
type DescribedUser struct { // Specifies the unique Amazon Resource Name (ARN) for the user that was requested // to be described. // // This member is required. Arn *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 // 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 // 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 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 // 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 // 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 // Specifies the public key portion of the Secure Shell (SSH) keys stored for the // described user. // // To delete the public key body, set its value to zero keys, as shown here: // // SshPublicKeys: [] SshPublicKeys []SshPublicKey // 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 // 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 // contains filtered or unexported fields }
Describes the properties of a user that was specified.
type DescribedWebApp ¶
type DescribedWebApp struct { // The Amazon Resource Name (ARN) of the web app. // // This member is required. Arn *string // The unique identifier for the web app. // // This member is required. WebAppId *string // The AccessEndpoint is the URL that you provide to your users for them to // interact with the Transfer Family web app. You can specify a custom URL or use // the default value. AccessEndpoint *string // A structure that contains the details for the identity provider used by the web // app. DescribedIdentityProviderDetails DescribedWebAppIdentityProviderDetails // Key-value pairs that can be used to group and search for web apps. Tags are // metadata attached to web apps for any purpose. Tags []Tag // The WebAppEndpoint is the unique URL for your Transfer Family web app. This is // the value that you use when you configure Origins on CloudFront. WebAppEndpoint *string // Setting for the type of endpoint policy for the web app. The default value is // STANDARD . // // If your web app was created in an Amazon Web Services GovCloud (US) Region, the // value of this parameter can be FIPS , which indicates the web app endpoint is // FIPS-compliant. WebAppEndpointPolicy WebAppEndpointPolicy // A union that contains the value for number of concurrent connections or the // user sessions on your web app. WebAppUnits WebAppUnits // contains filtered or unexported fields }
A structure that describes the parameters for the web app, as identified by the WebAppId .
type DescribedWebAppCustomization ¶
type DescribedWebAppCustomization struct { // Returns the Amazon Resource Name (ARN) for the web app. // // This member is required. Arn *string // Returns the unique identifier for your web app. // // This member is required. WebAppId *string // Returns an icon file data string (in base64 encoding). FaviconFile []byte // Returns a logo file data string (in base64 encoding). LogoFile []byte // Returns the page title that you defined for your web app. Title *string // contains filtered or unexported fields }
A structure that contains the customization fields for the web app. You can provide a title, logo, and icon to customize the appearance of your web app.
type DescribedWebAppIdentityProviderDetails ¶
type DescribedWebAppIdentityProviderDetails interface {
// contains filtered or unexported methods
}
Returns a structure that contains the identity provider details for your web app.
The following types satisfy this interface:
DescribedWebAppIdentityProviderDetailsMemberIdentityCenterConfig
Example (OutputUsage)¶
Code:play
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/transfer/types" ) func main() { var union types.DescribedWebAppIdentityProviderDetails // type switches can be used to check the union value switch v := union.(type) { case *types.DescribedWebAppIdentityProviderDetailsMemberIdentityCenterConfig: _ = v.Value // Value is types.DescribedIdentityCenterConfig case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
type DescribedWebAppIdentityProviderDetailsMemberIdentityCenterConfig ¶
type DescribedWebAppIdentityProviderDetailsMemberIdentityCenterConfig struct { Value DescribedIdentityCenterConfig // contains filtered or unexported fields }
Returns a structure for your identity provider details. This structure contains the instance ARN and role being used for the web app.
type DescribedWorkflow ¶
type DescribedWorkflow struct { // Specifies the unique Amazon Resource Name (ARN) for the workflow. // // This member is required. Arn *string // Specifies the text description for the workflow. Description *string // Specifies the steps (actions) to take if errors are encountered during // execution of the workflow. OnExceptionSteps []WorkflowStep // Specifies the details for the steps that are in the specified workflow. Steps []WorkflowStep // Key-value pairs that can be used to group and search for workflows. Tags are // metadata attached to workflows for any purpose. Tags []Tag // A unique identifier for the workflow. WorkflowId *string // contains filtered or unexported fields }
Describes the properties of the specified workflow
type DirectoryListingOptimization ¶
type DirectoryListingOptimization string
const ( DirectoryListingOptimizationEnabled DirectoryListingOptimization = "ENABLED" DirectoryListingOptimizationDisabled DirectoryListingOptimization = "DISABLED" )
Enum values for DirectoryListingOptimization
func (DirectoryListingOptimization) Values ¶
func (DirectoryListingOptimization) Values() []DirectoryListingOptimization
Values returns all known values for DirectoryListingOptimization. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Domain ¶
type Domain string
Enum values for Domain
func (Domain) Values ¶
Values returns all known values for Domain. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EfsFileLocation ¶
type EfsFileLocation struct { // The identifier of the file system, assigned by Amazon EFS. FileSystemId *string // The pathname for the folder being used by a workflow. Path *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.
type EncryptionAlg ¶
type EncryptionAlg string
const ( EncryptionAlgAes128Cbc EncryptionAlg = "AES128_CBC" EncryptionAlgAes192Cbc EncryptionAlg = "AES192_CBC" EncryptionAlgAes256Cbc EncryptionAlg = "AES256_CBC" EncryptionAlgDesEde3Cbc EncryptionAlg = "DES_EDE3_CBC" EncryptionAlgNone EncryptionAlg = "NONE" )
Enum values for EncryptionAlg
func (EncryptionAlg) Values ¶
func (EncryptionAlg) Values() []EncryptionAlg
Values returns all known values for EncryptionAlg. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EncryptionType ¶
type EncryptionType string
const ( EncryptionTypePgp EncryptionType = "PGP" )
Enum values for EncryptionType
func (EncryptionType) Values ¶
func (EncryptionType) Values() []EncryptionType
Values returns all known values for EncryptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EndpointDetails ¶
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]data type. One way to retrieve this value is by calling the EC2 [DescribeAddresses] 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]. // // 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. // // [Address]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html // [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 // [DescribeAddresses]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html AddressAllocationIds []string // 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] 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] // API. // // [UpdateServer]: https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html // [ModifyVpcEndpoint]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html SecurityGroupIds []string // 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 // 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 // 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 // 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 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 .
type EndpointType ¶
type EndpointType string
const ( EndpointTypePublic EndpointType = "PUBLIC" EndpointTypeVpc EndpointType = "VPC" EndpointTypeVpcEndpoint EndpointType = "VPC_ENDPOINT" )
Enum values for EndpointType
func (EndpointType) Values ¶
func (EndpointType) Values() []EndpointType
Values returns all known values for EndpointType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EnforceMessageSigningType ¶
type EnforceMessageSigningType string
const ( EnforceMessageSigningTypeEnabled EnforceMessageSigningType = "ENABLED" EnforceMessageSigningTypeDisabled EnforceMessageSigningType = "DISABLED" )
Enum values for EnforceMessageSigningType
func (EnforceMessageSigningType) Values ¶
func (EnforceMessageSigningType) Values() []EnforceMessageSigningType
Values returns all known values for EnforceMessageSigningType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ExecutionError ¶
type ExecutionError struct { // Specifies the descriptive message that corresponds to the ErrorType . // // This member is required. Message *string // 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. // // This member is required. Type ExecutionErrorType // contains filtered or unexported fields }
Specifies the error message and type, for an error that occurs during the execution of the workflow.
type ExecutionErrorType ¶
type ExecutionErrorType string
const ( ExecutionErrorTypePermissionDenied ExecutionErrorType = "PERMISSION_DENIED" ExecutionErrorTypeCustomStepFailed ExecutionErrorType = "CUSTOM_STEP_FAILED" ExecutionErrorTypeThrottled ExecutionErrorType = "THROTTLED" ExecutionErrorTypeAlreadyExists ExecutionErrorType = "ALREADY_EXISTS" ExecutionErrorTypeNotFound ExecutionErrorType = "NOT_FOUND" ExecutionErrorTypeBadRequest ExecutionErrorType = "BAD_REQUEST" ExecutionErrorTypeTimeout ExecutionErrorType = "TIMEOUT" ExecutionErrorTypeInternalServerError ExecutionErrorType = "INTERNAL_SERVER_ERROR" )
Enum values for ExecutionErrorType
func (ExecutionErrorType) Values ¶
func (ExecutionErrorType) Values() []ExecutionErrorType
Values returns all known values for ExecutionErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ExecutionResults ¶
type ExecutionResults struct { // Specifies the steps (actions) to take if errors are encountered during // execution of the workflow. OnExceptionSteps []ExecutionStepResult // Specifies the details for the steps that are in the specified workflow. Steps []ExecutionStepResult // 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.
type ExecutionStatus ¶
type ExecutionStatus string
const ( ExecutionStatusInProgress ExecutionStatus = "IN_PROGRESS" ExecutionStatusCompleted ExecutionStatus = "COMPLETED" ExecutionStatusException ExecutionStatus = "EXCEPTION" ExecutionStatusHandlingException ExecutionStatus = "HANDLING_EXCEPTION" )
Enum values for ExecutionStatus
func (ExecutionStatus) Values ¶
func (ExecutionStatus) Values() []ExecutionStatus
Values returns all known values for ExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ExecutionStepResult ¶
type ExecutionStepResult struct { // Specifies the details for an error, if it occurred during execution of the // specified workflow step. Error *ExecutionError // The values for the key/value pair applied as a tag to the file. Only applicable // if the step type is TAG . Outputs *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 WorkflowStepType // contains filtered or unexported fields }
Specifies the following details for the step: error (if any), outputs (if any), and the step type.
type FileLocation ¶
type FileLocation struct { // Specifies the Amazon EFS identifier and the path for the file being used. EfsFileLocation *EfsFileLocation // Specifies the S3 details for the file being used, such as bucket, ETag, and so // forth. S3FileLocation *S3FileLocation // contains filtered or unexported fields }
Specifies the Amazon S3 or EFS file details to be used in the step.
type HomeDirectoryMapEntry ¶
type HomeDirectoryMapEntry struct { // Represents an entry for HomeDirectoryMappings . // // This member is required. Entry *string // Represents the map target that is used in a HomeDirectoryMapEntry . // // This member is required. Target *string // 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 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" } ]
type HomeDirectoryType ¶
type HomeDirectoryType string
const ( HomeDirectoryTypePath HomeDirectoryType = "PATH" HomeDirectoryTypeLogical HomeDirectoryType = "LOGICAL" )
Enum values for HomeDirectoryType
func (HomeDirectoryType) Values ¶
func (HomeDirectoryType) Values() []HomeDirectoryType
Values returns all known values for HomeDirectoryType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type IdentityCenterConfig ¶
type IdentityCenterConfig struct { // The Amazon Resource Name (ARN) for the IAM Identity Center used for the web app. InstanceArn *string // The IAM role in IAM Identity Center used for the web app. Role *string // contains filtered or unexported fields }
A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.
type IdentityProviderDetails ¶
type IdentityProviderDetails struct { // The identifier of the Directory Service directory that you want to use as your // identity provider. DirectoryId *string // The ARN for a Lambda function to use for the Identity provider. Function *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 // 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 SftpAuthenticationMethods // Provides the location of the service endpoint used to authenticate users. Url *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.
type IdentityProviderType ¶
type IdentityProviderType string
const ( IdentityProviderTypeServiceManaged IdentityProviderType = "SERVICE_MANAGED" IdentityProviderTypeApiGateway IdentityProviderType = "API_GATEWAY" IdentityProviderTypeAwsDirectoryService IdentityProviderType = "AWS_DIRECTORY_SERVICE" IdentityProviderTypeAwsLambda IdentityProviderType = "AWS_LAMBDA" )
Enum values for IdentityProviderType
func (IdentityProviderType) Values ¶
func (IdentityProviderType) Values() []IdentityProviderType
Values returns all known values for IdentityProviderType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InputFileLocation ¶
type InputFileLocation struct { // Specifies the details for the Amazon Elastic File System (Amazon EFS) file // that's being decrypted. EfsFileLocation *EfsFileLocation // Specifies the details for the Amazon S3 file that's being copied or decrypted. S3FileLocation *S3InputFileLocation // contains filtered or unexported fields }
Specifies the location for the file that's being processed.
type InternalServiceError ¶
type InternalServiceError struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This exception is thrown when an error occurs in the Transfer Family service.
func (*InternalServiceError) Error ¶
func (e *InternalServiceError) Error() string
func (*InternalServiceError) ErrorCode ¶
func (e *InternalServiceError) ErrorCode() string
func (*InternalServiceError) ErrorFault ¶
func (e *InternalServiceError) ErrorFault() smithy.ErrorFault
func (*InternalServiceError) ErrorMessage ¶
func (e *InternalServiceError) ErrorMessage() string
type InvalidNextTokenException ¶
type InvalidNextTokenException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The NextToken parameter that was passed is invalid.
func (*InvalidNextTokenException) Error ¶
func (e *InvalidNextTokenException) Error() string
func (*InvalidNextTokenException) ErrorCode ¶
func (e *InvalidNextTokenException) ErrorCode() string
func (*InvalidNextTokenException) ErrorFault ¶
func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault
func (*InvalidNextTokenException) ErrorMessage ¶
func (e *InvalidNextTokenException) ErrorMessage() string
type InvalidRequestException ¶
type InvalidRequestException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This exception is thrown when the client submits a malformed request.
func (*InvalidRequestException) Error ¶
func (e *InvalidRequestException) Error() string
func (*InvalidRequestException) ErrorCode ¶
func (e *InvalidRequestException) ErrorCode() string
func (*InvalidRequestException) ErrorFault ¶
func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
func (*InvalidRequestException) ErrorMessage ¶
func (e *InvalidRequestException) ErrorMessage() string
type ListedAccess ¶
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 // 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 // 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 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 // contains filtered or unexported fields }
Lists the properties for one or more specified associated accesses.
type ListedAgreement ¶
type ListedAgreement struct { // A unique identifier for the agreement. This identifier is returned when you // create an agreement. AgreementId *string // The Amazon Resource Name (ARN) of the specified agreement. Arn *string // The current description for the agreement. You can change it by calling the // UpdateAgreement operation and providing a new description. Description *string // A unique identifier for the AS2 local profile. LocalProfileId *string // A unique identifier for the partner profile. PartnerProfileId *string // The unique identifier for the agreement. ServerId *string // The agreement can be either ACTIVE or INACTIVE . Status AgreementStatusType // contains filtered or unexported fields }
Describes the properties of an agreement.
type ListedCertificate ¶
type ListedCertificate struct { // An optional date that specifies when the certificate becomes active. If you do // not specify a value, ActiveDate takes the same value as NotBeforeDate , which is // specified by the CA. ActiveDate *time.Time // The Amazon Resource Name (ARN) of the specified certificate. Arn *string // An array of identifiers for the imported certificates. You use this identifier // for working with profiles and partner profiles. CertificateId *string // The name or short description that's used to identify the certificate. Description *string // An optional date that specifies when the certificate becomes inactive. If you // do not specify a value, InactiveDate takes the same value as NotAfterDate , // which is specified by the CA. InactiveDate *time.Time // 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 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 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 CertificateUsageType // contains filtered or unexported fields }
Describes the properties of a certificate.
type ListedConnector ¶
type ListedConnector struct { // The Amazon Resource Name (ARN) of the specified connector. Arn *string // The unique identifier for the connector. ConnectorId *string // The URL of the partner's AS2 or SFTP endpoint. Url *string // contains filtered or unexported fields }
Returns details of the connector that is specified.
type ListedExecution ¶
type ListedExecution struct { // A unique identifier for the execution of a workflow. ExecutionId *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 // A container object for the session details that are associated with a workflow. ServiceMetadata *ServiceMetadata // The status is one of the execution. Can be in progress, completed, exception // encountered, or handling the exception. Status ExecutionStatus // contains filtered or unexported fields }
Returns properties of the execution that is specified.
type ListedHostKey ¶
type ListedHostKey struct { // The unique Amazon Resource Name (ARN) of the host key. // // This member is required. Arn *string // The date on which the host key was added to the server. DateImported *time.Time // The current description for the host key. You can change it by calling the // UpdateHostKey operation and providing a new description. Description *string // The public key fingerprint, which is a short sequence of bytes used to identify // the longer public key. Fingerprint *string // A unique identifier for the host key. HostKeyId *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 // contains filtered or unexported fields }
Returns properties of the host key that's specified.
type ListedProfile ¶
type ListedProfile struct { // The Amazon Resource Name (ARN) of the specified profile. Arn *string // The As2Id is the AS2-name, as defined in the [RFC 4130]. 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. // // [RFC 4130]: https://datatracker.ietf.org/doc/html/rfc4130 As2Id *string // A unique identifier for the local or partner AS2 profile. ProfileId *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 ProfileType // contains filtered or unexported fields }
Returns the properties of the profile that was specified.
type ListedServer ¶
type ListedServer struct { // Specifies the unique Amazon Resource Name (ARN) for a server to be listed. // // This member is required. Arn *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 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 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 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 EFS events. When set, you can view user activity in your CloudWatch logs. LoggingRole *string // Specifies the unique system assigned identifier for the servers that were // listed. ServerId *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 State // Specifies the number of users that are assigned to a server you specified with // the ServerId . UserCount *int32 // contains filtered or unexported fields }
Returns properties of a file transfer protocol-enabled server that was specified.
type ListedUser ¶
type ListedUser struct { // Provides the unique Amazon Resource Name (ARN) for the user that you want to // learn about. // // This member is required. Arn *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 // 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 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 // Specifies the number of SSH public keys stored for the user you specified. SshPublicKeyCount *int32 // Specifies the name of the user whose ARN was specified. User names are used for // authentication purposes. UserName *string // contains filtered or unexported fields }
Returns properties of the user that you specify.
type ListedWebApp ¶
type ListedWebApp struct { // The Amazon Resource Name (ARN) for the web app. // // This member is required. Arn *string // The unique identifier for the web app. // // This member is required. WebAppId *string // The AccessEndpoint is the URL that you provide to your users for them to // interact with the Transfer Family web app. You can specify a custom URL or use // the default value. AccessEndpoint *string // The WebAppEndpoint is the unique URL for your Transfer Family web app. This is // the value that you use when you configure Origins on CloudFront. WebAppEndpoint *string // contains filtered or unexported fields }
a structure that contains details for the web app.
type ListedWorkflow ¶
type ListedWorkflow struct { // Specifies the unique Amazon Resource Name (ARN) for the workflow. Arn *string // Specifies the text description for the workflow. Description *string // A unique identifier for the workflow. WorkflowId *string // contains filtered or unexported fields }
Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.
type LoggingConfiguration ¶
type LoggingConfiguration struct { // The name of the CloudWatch logging group for the Transfer Family server to // which this workflow belongs. LogGroupName *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 EFS events. When set, you can view user activity in your CloudWatch logs. LoggingRole *string // contains filtered or unexported fields }
Consists of the logging role and the log group name.
type MapType ¶
type MapType string
Enum values for MapType
func (MapType) Values ¶
Values returns all known values for MapType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MdnResponse ¶
type MdnResponse string
const ( MdnResponseSync MdnResponse = "SYNC" MdnResponseNone MdnResponse = "NONE" )
Enum values for MdnResponse
func (MdnResponse) Values ¶
func (MdnResponse) Values() []MdnResponse
Values returns all known values for MdnResponse. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MdnSigningAlg ¶
type MdnSigningAlg string
const ( MdnSigningAlgSha256 MdnSigningAlg = "SHA256" MdnSigningAlgSha384 MdnSigningAlg = "SHA384" MdnSigningAlgSha512 MdnSigningAlg = "SHA512" MdnSigningAlgSha1 MdnSigningAlg = "SHA1" MdnSigningAlgNone MdnSigningAlg = "NONE" MdnSigningAlgDefault MdnSigningAlg = "DEFAULT" )
Enum values for MdnSigningAlg
func (MdnSigningAlg) Values ¶
func (MdnSigningAlg) Values() []MdnSigningAlg
Values returns all known values for MdnSigningAlg. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type OverwriteExisting ¶
type OverwriteExisting string
const ( OverwriteExistingTrue OverwriteExisting = "TRUE" OverwriteExistingFalse OverwriteExisting = "FALSE" )
Enum values for OverwriteExisting
func (OverwriteExisting) Values ¶
func (OverwriteExisting) Values() []OverwriteExisting
Values returns all known values for OverwriteExisting. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PosixProfile ¶
type PosixProfile struct { // The POSIX group ID used for all EFS operations by this user. // // This member is required. Gid *int64 // The POSIX user ID used for all EFS operations by this user. // // This member is required. Uid *int64 // The secondary POSIX group IDs used for all EFS operations by this user. SecondaryGids []int64 // 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.
type PreserveContentType ¶
type PreserveContentType string
const ( PreserveContentTypeEnabled PreserveContentType = "ENABLED" PreserveContentTypeDisabled PreserveContentType = "DISABLED" )
Enum values for PreserveContentType
func (PreserveContentType) Values ¶
func (PreserveContentType) Values() []PreserveContentType
Values returns all known values for PreserveContentType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PreserveFilenameType ¶
type PreserveFilenameType string
const ( PreserveFilenameTypeEnabled PreserveFilenameType = "ENABLED" PreserveFilenameTypeDisabled PreserveFilenameType = "DISABLED" )
Enum values for PreserveFilenameType
func (PreserveFilenameType) Values ¶
func (PreserveFilenameType) Values() []PreserveFilenameType
Values returns all known values for PreserveFilenameType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ProfileType ¶
type ProfileType string
const ( ProfileTypeLocal ProfileType = "LOCAL" ProfileTypePartner ProfileType = "PARTNER" )
Enum values for ProfileType
func (ProfileType) Values ¶
func (ProfileType) Values() []ProfileType
Values returns all known values for ProfileType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Protocol ¶
type Protocol string
const ( ProtocolSftp Protocol = "SFTP" ProtocolFtp Protocol = "FTP" ProtocolFtps Protocol = "FTPS" ProtocolAs2 Protocol = "AS2" )
Enum values for Protocol
func (Protocol) Values ¶
Values returns all known values for Protocol. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ProtocolDetails ¶
type ProtocolDetails struct { // Indicates the transport method for the AS2 messages. Currently, only HTTP is // supported. As2Transports []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]. // // 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. // // [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/ PassiveIp *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 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 TlsSessionResumptionMode // contains filtered or unexported fields }
The protocol settings that are configured for your server.
type ResourceExistsException ¶
type ResourceExistsException struct { Message *string ErrorCodeOverride *string Resource *string ResourceType *string // 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 (*ResourceExistsException) Error ¶
func (e *ResourceExistsException) Error() string
func (*ResourceExistsException) ErrorCode ¶
func (e *ResourceExistsException) ErrorCode() string
func (*ResourceExistsException) ErrorFault ¶
func (e *ResourceExistsException) ErrorFault() smithy.ErrorFault
func (*ResourceExistsException) ErrorMessage ¶
func (e *ResourceExistsException) ErrorMessage() string
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string Resource *string ResourceType *string // contains filtered or unexported fields }
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type S3FileLocation ¶
type S3FileLocation struct { // Specifies the S3 bucket that contains the file being used. Bucket *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 // The name assigned to the file when it was created in Amazon S3. You use the // object key to retrieve the object. Key *string // Specifies the file version. VersionId *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.
type S3InputFileLocation ¶
type S3InputFileLocation struct { // Specifies the S3 bucket for the customer input file. Bucket *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 // 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.
type S3StorageOptions ¶
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 DirectoryListingOptimization // contains filtered or unexported fields }
The Amazon S3 storage options that are configured for your server.
type S3Tag ¶
type S3Tag struct { // The name assigned to the tag that you create. // // This member is required. Key *string // The value that corresponds to the key. // // This member is required. Value *string // contains filtered or unexported fields }
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
type SecurityPolicyProtocol ¶
type SecurityPolicyProtocol string
const ( SecurityPolicyProtocolSftp SecurityPolicyProtocol = "SFTP" SecurityPolicyProtocolFtps SecurityPolicyProtocol = "FTPS" )
Enum values for SecurityPolicyProtocol
func (SecurityPolicyProtocol) Values ¶
func (SecurityPolicyProtocol) Values() []SecurityPolicyProtocol
Values returns all known values for SecurityPolicyProtocol. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SecurityPolicyResourceType ¶
type SecurityPolicyResourceType string
const ( SecurityPolicyResourceTypeServer SecurityPolicyResourceType = "SERVER" SecurityPolicyResourceTypeConnector SecurityPolicyResourceType = "CONNECTOR" )
Enum values for SecurityPolicyResourceType
func (SecurityPolicyResourceType) Values ¶
func (SecurityPolicyResourceType) Values() []SecurityPolicyResourceType
Values returns all known values for SecurityPolicyResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ServiceMetadata ¶
type ServiceMetadata struct { // The Server ID ( ServerId ), Session ID ( SessionId ) and user ( UserName ) make // up the UserDetails . // // This member is required. UserDetails *UserDetails // contains filtered or unexported fields }
A container object for the session details that are associated with a workflow.
type ServiceUnavailableException ¶
type ServiceUnavailableException struct { string *string // contains filtered or unexported fields }*
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
func (*ServiceUnavailableException) Error ¶
func (e *ServiceUnavailableException) Error() string
func (*ServiceUnavailableException) ErrorCode ¶
func (e *ServiceUnavailableException) ErrorCode() string
func (*ServiceUnavailableException) ErrorFault ¶
func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault
func (*ServiceUnavailableException) ErrorMessage ¶
func (e *ServiceUnavailableException) ErrorMessage() string
type SetStatOption ¶
type SetStatOption string
const ( SetStatOptionDefault SetStatOption = "DEFAULT" SetStatOptionEnableNoOp SetStatOption = "ENABLE_NO_OP" )
Enum values for SetStatOption
func (SetStatOption) Values ¶
func (SetStatOption) Values() []SetStatOption
Values returns all known values for SetStatOption. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SftpAuthenticationMethods ¶
type SftpAuthenticationMethods string
const ( SftpAuthenticationMethodsPassword SftpAuthenticationMethods = "PASSWORD" SftpAuthenticationMethodsPublicKey SftpAuthenticationMethods = "PUBLIC_KEY" SftpAuthenticationMethodsPublicKeyOrPassword SftpAuthenticationMethods = "PUBLIC_KEY_OR_PASSWORD" SftpAuthenticationMethodsPublicKeyAndPassword SftpAuthenticationMethods = "PUBLIC_KEY_AND_PASSWORD" )
Enum values for SftpAuthenticationMethods
func (SftpAuthenticationMethods) Values ¶
func (SftpAuthenticationMethods) Values() []SftpAuthenticationMethods
Values returns all known values for SftpAuthenticationMethods. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SftpConnectorConfig ¶
type SftpConnectorConfig struct { // Specify the number of concurrent connections that your connector creates to the // remote server. The default value is 5 (this is also the maximum value allowed). // // This parameter specifies the number of active connections that your connector // can establish with the remote server at the same time. Increasing this value can // enhance connector performance when transferring large file batches by enabling // parallel operations. MaxConcurrentConnections *int32 // 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. // // TrustedHostKeys is optional for CreateConnector . If not provided, you can use // TestConnection to retrieve the server host key during the initial connection // attempt, and subsequently update the connector with the observed host 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 // 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. // // - Required when creating an SFTP connector // // - Optional when updating an existing SFTP connector UserSecretId *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.
type SftpConnectorConnectionDetails ¶
type SftpConnectorConnectionDetails struct { // The SSH public key of the remote SFTP server. This is returned during the // initial connection attempt when you call TestConnection . It allows you to // retrieve the valid server host key to update the connector when you are unable // to obtain it in advance. HostKey *string // contains filtered or unexported fields }
Contains the details for an SFTP connector connection.
type SigningAlg ¶
type SigningAlg string
const ( SigningAlgSha256 SigningAlg = "SHA256" SigningAlgSha384 SigningAlg = "SHA384" SigningAlgSha512 SigningAlg = "SHA512" SigningAlgSha1 SigningAlg = "SHA1" SigningAlgNone SigningAlg = "NONE" )
Enum values for SigningAlg
func (SigningAlg) Values ¶
func (SigningAlg) Values() []SigningAlg
Values returns all known values for SigningAlg. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SshPublicKey ¶
type SshPublicKey struct { // Specifies the date that the public key was added to the Transfer Family user. // // This member is required. DateImported *time.Time // Specifies the content of the SSH public key as specified by the PublicKeyId . // // Transfer Family accepts RSA, ECDSA, and ED25519 keys. // // This member is required. SshPublicKeyBody *string // Specifies the SshPublicKeyId parameter contains the identifier of the public // key. // // This member is required. SshPublicKeyId *string // 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.
type State ¶
type State string
const ( StateOffline State = "OFFLINE" StateOnline State = "ONLINE" StateStarting State = "STARTING" StateStopping State = "STOPPING" StateStartFailed State = "START_FAILED" StateStopFailed State = "STOP_FAILED" )
Enum values for State
func (State) Values ¶
Values returns all known values for State. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Tag ¶
type Tag struct { // The name assigned to the tag that you create. // // This member is required. Key *string // Contains one or more values that you assigned to the key name you create. // // This member is required. Value *string // 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.
type TagStepDetails ¶
type TagStepDetails struct { // The name of the step, used as an identifier. Name *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 // Array that contains from 1 to 10 key/value pairs. Tags []S3Tag // 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.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string RetryAfterSeconds *string // contains filtered or unexported fields }
The request was denied due to request throttling.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type TlsSessionResumptionMode ¶
type TlsSessionResumptionMode string
const ( TlsSessionResumptionModeDisabled TlsSessionResumptionMode = "DISABLED" TlsSessionResumptionModeEnabled TlsSessionResumptionMode = "ENABLED" TlsSessionResumptionModeEnforced TlsSessionResumptionMode = "ENFORCED" )
Enum values for TlsSessionResumptionMode
func (TlsSessionResumptionMode) Values ¶
func (TlsSessionResumptionMode) Values() []TlsSessionResumptionMode
Values returns all known values for TlsSessionResumptionMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type TransferTableStatus ¶
type TransferTableStatus string
const ( TransferTableStatusQueued TransferTableStatus = "QUEUED" TransferTableStatusInProgress TransferTableStatus = "IN_PROGRESS" TransferTableStatusCompleted TransferTableStatus = "COMPLETED" TransferTableStatusFailed TransferTableStatus = "FAILED" )
Enum values for TransferTableStatus
func (TransferTableStatus) Values ¶
func (TransferTableStatus) Values() []TransferTableStatus
Values returns all known values for TransferTableStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type UnknownUnionMember ¶
type UnknownUnionMember struct { Tag string Value []byte // contains filtered or unexported fields }
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type UpdateWebAppIdentityCenterConfig ¶
type UpdateWebAppIdentityCenterConfig struct { // The IAM role used to access IAM Identity Center. Role *string // contains filtered or unexported fields }
A structure that describes the values to use for the IAM Identity Center settings when you update a web app.
type UpdateWebAppIdentityProviderDetails ¶
type UpdateWebAppIdentityProviderDetails interface {
// contains filtered or unexported methods
}
A union that contains the UpdateWebAppIdentityCenterConfig object.
The following types satisfy this interface:
UpdateWebAppIdentityProviderDetailsMemberIdentityCenterConfig
Example (OutputUsage)¶
Code:play
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/transfer/types" ) func main() { var union types.UpdateWebAppIdentityProviderDetails // type switches can be used to check the union value switch v := union.(type) { case *types.UpdateWebAppIdentityProviderDetailsMemberIdentityCenterConfig: _ = v.Value // Value is types.UpdateWebAppIdentityCenterConfig case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
type UpdateWebAppIdentityProviderDetailsMemberIdentityCenterConfig ¶
type UpdateWebAppIdentityProviderDetailsMemberIdentityCenterConfig struct { Value UpdateWebAppIdentityCenterConfig // contains filtered or unexported fields }
A structure that describes the values to use for the IAM Identity Center settings when you update a web app.
type UserDetails ¶
type UserDetails struct { // The system-assigned unique identifier for a Transfer server instance. // // This member is required. ServerId *string // A unique string that identifies a Transfer Family user associated with a server. // // This member is required. UserName *string // The system-assigned unique identifier for a session that corresponds to the // workflow. SessionId *string // contains filtered or unexported fields }
Specifies the user name, server ID, and session ID for a workflow.
type WebAppEndpointPolicy ¶
type WebAppEndpointPolicy string
const ( WebAppEndpointPolicyFips WebAppEndpointPolicy = "FIPS" WebAppEndpointPolicyStandard WebAppEndpointPolicy = "STANDARD" )
Enum values for WebAppEndpointPolicy
func (WebAppEndpointPolicy) Values ¶
func (WebAppEndpointPolicy) Values() []WebAppEndpointPolicy
Values returns all known values for WebAppEndpointPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type WebAppIdentityProviderDetails ¶
type WebAppIdentityProviderDetails interface {
// contains filtered or unexported methods
}
A union that contains the IdentityCenterConfig object.
The following types satisfy this interface:
WebAppIdentityProviderDetailsMemberIdentityCenterConfig
Example (OutputUsage)¶
Code:play
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/transfer/types" ) func main() { var union types.WebAppIdentityProviderDetails // type switches can be used to check the union value switch v := union.(type) { case *types.WebAppIdentityProviderDetailsMemberIdentityCenterConfig: _ = v.Value // Value is types.IdentityCenterConfig case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
type WebAppIdentityProviderDetailsMemberIdentityCenterConfig ¶
type WebAppIdentityProviderDetailsMemberIdentityCenterConfig struct { Value IdentityCenterConfig // contains filtered or unexported fields }
A structure that describes the values to use for the IAM Identity Center settings when you create a web app.
type WebAppUnits ¶
type WebAppUnits interface {
// contains filtered or unexported methods
}
Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.
The following types satisfy this interface:
WebAppUnitsMemberProvisioned
Example (OutputUsage)¶
Code:play
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/transfer/types" ) func main() { var union types.WebAppUnits // type switches can be used to check the union value switch v := union.(type) { case *types.WebAppUnitsMemberProvisioned: _ = v.Value // Value is int32 case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
type WebAppUnitsMemberProvisioned ¶
type WebAppUnitsMemberProvisioned struct { Value int32 // contains filtered or unexported fields }
An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time.
Each increment allows an additional 250 concurrent sessions: a value of 1 sets the number of concurrent sessions to 250; 2 sets a value of 500, and so on.
type WorkflowDetail ¶
type WorkflowDetail struct { // Includes the necessary permissions for S3, EFS, and Lambda operations that // Transfer can assume, so that all workflow steps can operate on the required // resources // // This member is required. ExecutionRole *string // A unique identifier for the workflow. // // This member is required. WorkflowId *string // contains filtered or unexported fields }
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.
type WorkflowDetails ¶
type WorkflowDetails struct { // A trigger that starts a workflow if a file is only partially uploaded. You can // attach a workflow to a server that executes whenever there is a partial upload. // // A partial upload occurs when a file is open when the session disconnects. // // OnPartialUpload can contain a maximum of one WorkflowDetail object. OnPartialUpload []WorkflowDetail // A trigger that starts a workflow: the workflow begins to execute after a file // is uploaded. // // To remove an associated workflow from a server, you can provide an empty // OnUpload object, as in the following example. // // aws transfer update-server --server-id s-01234567890abcdef --workflow-details // '{"OnUpload":[]}' // // OnUpload can contain a maximum of one WorkflowDetail object. OnUpload []WorkflowDetail // contains filtered or unexported fields }
Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.
type WorkflowStep ¶
type WorkflowStep struct { // Details for a step that performs a file copy. // // Consists of the following values: // // - A description // // - An Amazon S3 location for the destination of the file copy. // // - A flag that indicates whether to overwrite an existing file of the same // name. The default is FALSE . CopyStepDetails *CopyStepDetails // Details for a step that invokes an Lambda function. // // Consists of the Lambda function's name, target, and timeout (in seconds). CustomStepDetails *CustomStepDetails // Details for a step that decrypts an encrypted file. // // Consists of the following values: // // - A descriptive name // // - An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the // source file to decrypt. // // - An S3 or Amazon EFS location for the destination of the file decryption. // // - A flag that indicates whether to overwrite an existing file of the same // name. The default is FALSE . // // - The type of encryption that's used. Currently, only PGP encryption is // supported. DecryptStepDetails *DecryptStepDetails // Details for a step that deletes the file. DeleteStepDetails *DeleteStepDetails // Details for a step that creates one or more tags. // // You specify one or more tags. Each tag contains a key-value pair. TagStepDetails *TagStepDetails // Currently, the following step types are supported. // // - 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. Type WorkflowStepType // contains filtered or unexported fields }
The basic building block of a workflow.
type WorkflowStepType ¶
type WorkflowStepType string
const ( WorkflowStepTypeCopy WorkflowStepType = "COPY" WorkflowStepTypeCustom WorkflowStepType = "CUSTOM" WorkflowStepTypeTag WorkflowStepType = "TAG" WorkflowStepTypeDelete WorkflowStepType = "DELETE" WorkflowStepTypeDecrypt WorkflowStepType = "DECRYPT" )
Enum values for WorkflowStepType
func (WorkflowStepType) Values ¶
func (WorkflowStepType) Values() []WorkflowStepType
Values returns all known values for WorkflowStepType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
Source Files ¶
- Version
- v1.60.1 (latest)
- Published
- Apr 16, 2025
- Platform
- linux/amd64
- Imports
- 4 packages
- Last checked
- 38 minutes ago –
Tools for package owners.