Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/transfer.ts?docs=full";

§Classes

Transfer

§Interfaces

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
DeleteServerRequest
DeleteSshPublicKeyRequest
DeleteStepDetails

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

DeleteUserRequest
DeleteWorkflowRequest
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. For more information about security policies, see Working with security policies.

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. 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.

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. A server can have only one method of authentication.

ImportSshPublicKeyRequest
ImportSshPublicKeyResponse

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.

InputFileLocation

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

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. 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 being used in the workflow. Only applicable if you are using S3 storage.

S3InputFileLocation

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

S3Tag

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

SendWorkflowStepStateRequest
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). 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.

StartServerRequest
StopServerRequest
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.

TagResourceRequest
TagStepDetails

Each step type has its own StepDetails structure.

TestIdentityProviderRequest
TestIdentityProviderResponse
UntagResourceRequest
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. It is used by actions that trigger a workflow to begin execution.

WorkflowStep

The basic building block of a workflow.

§Type Aliases

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. For AWS_DIRECTORY_SERVICE or SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on the server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. The server can have only one method of authentication.

OverwriteExisting
Protocol
State

Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

TlsSessionResumptionMode
WorkflowStepType