AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.Transfer

Inherits:
AWS.Service show all
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 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();

Version:

  • 2018-11-05

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a Transfer object

var transfer = new AWS.Transfer({apiVersion: '2018-11-05'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Transfer.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Transfer.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Transfer.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

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.

Service Reference:

Examples:

Calling the createServer operation

var params = {
  Certificate: 'STRING_VALUE',
  EndpointDetails: {
    AddressAllocationIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ],
    VpcEndpointId: 'STRING_VALUE',
    VpcId: 'STRING_VALUE'
  },
  EndpointType: PUBLIC | VPC | VPC_ENDPOINT,
  HostKey: 'STRING_VALUE',
  IdentityProviderDetails: {
    InvocationRole: 'STRING_VALUE',
    Url: 'STRING_VALUE'
  },
  IdentityProviderType: SERVICE_MANAGED | API_GATEWAY,
  LoggingRole: 'STRING_VALUE',
  Protocols: [
    SFTP | FTP | FTPS,
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transfer.createServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Certificate — (String)

      The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

      To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

      To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

      To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

      Certificates with the following cryptographic algorithms and key sizes are supported:

      • 2048-bit RSA (RSA_2048)

      • 4096-bit RSA (RSA_4096)

      • Elliptic Prime Curve 256 bit (EC_prime256v1)

      • Elliptic Prime Curve 384 bit (EC_secp384r1)

      • Elliptic Prime Curve 521 bit (EC_secp521r1)

      Note: The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
    • EndpointDetails — (map)

      The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

      • AddressAllocationIds — (Array<String>)

        A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the UpdateServer API.

        Note: This property can only be use when EndpointType is set to VPC.
      • SubnetIds — (Array<String>)

        A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

        Note: This property can only be used when EndpointType is set to VPC.
      • VpcEndpointId — (String)

        The ID of the VPC endpoint.

        Note: This property can only be used when EndpointType is set to VPC_ENDPOINT.
      • VpcId — (String)

        The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.

        Note: This property can only be used when EndpointType is set to VPC.
    • EndpointType — (String)

      The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

      Note: It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
      Possible values include:
      • "PUBLIC"
      • "VPC"
      • "VPC_ENDPOINT"
    • HostKey — (String)

      The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key command.

      If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

      For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

    • IdentityProviderDetails — (map)

      Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

      • Url — (String)

        Provides the location of the service endpoint used to authenticate users.

      • InvocationRole — (String)

        Provides the type of InvocationRole used to authenticate the user account.

    • IdentityProviderType — (String)

      Specifies the mode of authentication for a file transfer protocol-enabled server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

      Possible values include:
      • "SERVICE_MANAGED"
      • "API_GATEWAY"
    • LoggingRole — (String)

      Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

    • Protocols — (Array<String>)

      Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

      • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

      • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

      • FTP (File Transfer Protocol): Unencrypted file transfer

      Note: If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS. If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY. If Protocol includes FTP, then AddressAllocationIds cannot be associated. If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
    • Tags — (Array<map>)

      Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.

      • Key — required — (String)

        The name assigned to the tag that you create.

      • Value — required — (String)

        Contains one or more values that you assigned to the key name you create.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerId — (String)

        The service-assigned ID of the file transfer protocol-enabled server that is created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createUser operation

var params = {
  Role: 'STRING_VALUE', /* required */
  ServerId: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE', /* required */
  HomeDirectory: 'STRING_VALUE',
  HomeDirectoryMappings: [
    {
      Entry: 'STRING_VALUE', /* required */
      Target: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  HomeDirectoryType: PATH | LOGICAL,
  Policy: 'STRING_VALUE',
  SshPublicKeyBody: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transfer.createUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HomeDirectory — (String)

      The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using the client.

      An example is your-Amazon-S3-bucket-name>/home/username .

    • HomeDirectoryType — (String)

      The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

      Possible values include:
      • "PATH"
      • "LOGICAL"
    • HomeDirectoryMappings — (Array<map>)

      Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.

      '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

      In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      Note: If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a '/' for it to be considered a folder.
      • Entry — required — (String)

        Represents an entry and a target for HomeDirectoryMappings.

      • Target — required — (String)

        Represents the map target that is used in a HomeDirectorymapEntry.

    • Policy — (String)

      A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

      Note: For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument. For an example of a scope-down policy, see Creating a scope-down policy. For more information, see AssumeRole in the AWS Security Token Service API Reference.
    • Role — (String)

      The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.

    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server instance. This is the specific server that you added your user to.

    • SshPublicKeyBody — (String)

      The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer protocol-enabled server.

    • Tags — (Array<map>)

      Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

      • Key — required — (String)

        The name assigned to the tag that you create.

      • Value — required — (String)

        Contains one or more values that you assigned to the key name you create.

    • UserName — (String)

      A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerId — (String)

        The ID of the file transfer protocol-enabled server that the user is attached to.

      • UserName — (String)

        A unique string that identifies a user account associated with a file transfer protocol-enabled server.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteServer(params = {}, callback) ⇒ AWS.Request

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

No response returns from this operation.

Service Reference:

Examples:

Calling the deleteServer operation

var params = {
  ServerId: 'STRING_VALUE' /* required */
};
transfer.deleteServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A unique system-assigned identifier for a file transfer protocol-enabled server instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSshPublicKey(params = {}, callback) ⇒ AWS.Request

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

No response is returned from this operation.

Service Reference:

Examples:

Calling the deleteSshPublicKey operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  SshPublicKeyId: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE' /* required */
};
transfer.deleteSshPublicKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

    • SshPublicKeyId — (String)

      A unique identifier used to reference your user's specific SSH key.

    • UserName — (String)

      A unique string that identifies a user whose public key is being deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteUser(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteUser operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE' /* required */
};
transfer.deleteUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

    • UserName — (String)

      A unique string that identifies a user that is being deleted from a file transfer protocol-enabled server.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the describeServer operation

var params = {
  ServerId: 'STRING_VALUE' /* required */
};
transfer.describeServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Server — (map)

        An array containing the properties of a file transfer protocol-enabled server with the ServerID you specified.

        • Arn — required — (String)

          Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.

        • Certificate — (String)

          Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

        • EndpointDetails — (map)

          Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

          • AddressAllocationIds — (Array<String>)

            A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the UpdateServer API.

            Note: This property can only be use when EndpointType is set to VPC.
          • SubnetIds — (Array<String>)

            A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

            Note: This property can only be used when EndpointType is set to VPC.
          • VpcEndpointId — (String)

            The ID of the VPC endpoint.

            Note: This property can only be used when EndpointType is set to VPC_ENDPOINT.
          • VpcId — (String)

            The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.

            Note: This property can only be used when EndpointType is set to VPC.
        • EndpointType — (String)

          Defines the type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

          Possible values include:
          • "PUBLIC"
          • "VPC"
          • "VPC_ENDPOINT"
        • HostKeyFingerprint — (String)

          Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

        • IdentityProviderDetails — (map)

          Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

          • Url — (String)

            Provides the location of the service endpoint used to authenticate users.

          • InvocationRole — (String)

            Provides the type of InvocationRole used to authenticate the user account.

        • IdentityProviderType — (String)

          Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

          Possible values include:
          • "SERVICE_MANAGED"
          • "API_GATEWAY"
        • LoggingRole — (String)

          Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

        • Protocols — (Array<String>)

          Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

          • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

          • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

          • FTP (File Transfer Protocol): Unencrypted file transfer

        • ServerId — (String)

          Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

        • State — (String)

          Specifies the condition of a file transfer protocol-enabled server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

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

          Possible values include:
          • "OFFLINE"
          • "ONLINE"
          • "STARTING"
          • "STOPPING"
          • "START_FAILED"
          • "STOP_FAILED"
        • Tags — (Array<map>)

          Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

          • Key — required — (String)

            The name assigned to the tag that you create.

          • Value — required — (String)

            Contains one or more values that you assigned to the key name you create.

        • UserCount — (Integer)

          Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the describeUser operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE' /* required */
};
transfer.describeUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.

    • UserName — (String)

      The name of the user assigned to one or more file transfer protocol-enabled servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform file transfer tasks.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerId — (String)

        A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.

      • User — (map)

        An array containing the properties of the user account for the ServerID value that you specified.

        • Arn — required — (String)

          Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

        • HomeDirectory — (String)

          Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is your-Amazon-S3-bucket-name>/home/username .

        • HomeDirectoryMappings — (Array<map>)

          Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

          In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

          • Entry — required — (String)

            Represents an entry and a target for HomeDirectoryMappings.

          • Target — required — (String)

            Represents the map target that is used in a HomeDirectorymapEntry.

        • HomeDirectoryType — (String)

          Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

          Possible values include:
          • "PATH"
          • "LOGICAL"
        • Policy — (String)

          Specifies the name of the policy in use for the described user.

        • Role — (String)

          Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.

        • SshPublicKeys — (Array<map>)

          Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

          • DateImported — required — (Date)

            Specifies the date that the public key was added to the user account.

          • SshPublicKeyBody — required — (String)

            Specifies the content of the SSH public key as specified by the PublicKeyId.

          • SshPublicKeyId — required — (String)

            Specifies the SshPublicKeyId parameter contains the identifier of the public key.

        • Tags — (Array<map>)

          Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

          • Key — required — (String)

            The name assigned to the tag that you create.

          • Value — required — (String)

            Contains one or more values that you assigned to the key name you create.

        • UserName — (String)

          Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the importSshPublicKey operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  SshPublicKeyBody: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE' /* required */
};
transfer.importSshPublicKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server.

    • SshPublicKeyBody — (String)

      The public key portion of an SSH key pair.

    • UserName — (String)

      The name of the user account that is assigned to one or more file transfer protocol-enabled servers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerId — (String)

        A system-assigned unique identifier for a file transfer protocol-enabled server.

      • SshPublicKeyId — (String)

        The name given to a public key by the system that was imported.

      • UserName — (String)

        A user name assigned to the ServerID value that you specified.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listServers(params = {}, callback) ⇒ AWS.Request

Lists the file transfer protocol-enabled servers that are associated with your AWS account.

Service Reference:

Examples:

Calling the listServers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
transfer.listServers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      Specifies the number of file transfer protocol-enabled servers to return as a response to the ListServers query.

    • NextToken — (String)

      When additional results are obtained from theListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional file transfer protocol-enabled servers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional file transfer protocol-enabled servers.

      • Servers — (Array<map>)

        An array of file transfer protocol-enabled servers that were listed.

        • Arn — required — (String)

          Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be listed.

        • IdentityProviderType — (String)

          Specifies the authentication method used to validate a user for a file transfer protocol-enabled server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

          Possible values include:
          • "SERVICE_MANAGED"
          • "API_GATEWAY"
        • EndpointType — (String)

          Specifies the type of VPC endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

          Possible values include:
          • "PUBLIC"
          • "VPC"
          • "VPC_ENDPOINT"
        • LoggingRole — (String)

          Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging.

        • ServerId — (String)

          Specifies the unique system assigned identifier for a file transfer protocol-enabled servers that were listed.

        • State — (String)

          Specifies the condition of a file transfer protocol-enabled server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

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

          Possible values include:
          • "OFFLINE"
          • "ONLINE"
          • "STARTING"
          • "STOPPING"
          • "START_FAILED"
          • "STOP_FAILED"
        • UserCount — (Integer)

          Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
transfer.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Arn — (String)

      Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role.

    • MaxResults — (Integer)

      Specifies the number of tags to return as a response to the ListTagsForResource request.

    • NextToken — (String)

      When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN you specified to list the tags of.

      • NextToken — (String)

        When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

      • Tags — (Array<map>)

        Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

          Contains one or more values that you assigned to the key name you create.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listUsers(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listUsers operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
transfer.listUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      Specifies the number of users to return as a response to the ListUsers request.

    • NextToken — (String)

      When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server that has users assigned to it.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

      • ServerId — (String)

        A system-assigned unique identifier for a file transfer protocol-enabled server that the users are assigned to.

      • Users — (Array<map>)

        Returns the user accounts and their properties for the ServerId value that you specify.

        • Arn — required — (String)

          Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

        • HomeDirectory — (String)

          Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

        • HomeDirectoryType — (String)

          Specifies the type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

          Possible values include:
          • "PATH"
          • "LOGICAL"
        • Role — (String)

          Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

        • SshPublicKeyCount — (Integer)

          Specifies the number of SSH public keys stored for the user you specified.

        • UserName — (String)

          Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the startServer operation

var params = {
  ServerId: 'STRING_VALUE' /* required */
};
transfer.startServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server that you start.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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. Stopping the server will not reduce or impact your file transfer protocol endpoint billing.

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.

Service Reference:

Examples:

Calling the stopServer operation

var params = {
  ServerId: 'STRING_VALUE' /* required */
};
transfer.stopServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server that you stopped.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transfer.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Arn — (String)

      An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role.

    • Tags — (Array<map>)

      Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.

      • Key — required — (String)

        The name assigned to the tag that you create.

      • Value — required — (String)

        Contains one or more values that you assigned to the key name you create.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the testIdentityProvider operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE', /* required */
  ServerProtocol: SFTP | FTP | FTPS,
  SourceIp: 'STRING_VALUE',
  UserPassword: 'STRING_VALUE'
};
transfer.testIdentityProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServerId — (String)

      A system-assigned identifier for a specific file transfer protocol-enabled server. That server's user authentication method is tested with a user name and password.

    • ServerProtocol — (String)

      The type of file transfer protocol to be tested.

      The available protocols are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP)

      • File Transfer Protocol Secure (FTPS)

      • File Transfer Protocol (FTP)

      Possible values include:
      • "SFTP"
      • "FTP"
      • "FTPS"
    • SourceIp — (String)

      The source IP address of the user account to be tested.

    • UserName — (String)

      The name of the user account to be tested.

    • UserPassword — (String)

      The password of the user account to be tested.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Response — (String)

        The response that is returned from your API Gateway.

      • StatusCode — (Integer)

        The HTTP status code that is the response from your API Gateway.

      • Message — (String)

        A message that indicates whether the test was successful or not.

      • Url — (String)

        The endpoint of the service used to authenticate a user.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
transfer.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Arn — (String)

      The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

    • TagKeys — (Array<String>)

      TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateServer(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateServer operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  Certificate: 'STRING_VALUE',
  EndpointDetails: {
    AddressAllocationIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ],
    VpcEndpointId: 'STRING_VALUE',
    VpcId: 'STRING_VALUE'
  },
  EndpointType: PUBLIC | VPC | VPC_ENDPOINT,
  HostKey: 'STRING_VALUE',
  IdentityProviderDetails: {
    InvocationRole: 'STRING_VALUE',
    Url: 'STRING_VALUE'
  },
  LoggingRole: 'STRING_VALUE',
  Protocols: [
    SFTP | FTP | FTPS,
    /* more items */
  ]
};
transfer.updateServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Certificate — (String)

      The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

      To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

      To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

      To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

      Certificates with the following cryptographic algorithms and key sizes are supported:

      • 2048-bit RSA (RSA_2048)

      • 4096-bit RSA (RSA_4096)

      • Elliptic Prime Curve 256 bit (EC_prime256v1)

      • Elliptic Prime Curve 384 bit (EC_secp384r1)

      • Elliptic Prime Curve 521 bit (EC_secp521r1)

      Note: The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
    • EndpointDetails — (map)

      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 to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

      • AddressAllocationIds — (Array<String>)

        A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the UpdateServer API.

        Note: This property can only be use when EndpointType is set to VPC.
      • SubnetIds — (Array<String>)

        A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

        Note: This property can only be used when EndpointType is set to VPC.
      • VpcEndpointId — (String)

        The ID of the VPC endpoint.

        Note: This property can only be used when EndpointType is set to VPC_ENDPOINT.
      • VpcId — (String)

        The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.

        Note: This property can only be used when EndpointType is set to VPC.
    • EndpointType — (String)

      The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

      Note: It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
      Possible values include:
      • "PUBLIC"
      • "VPC"
      • "VPC_ENDPOINT"
    • HostKey — (String)

      The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

      If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

      For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

    • IdentityProviderDetails — (map)

      An array containing all of the information required to call a customer's authentication API method.

      • Url — (String)

        Provides the location of the service endpoint used to authenticate users.

      • InvocationRole — (String)

        Provides the type of InvocationRole used to authenticate the user account.

    • LoggingRole — (String)

      Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    • Protocols — (Array<String>)

      Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

      • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

      • File Transfer Protocol (FTP): Unencrypted file transfer

      Note: If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS. If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY. If Protocol includes FTP, then AddressAllocationIds cannot be associated. If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerId — (String)

        A system-assigned unique identifier for a file transfer protocol-enabled server that the user account is assigned to.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateUser(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateUser operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE', /* required */
  HomeDirectory: 'STRING_VALUE',
  HomeDirectoryMappings: [
    {
      Entry: 'STRING_VALUE', /* required */
      Target: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  HomeDirectoryType: PATH | LOGICAL,
  Policy: 'STRING_VALUE',
  Role: 'STRING_VALUE'
};
transfer.updateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HomeDirectory — (String)

      Specifies the landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using their file transfer protocol client.

      An example is your-Amazon-S3-bucket-name>/home/username.

    • HomeDirectoryType — (String)

      The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

      Possible values include:
      • "PATH"
      • "LOGICAL"
    • HomeDirectoryMappings — (Array<map>)

      Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.

      '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

      In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      Note: If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
      • Entry — required — (String)

        Represents an entry and a target for HomeDirectoryMappings.

      • Target — required — (String)

        Represents the map target that is used in a HomeDirectorymapEntry.

    • Policy — (String)

      Allows you to supply a scope-down policy for your user so you can use the same IAM role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

      Note: For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument. For an example of a scope-down policy, see Creating a scope-down policy. For more information, see AssumeRole in the AWS Security Token Service API Reference.
    • Role — (String)

      The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.

    • ServerId — (String)

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

    • UserName — (String)

      A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This is the string that will be used by your user when they log in to your server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServerId — (String)

        A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

      • UserName — (String)

        The unique identifier for a user that is assigned to a file transfer protocol-enabled server instance that was specified in the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.