Class: AWS.Transfer
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Transfer
- Identifier:
- transfer
- API Version:
- 2018-11-05
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
AWS Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.
Sending a Request Using Transfer
var transfer = new AWS.Transfer();
transfer.createServer(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Transfer object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var transfer = new AWS.Transfer({apiVersion: '2018-11-05'});
You can also set the API version globally in AWS.config.apiVersions
using
the transfer service identifier:
AWS.config.apiVersions = {
transfer: '2018-11-05',
// other service API versions
};
var transfer = new AWS.Transfer();
Constructor Summary collapse
-
new AWS.Transfer(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createServer(params = {}, callback) ⇒ AWS.Request
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS.
-
createUser(params = {}, callback) ⇒ AWS.Request
Creates a user and associates them with an existing file transfer protocol-enabled server.
-
deleteServer(params = {}, callback) ⇒ AWS.Request
Deletes the file transfer protocol-enabled server that you specify.
-
deleteSshPublicKey(params = {}, callback) ⇒ AWS.Request
Deletes a user's Secure Shell (SSH) public key.
-
deleteUser(params = {}, callback) ⇒ AWS.Request
Deletes the user belonging to a file transfer protocol-enabled server you specify.
-
describeSecurityPolicy(params = {}, callback) ⇒ AWS.Request
Describes the security policy that is attached to your file transfer protocol-enabled server.
-
describeServer(params = {}, callback) ⇒ AWS.Request
Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
-
describeUser(params = {}, callback) ⇒ AWS.Request
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.
-
importSshPublicKey(params = {}, callback) ⇒ AWS.Request
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.
-
listSecurityPolicies(params = {}, callback) ⇒ AWS.Request
Lists the security policies that are attached to your file transfer protocol-enabled servers.
-
listServers(params = {}, callback) ⇒ AWS.Request
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify.
-
listUsers(params = {}, callback) ⇒ AWS.Request
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
-
startServer(params = {}, callback) ⇒ AWS.Request
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE.
-
stopServer(params = {}, callback) ⇒ AWS.Request
Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
-
testIdentityProvider(params = {}, callback) ⇒ AWS.Request
If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway is set up successfully.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
-
updateServer(params = {}, callback) ⇒ AWS.Request
Updates the file transfer protocol-enabled server's properties after that server has been created.
-
updateUser(params = {}, callback) ⇒ AWS.Request
Assigns new properties to a user.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.Transfer(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
createServer(params = {}, callback) ⇒ AWS.Request
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. 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 = {}, callback) ⇒ AWS.Request
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 AWS 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.
deleteServer(params = {}, callback) ⇒ AWS.Request
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
deleteSshPublicKey(params = {}, callback) ⇒ AWS.Request
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
deleteUser(params = {}, callback) ⇒ AWS.Request
Deletes the user belonging to a file transfer protocol-enabled server you specify.
No response returns from this operation.
describeSecurityPolicy(params = {}, callback) ⇒ AWS.Request
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 = {}, callback) ⇒ AWS.Request
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 = {}, callback) ⇒ AWS.Request
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 = {}, callback) ⇒ AWS.Request
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
.
listSecurityPolicies(params = {}, callback) ⇒ AWS.Request
Lists the security policies that are attached to your file transfer protocol-enabled servers.
listServers(params = {}, callback) ⇒ AWS.Request
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
listUsers(params = {}, callback) ⇒ AWS.Request
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId
parameter.
startServer(params = {}, callback) ⇒ AWS.Request
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 = {}, callback) ⇒ AWS.Request
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.
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 = {}, callback) ⇒ AWS.Request
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 = {}, callback) ⇒ AWS.Request
If the IdentityProviderType
of a file transfer protocol-enabled server is API_Gateway
, tests whether your API Gateway 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 API Gateway integration to ensure that your users can successfully use the service.
untagResource(params = {}, callback) ⇒ AWS.Request
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.