Transfer

import { Transfer } from "https://aws-api.deno.dev/v0.2/services/transfer.ts?docs=full";

class Transfer {

constructor(apiFactory: client.ApiFactory);

async createAccess(params: CreateAccessRequest, opts?: client.RequestOptions): Promise<CreateAccessResponse>;

async createServer(params?: CreateServerRequest, opts?: client.RequestOptions): Promise<CreateServerResponse>;

async createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<CreateUserResponse>;

async deleteAccess(params: DeleteAccessRequest, opts?: client.RequestOptions): Promise<void>;

async deleteServer(params: DeleteServerRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSshPublicKey(params: DeleteSshPublicKeyRequest, opts?: client.RequestOptions): Promise<void>;

async deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>;

async describeAccess(params: DescribeAccessRequest, opts?: client.RequestOptions): Promise<DescribeAccessResponse>;

async describeSecurityPolicy(params: DescribeSecurityPolicyRequest, opts?: client.RequestOptions): Promise<DescribeSecurityPolicyResponse>;

async describeServer(params: DescribeServerRequest, opts?: client.RequestOptions): Promise<DescribeServerResponse>;

async describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>;

async importSshPublicKey(params: ImportSshPublicKeyRequest, opts?: client.RequestOptions): Promise<ImportSshPublicKeyResponse>;

async listAccesses(params: ListAccessesRequest, opts?: client.RequestOptions): Promise<ListAccessesResponse>;

async listSecurityPolicies(params?: ListSecurityPoliciesRequest, opts?: client.RequestOptions): Promise<ListSecurityPoliciesResponse>;

async listServers(params?: ListServersRequest, opts?: client.RequestOptions): Promise<ListServersResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>;

async startServer(params: StartServerRequest, opts?: client.RequestOptions): Promise<void>;

async stopServer(params: StopServerRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async testIdentityProvider(params: TestIdentityProviderRequest, opts?: client.RequestOptions): Promise<TestIdentityProviderResponse>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateAccess(params: UpdateAccessRequest, opts?: client.RequestOptions): Promise<UpdateAccessResponse>;

async updateServer(params: UpdateServerRequest, opts?: client.RequestOptions): Promise<UpdateServerResponse>;

async updateUser(params: UpdateUserRequest, opts?: client.RequestOptions): Promise<UpdateUserResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Transfer(apiFactory: client.ApiFactory)

[src]

§Methods

createAccess(params: CreateAccessRequest, opts?: client.RequestOptions): Promise<CreateAccessResponse>

[src]

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

createServer(params?: CreateServerRequest, opts?: client.RequestOptions): Promise<CreateServerResponse>

[src]

Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

createUser(params: CreateUserRequest, opts?: client.RequestOptions): Promise<CreateUserResponse>

[src]

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Amazon Web Services Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

deleteAccess(params: DeleteAccessRequest, opts?: client.RequestOptions): Promise<void>

[src]

Allows you to delete the access specified in the ServerID and ExternalID parameters.

deleteServer(params: DeleteServerRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the file transfer protocol-enabled server that you specify.

No response returns from this operation.

deleteSshPublicKey(params: DeleteSshPublicKeyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a user's Secure Shell (SSH) public key.

No response is returned from this operation.

deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the user belonging to a file transfer protocol-enabled server you specify.

No response returns from this operation.

Note: When you delete a user from a server, the user's information is lost.

describeAccess(params: DescribeAccessRequest, opts?: client.RequestOptions): Promise<DescribeAccessResponse>

[src]

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalID.

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

describeSecurityPolicy(params: DescribeSecurityPolicyRequest, opts?: client.RequestOptions): Promise<DescribeSecurityPolicyResponse>

[src]

Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies.

describeServer(params: DescribeServerRequest, opts?: client.RequestOptions): Promise<DescribeServerResponse>

[src]

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>

[src]

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

importSshPublicKey(params: ImportSshPublicKeyRequest, opts?: client.RequestOptions): Promise<ImportSshPublicKeyResponse>

[src]

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

listAccesses(params: ListAccessesRequest, opts?: client.RequestOptions): Promise<ListAccessesResponse>

[src]

Lists the details for all the accesses you have on your server.

listSecurityPolicies(params?: ListSecurityPoliciesRequest, opts?: client.RequestOptions): Promise<ListSecurityPoliciesResponse>

[src]

Lists the security policies that are attached to your file transfer protocol-enabled servers.

listServers(params?: ListServersRequest, opts?: client.RequestOptions): Promise<ListServersResponse>

[src]

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>

[src]

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

startServer(params: StartServerRequest, opts?: client.RequestOptions): Promise<void>

[src]

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

stopServer(params: StopServerRequest, opts?: client.RequestOptions): Promise<void>

[src]

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Note: Stopping the server will not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

testIdentityProvider(params: TestIdentityProviderRequest, opts?: client.RequestOptions): Promise<TestIdentityProviderResponse>

[src]

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

updateAccess(params: UpdateAccessRequest, opts?: client.RequestOptions): Promise<UpdateAccessResponse>

[src]

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

updateServer(params: UpdateServerRequest, opts?: client.RequestOptions): Promise<UpdateServerResponse>

[src]

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

updateUser(params: UpdateUserRequest, opts?: client.RequestOptions): Promise<UpdateUserResponse>

[src]

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]