Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS Transfer Family can respond with.

Structs

As2ConnectorConfig

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.

ConnectorFileTransferResult

A structure that contains the details for files transferred using an SFTP connector, during a single transfer.

ConnectorVpcLatticeEgressConfig

VPC_LATTICE egress configuration that specifies the Resource Configuration ARN and port for connecting to SFTP servers through customer VPCs. Requires a valid Resource Configuration with appropriate network access.

CopyStepDetails

Each step type has its own StepDetails structure.

CustomDirectoriesType

Contains Amazon S3 locations for storing specific types of AS2 message files.

CustomStepDetails

Each step type has its own StepDetails structure.

DecryptStepDetails

Each step type has its own StepDetails structure.

DeleteStepDetails

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

DescribedAccess

Describes the properties of the access that was specified.

DescribedAgreement

Describes the properties of an agreement.

DescribedCertificate

Describes the properties of a certificate.

DescribedConnector

Describes the parameters for the connector, as identified by the ConnectorId.

DescribedConnectorVpcLatticeEgressConfig

VPC_LATTICE egress configuration details in the response, containing the Resource Configuration ARN and port number currently configured for the connector.

DescribedExecution

The details for an execution object.

DescribedHostKey

The details for a server host key.

DescribedIdentityCenterConfig

A structure that contains the details of the IAM Identity Center used for your web app. Returned during a call to DescribeWebApp.

DescribedProfile

The details for a local or partner AS2 profile.

DescribedSecurityPolicy

Describes the properties of a security policy that you specify. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

DescribedServer

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

DescribedUser

Describes the properties of a user that was specified.

DescribedWebApp

A structure that describes the parameters for the web app, as identified by the WebAppId.

DescribedWebAppCustomization

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.

DescribedWebAppVpcConfig

Contains the VPC configuration details for a web app endpoint, including the VPC identifier, subnet IDs, and VPC endpoint ID used for hosting the endpoint.

DescribedWorkflow

Describes the properties of the specified workflow

EfsFileLocation

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.

EndpointDetails

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.

ExecutionError

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

ExecutionResults

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

ExecutionStepResult

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

FileLocation

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

HomeDirectoryMapEntry

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" } \]

IdentityCenterConfig

A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.

IdentityProviderDetails

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.

InputFileLocation

Specifies the location for the file that's being processed.

ListedAccess

Lists the properties for one or more specified associated accesses.

ListedAgreement

Describes the properties of an agreement.

ListedCertificate

Describes the properties of a certificate.

ListedConnector

Returns details of the connector that is specified.

ListedExecution

Returns properties of the execution that is specified.

ListedHostKey

Returns properties of the host key that's specified.

ListedProfile

Returns the properties of the profile that was specified.

ListedServer

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

ListedUser

Returns properties of the user that you specify.

ListedWebApp

a structure that contains details for the web app.

ListedWorkflow

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

LoggingConfiguration

Consists of the logging role and the log group name.

PosixProfile

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.

ProtocolDetails

The protocol settings that are configured for your server.

S3FileLocation

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.

S3InputFileLocation

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.

S3StorageOptions

The Amazon S3 storage options that are configured for your server.

S3Tag

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

ServiceMetadata

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

SftpConnectorConfig

Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.

SftpConnectorConnectionDetails

Contains the details for an SFTP connector connection.

SshPublicKey

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.

Tag

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.

TagStepDetails

Each step type has its own StepDetails structure.

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

UpdateConnectorVpcLatticeEgressConfig

VPC_LATTICE egress configuration updates for modifying how the connector routes traffic through customer VPCs. Changes to these settings may require connector restart to take effect.

UpdateWebAppIdentityCenterConfig

A structure that describes the values to use for the IAM Identity Center settings when you update a web app.

UpdateWebAppVpcConfig

Contains the VPC configuration settings for updating a web app endpoint, including the subnet IDs where the endpoint should be deployed.

UserDetails

Specifies the user name, server ID, and session ID for a workflow.

