Expand description

Data structures used by operation inputs/outputs.

Modules

Structs

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.

The details for an execution object.

Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies.

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

Describes the properties of a user that was specified.

Describes the properties of the specified workflow

Reserved for future use.

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.

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.

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

Lists the properties for one or more specified associated accesses.

Returns properties of the execution that is specified.

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

Returns properties of the user that you specify.

Contains the ID, 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.

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

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

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

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

Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.

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.

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

Specifies the workflow ID for the workflow to assign and the execution role 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.

Enums

Returns information related to the type of user authentication that is in use for a file

Describes the condition of a file transfer protocol-enabled server with respect to its