| Class | Description |
|---|---|
| CopyStepDetails |
Each step type has its own
StepDetails structure. |
| CreateAccessRequest | |
| CreateAccessResponse | |
| CreateServerRequest | |
| CreateServerResponse | |
| CreateUserRequest | |
| CreateUserResponse | |
| CreateWorkflowRequest | |
| CreateWorkflowResponse | |
| CustomStepDetails |
Each step type has its own
StepDetails structure. |
| DeleteAccessRequest | |
| DeleteAccessResponse | |
| DeleteServerRequest | |
| DeleteServerResponse | |
| DeleteSshPublicKeyRequest | |
| DeleteSshPublicKeyResponse | |
| DeleteStepDetails |
The name of the step, used to identify the delete step.
|
| DeleteUserRequest | |
| DeleteUserResponse | |
| DeleteWorkflowRequest | |
| DeleteWorkflowResponse | |
| DescribeAccessRequest | |
| DescribeAccessResponse | |
| DescribedAccess |
Describes the properties of the access that was specified.
|
| DescribedExecution |
The details for an execution object.
|
| DescribedSecurityPolicy |
Describes the properties of a security policy that was specified.
|
| DescribedServer |
Describes the properties of a file transfer protocol-enabled server that was specified.
|
| DescribedUser |
Describes the properties of a user that was specified.
|
| DescribedWorkflow |
Describes the properties of the specified workflow
|
| DescribeExecutionRequest | |
| DescribeExecutionResponse | |
| DescribeSecurityPolicyRequest | |
| DescribeSecurityPolicyResponse | |
| DescribeServerRequest | |
| DescribeServerResponse | |
| DescribeUserRequest | |
| DescribeUserResponse | |
| DescribeWorkflowRequest | |
| DescribeWorkflowResponse | |
| EfsFileLocation |
Reserved for future use.
|
| EndpointDetails |
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server.
|
| 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. |
| IdentityProviderDetails |
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled
server's users.
|
| ImportSshPublicKeyRequest | |
| ImportSshPublicKeyResponse |
Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user.
|
| InputFileLocation |
Specifies the location for the file being copied.
|
| ListAccessesRequest | |
| ListAccessesResponse | |
| ListedAccess |
Lists the properties for one or more specified associated accesses.
|
| ListedExecution |
Returns properties of the execution that is specified.
|
| ListedServer |
Returns properties of a file transfer protocol-enabled server that was specified.
|
| ListedUser |
Returns properties of the user that you specify.
|
| ListedWorkflow |
Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.
|
| ListExecutionsRequest | |
| ListExecutionsResponse | |
| ListSecurityPoliciesRequest | |
| ListSecurityPoliciesResponse | |
| ListServersRequest | |
| ListServersResponse | |
| ListTagsForResourceRequest | |
| ListTagsForResourceResponse | |
| ListUsersRequest | |
| ListUsersResponse | |
| ListWorkflowsRequest | |
| ListWorkflowsResponse | |
| 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. |
| ProtocolDetails |
The protocol settings that are configured for your server.
|
| S3FileLocation |
Specifies the details for the file location for the file being used in the workflow.
|
| S3InputFileLocation |
Specifies the customer input S3 file location.
|
| S3Tag |
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
|
| SendWorkflowStepStateRequest | |
| SendWorkflowStepStateResponse | |
| ServiceMetadata |
A container object for the session details associated with a workflow.
|
| SshPublicKey |
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). |
| StartServerRequest | |
| StartServerResponse | |
| StopServerRequest | |
| StopServerResponse | |
| Tag |
Creates a key-value pair for a specific resource.
|
| TagResourceRequest | |
| TagResourceResponse | |
| TagStepDetails |
Each step type has its own
StepDetails structure. |
| TestIdentityProviderRequest | |
| TestIdentityProviderResponse | |
| TransferRequest | |
| TransferResponse | |
| TransferResponseMetadata | |
| UntagResourceRequest | |
| UntagResourceResponse | |
| UpdateAccessRequest | |
| UpdateAccessResponse | |
| UpdateServerRequest | |
| UpdateServerResponse | |
| UpdateUserRequest | |
| UpdateUserResponse |
UpdateUserResponse returns the user name and identifier for the request to update a user's properties. |
| UserDetails |
Specifies the user name, server ID, and session ID for a workflow.
|
| WorkflowDetail |
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
|
| WorkflowDetails |
Container for the
WorkflowDetail data type. |
| WorkflowStep |
The basic building block of a workflow.
|
| Enum | Description |
|---|---|
| CustomStepStatus | |
| Domain | |
| EndpointType | |
| ExecutionErrorType | |
| ExecutionStatus | |
| HomeDirectoryType | |
| IdentityProviderType |
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled
server's users.
|
| OverwriteExisting | |
| Protocol | |
| State |
Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file
operations.
|
| WorkflowStepType |
| Exception | Description |
|---|---|
| AccessDeniedException |
You do not have sufficient access to perform this action.
|
| ConflictException |
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. |
| InternalServiceErrorException |
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
|
| InvalidNextTokenException |
The
NextToken parameter that was passed is invalid. |
| InvalidRequestException |
This exception is thrown when the client submits a malformed request.
|
| ResourceExistsException |
The requested resource does not exist.
|
| ResourceNotFoundException |
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
|
| ServiceUnavailableException |
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
|
| ThrottlingException |
The request was denied due to request throttling.
|
| TransferException |