WebAppVpcConfig

Contains the VPC configuration settings for hosting a web app endpoint, including the VPC ID, subnet IDs, and security group IDs for access control.

WorkflowDetail

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

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

WorkflowStep

The basic building block of a workflow.

Enums

AgreementStatusType

When writing a match expression against AgreementStatusType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

As2Transport

When writing a match expression against As2Transport, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CertificateStatusType

When writing a match expression against CertificateStatusType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CertificateType

When writing a match expression against CertificateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CertificateUsageType

When writing a match expression against CertificateUsageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CompressionEnum

When writing a match expression against CompressionEnum, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ConnectorEgressConfig

Configuration structure that defines how traffic is routed from the connector to the SFTP server. Contains VPC Lattice settings when using VPC_LATTICE egress type for private connectivity through customer VPCs.

ConnectorEgressType

When writing a match expression against ConnectorEgressType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ConnectorStatus

When writing a match expression against ConnectorStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CustomStepStatus

When writing a match expression against CustomStepStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DescribedConnectorEgressConfig

Response structure containing the current egress configuration details for the connector. Shows how traffic is currently routed from the connector to the SFTP server.

DescribedWebAppEndpointDetails

Contains the endpoint configuration details for a web app, including VPC configuration when the endpoint is hosted within a VPC.

DescribedWebAppIdentityProviderDetails

Returns a structure that contains the identity provider details for your web app.

DirectoryListingOptimization

When writing a match expression against DirectoryListingOptimization, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Domain

When writing a match expression against Domain, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionAlg

When writing a match expression against EncryptionAlg, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionType

When writing a match expression against EncryptionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EndpointType

When writing a match expression against EndpointType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EnforceMessageSigningType

When writing a match expression against EnforceMessageSigningType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExecutionErrorType

When writing a match expression against ExecutionErrorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExecutionStatus

When writing a match expression against ExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

HomeDirectoryType

When writing a match expression against HomeDirectoryType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IdentityProviderType

When writing a match expression against IdentityProviderType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IpAddressType

When writing a match expression against IpAddressType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MapType

When writing a match expression against MapType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MdnResponse

When writing a match expression against MdnResponse, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MdnSigningAlg

When writing a match expression against MdnSigningAlg, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OverwriteExisting

When writing a match expression against OverwriteExisting, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PreserveContentType

When writing a match expression against PreserveContentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PreserveFilenameType

When writing a match expression against PreserveFilenameType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ProfileType

When writing a match expression against ProfileType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Protocol

When writing a match expression against Protocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SecurityPolicyProtocol

When writing a match expression against SecurityPolicyProtocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SecurityPolicyResourceType

When writing a match expression against SecurityPolicyResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SetStatOption

When writing a match expression against SetStatOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SftpAuthenticationMethods

When writing a match expression against SftpAuthenticationMethods, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SigningAlg

When writing a match expression against SigningAlg, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

State

When writing a match expression against State, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TlsSessionResumptionMode

When writing a match expression against TlsSessionResumptionMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TransferTableStatus

When writing a match expression against TransferTableStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UpdateConnectorEgressConfig

Structure for updating the egress configuration of an existing connector. Allows modification of how traffic is routed from the connector to the SFTP server, including VPC_LATTICE settings.

UpdateWebAppEndpointDetails

Contains the endpoint configuration details for updating a web app, including VPC settings for endpoints hosted within a VPC.

UpdateWebAppIdentityProviderDetails

A union that contains the UpdateWebAppIdentityCenterConfig object.

WebAppEndpointDetails

Contains the endpoint configuration for a web app, including VPC settings when the endpoint is hosted within a VPC.

WebAppEndpointPolicy

When writing a match expression against WebAppEndpointPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WebAppEndpointType

When writing a match expression against WebAppEndpointType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WebAppIdentityProviderDetails

A union that contains the IdentityCenterConfig object.

WebAppUnits

Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.

WorkflowStepType

When writing a match expression against WorkflowStepType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.