Package-level declarations
Types
You do not have sufficient access to perform this action.
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.
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.
A structure that contains the details for files transferred using an SFTP connector, during a single transfer.
Each step type has its own StepDetails structure.
Contains Amazon S3 locations for storing specific types of AS2 message files.
Each step type has its own StepDetails structure.
Each step type has its own StepDetails structure.
The name of the step, used to identify the delete step.
Describes the properties of the access that was specified.
Describes the properties of an agreement.
Describes the properties of a certificate.
Describes the parameters for the connector, as identified by the ConnectorId.
The details for an execution object.
The details for a server host key.
A structure that contains the details of the IAM Identity Center used for your web app. Returned during a call to DescribeWebApp.
The details for a local or partner AS2 profile.
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.
Describes the properties of a file transfer protocol-enabled server that was specified.
Describes the properties of a user that was specified.
A structure that describes the parameters for the web app, as identified by the WebAppId.
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.
Returns a structure that contains the identity provider details for your web app.
Describes the properties of the specified workflow
Indicates whether optimization to directory listing on S3 servers is used. Disabled by default for compatibility.
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.
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.
Specifies the error message and type, for an error that occurs during the execution of the workflow.
Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.
Specifies the following details for the step: error (if any), outputs (if any), and the step type.
Specifies the Amazon S3 or EFS file details to be used in the step.
Represents an object that contains entries and targets for HomeDirectoryMappings.
A structure that describes the values to use for the IAM Identity Center settings when you create or update a web app.
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.
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.
Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.
Specifies the location for the file that's being processed.
This exception is thrown when an error occurs in the Transfer Family service.
The NextToken parameter that was passed is invalid.
This exception is thrown when the client submits a malformed request.
Lists the properties for one or more specified associated accesses.
Describes the properties of an agreement.
Describes the properties of a certificate.
Returns details of the connector that is specified.
Returns properties of the execution that is specified.
Returns properties of the host key that's specified.
Returns the properties of the profile that was specified.
Returns properties of a file transfer protocol-enabled server that was specified.
Returns properties of the user that you specify.
a structure that contains details for the web app.
Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.
Consists of the logging role and the log group name.
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.
The protocol settings that are configured for your server.
The requested resource does not exist, or exists in a region other than the one specified for the command.
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
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.
Specifies the customer input Amazon S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.
The Amazon S3 storage options that are configured for your server.
A container object for the session details that are associated with a workflow.
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.
Contains the details for an SFTP connector connection.
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.
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.
Each step type has its own StepDetails structure.
The request was denied due to request throttling.
Base class for all service related exceptions thrown by the Transfer client
UpdateUserResponse returns the user name and identifier for the request to update a user's properties.
A structure that describes the values to use for the IAM Identity Center settings when you update a web app.
A union that contains the UpdateWebAppIdentityCenterConfig object.
Specifies the user name, server ID, and session ID for a workflow.
A union that contains the IdentityCenterConfig object.
Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.
The basic building block of a workflow.