You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

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

Amazon Web Services 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). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services 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 Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Amazon Web Services 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.createAccess(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|AWS.Endpoint)

    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' or an Endpoint object.

  • 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. The function is only called for retryable errors.
  • 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

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

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

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.

Service Reference:

Examples:

Calling the createAccess operation

var params = {
  ExternalId: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  ServerId: 'STRING_VALUE', /* required */
  HomeDirectory: 'STRING_VALUE',
  HomeDirectoryMappings: [
    {
      Entry: 'STRING_VALUE', /* required */
      Target: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  HomeDirectoryType: PATH | LOGICAL,
  Policy: 'STRING_VALUE',
  PosixProfile: {
    Gid: 'NUMBER_VALUE', /* required */
    Uid: 'NUMBER_VALUE', /* required */
    SecondaryGids: [
      'NUMBER_VALUE',
      /* more items */
    ]
  }
};
transfer.createAccess(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 server using the client.

      A HomeDirectory example is /bucket_name/home/mydirectory.

    • HomeDirectoryType — (String)

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

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

      Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

      The following is an Entry and Target pair example.

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

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

      The following is an Entry and Target pair example for chroot.

      [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

      Note: If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs 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.
      • Entryrequired — (String)

        Represents an entry for HomeDirectoryMappings.

      • Targetrequired — (String)

        Represents the map target that is used in a HomeDirectorymapEntry.

    • Policy — (String)

      A session policy for your user so that 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: This only applies when the domain of ServerId is S3. EFS does not use session policies. For session policies, Amazon Web Services 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 session policy, see Example session policy. For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
    • PosixProfile — (map)

      The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

      • Uidrequired — (Integer)

        The POSIX user ID used for all EFS operations by this user.

      • Gidrequired — (Integer)

        The POSIX group ID used for all EFS operations by this user.

      • SecondaryGids — (Array<Integer>)

        The secondary POSIX group IDs used for all EFS operations by this user.

    • Role — (String)

      Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

    • ServerId — (String)

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

    • ExternalId — (String)

      A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

      Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

      In that command, replace YourGroupName with the name of your Active Directory group.

      The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

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 server that the user is attached to.

      • ExternalId — (String)

        The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family.

Returns:

  • (AWS.Request)

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

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

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.

Service Reference:

Examples:

Calling the createServer operation

var params = {
  Certificate: 'STRING_VALUE',
  Domain: S3 | EFS,
  EndpointDetails: {
    AddressAllocationIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ],
    VpcEndpointId: 'STRING_VALUE',
    VpcId: 'STRING_VALUE'
  },
  EndpointType: PUBLIC | VPC | VPC_ENDPOINT,
  HostKey: 'STRING_VALUE',
  IdentityProviderDetails: {
    DirectoryId: 'STRING_VALUE',
    InvocationRole: 'STRING_VALUE',
    Url: 'STRING_VALUE'
  },
  IdentityProviderType: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE,
  LoggingRole: 'STRING_VALUE',
  Protocols: [
    SFTP | FTP | FTPS,
    /* more items */
  ],
  SecurityPolicyName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  WorkflowDetails: {
    OnUpload: [ /* required */
      {
        ExecutionRole: 'STRING_VALUE', /* required */
        WorkflowId: '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 Amazon Web Services Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

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

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

      To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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.
    • Domain — (String)

      The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

      Note: After the server is created, the domain cannot be changed.
      Possible values include:
      • "S3"
      • "EFS"
    • EndpointDetails — (map)

      The virtual private cloud (VPC) endpoint settings that are configured for your 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 IP addresses 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 server's endpoint.

        Note: This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.
      • SubnetIds — (Array<String>)

        A list of subnet IDs that are required to host your server endpoint in your VPC.

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

        The ID of the VPC endpoint.

        Note: This property can only be set when EndpointType is set to VPC_ENDPOINT. For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
      • VpcId — (String)

        The VPC ID of the VPC in which a server's endpoint will be hosted.

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

        A list of security groups IDs that are available to attach to your server's endpoint.

        Note: This property can only be set when EndpointType is set to VPC. You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.
    • EndpointType — (String)

      The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

      Note: After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC. For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. 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 Amazon Web Services Transfer Family User Guide.

    • IdentityProviderDetails — (map)

      Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke 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.

      • DirectoryId — (String)

        The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.

    • IdentityProviderType — (String)

      Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

      Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

      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"
      • "AWS_DIRECTORY_SERVICE"
    • LoggingRole — (String)

      Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS 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

      Note: If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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.
    • SecurityPolicyName — (String)

      Specifies the name of the security policy that is attached to the server.

    • Tags — (Array<map>)

      Key-value pairs that can be used to group and search for servers.

      • Keyrequired — (String)

        The name assigned to the tag that you create.

      • Valuerequired — (String)

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

    • WorkflowDetails — (map)

      Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

      • OnUploadrequired — (Array<map>)

        A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

        • WorkflowIdrequired — (String)

          A unique identifier for the workflow.

        • ExecutionRolerequired — (String)

          Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

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 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 Amazon Web Services Identity and Access Management (IAM) role. You can also optionally add a session 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',
  PosixProfile: {
    Gid: 'NUMBER_VALUE', /* required */
    Uid: 'NUMBER_VALUE', /* required */
    SecondaryGids: [
      'NUMBER_VALUE',
      /* more items */
    ]
  },
  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 server using the client.

      A HomeDirectory example is /bucket_name/home/mydirectory.

    • HomeDirectoryType — (String)

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

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

      Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

      The following is an Entry and Target pair example.

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

      In most cases, you can use this value instead of the session 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.

      The following is an Entry and Target pair example for chroot.

      [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

      Note: If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs 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.
      • Entryrequired — (String)

        Represents an entry for HomeDirectoryMappings.

      • Targetrequired — (String)

        Represents the map target that is used in a HomeDirectorymapEntry.

    • Policy — (String)

      A session policy for your user so that 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: This only applies when the domain of ServerId is S3. EFS does not use session policies. For session policies, Amazon Web Services 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 session policy, see Example session policy. For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
    • PosixProfile — (map)

      Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

      • Uidrequired — (Integer)

        The POSIX user ID used for all EFS operations by this user.

      • Gidrequired — (Integer)

        The POSIX group ID used for all EFS operations by this user.

      • SecondaryGids — (Array<Integer>)

        The secondary POSIX group IDs used for all EFS operations by this user.

    • Role — (String)

      Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

    • ServerId — (String)

      A system-assigned unique identifier for a 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 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.

      • Keyrequired — (String)

        The name assigned to the tag that you create.

      • Valuerequired — (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 ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

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 server that the user is attached to.

      • UserName — (String)

        A unique string that identifies a user account associated with a server.

Returns:

  • (AWS.Request)

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

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

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

Service Reference:

Examples:

Calling the createWorkflow operation

var params = {
  Steps: [ /* required */
    {
      CopyStepDetails: {
        DestinationFileLocation: {
          EfsFileLocation: {
            FileSystemId: 'STRING_VALUE',
            Path: 'STRING_VALUE'
          },
          S3FileLocation: {
            Bucket: 'STRING_VALUE',
            Key: 'STRING_VALUE'
          }
        },
        Name: 'STRING_VALUE',
        OverwriteExisting: TRUE | FALSE
      },
      CustomStepDetails: {
        Name: 'STRING_VALUE',
        Target: 'STRING_VALUE',
        TimeoutSeconds: 'NUMBER_VALUE'
      },
      DeleteStepDetails: {
        Name: 'STRING_VALUE'
      },
      TagStepDetails: {
        Name: 'STRING_VALUE',
        Tags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      Type: COPY | CUSTOM | TAG | DELETE
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  OnExceptionSteps: [
    {
      CopyStepDetails: {
        DestinationFileLocation: {
          EfsFileLocation: {
            FileSystemId: 'STRING_VALUE',
            Path: 'STRING_VALUE'
          },
          S3FileLocation: {
            Bucket: 'STRING_VALUE',
            Key: 'STRING_VALUE'
          }
        },
        Name: 'STRING_VALUE',
        OverwriteExisting: TRUE | FALSE
      },
      CustomStepDetails: {
        Name: 'STRING_VALUE',
        Target: 'STRING_VALUE',
        TimeoutSeconds: 'NUMBER_VALUE'
      },
      DeleteStepDetails: {
        Name: 'STRING_VALUE'
      },
      TagStepDetails: {
        Name: 'STRING_VALUE',
        Tags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      Type: COPY | CUSTOM | TAG | DELETE
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transfer.createWorkflow(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: {})
    • Description — (String)

      A textual description for the workflow.

    • Steps — (Array<map>)

      Specifies the details for the steps that are in the specified workflow.

      The TYPE specifies which of the following actions is being taken for this step.

      • Copy: copy the file to another location

      • Custom: custom step with a lambda target

      • Delete: delete the file

      • Tag: add a tag to the file

      For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

      • Type — (String)

        Currently, the following step types are supported.

        • Copy: copy the file to another location

        • Custom: custom step with a lambda target

        • Delete: delete the file

        • Tag: add a tag to the file

        Possible values include:
        • "COPY"
        • "CUSTOM"
        • "TAG"
        • "DELETE"
      • CopyStepDetails — (map)

        Details for a step that performs a file copy.

        Consists of the following values:

        • A description

        • An S3 or EFS location for the destination of the file copy.

        • A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

        • Name — (String)

          The name of the step, used as an identifier.

        • DestinationFileLocation — (map)

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

          • S3FileLocation — (map)

            Specifies the details for the S3 file being copied.

            • Bucket — (String)

              Specifies the S3 bucket that contains the file being copied.

            • Key — (String)

              The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

          • EfsFileLocation — (map)

            Specifies the details for the Amazon EFS file being copied.

            • FileSystemId — (String)

              The ID of the file system, assigned by Amazon EFS.

            • Path — (String)

              The pathname for the folder being used by a workflow.

        • OverwriteExisting — (String)

          A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

          Possible values include:
          • "TRUE"
          • "FALSE"
      • CustomStepDetails — (map)

        Details for a step that invokes a lambda function.

        Consists of the lambda function name, target, and timeout (in seconds).

        • Name — (String)

          The name of the step, used as an identifier.

        • Target — (String)

          The ARN for the lambda function that is being called.

        • TimeoutSeconds — (Integer)

          Timeout, in seconds, for the step.

      • DeleteStepDetails — (map)

        You need to specify the name of the file to be deleted.

        • Name — (String)

          The name of the step, used as an identifier.

      • TagStepDetails — (map)

        Details for a step that creates one or more tags.

        You specify one or more tags: each tag contains a key/value pair.

        • Name — (String)

          The name of the step, used as an identifier.

        • Tags — (Array<map>)

          Array that contains from 1 to 10 key/value pairs.

          • Keyrequired — (String)

            The name assigned to the tag that you create.

          • Valuerequired — (String)

            The value that corresponds to the key.

    • OnExceptionSteps — (Array<map>)

      Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

      • Type — (String)

        Currently, the following step types are supported.

        • Copy: copy the file to another location

        • Custom: custom step with a lambda target

        • Delete: delete the file

        • Tag: add a tag to the file

        Possible values include:
        • "COPY"
        • "CUSTOM"
        • "TAG"
        • "DELETE"
      • CopyStepDetails — (map)

        Details for a step that performs a file copy.

        Consists of the following values:

        • A description

        • An S3 or EFS location for the destination of the file copy.

        • A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

        • Name — (String)

          The name of the step, used as an identifier.

        • DestinationFileLocation — (map)

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

          • S3FileLocation — (map)

            Specifies the details for the S3 file being copied.

            • Bucket — (String)

              Specifies the S3 bucket that contains the file being copied.

            • Key — (String)

              The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

          • EfsFileLocation — (map)

            Specifies the details for the Amazon EFS file being copied.

            • FileSystemId — (String)

              The ID of the file system, assigned by Amazon EFS.

            • Path — (String)

              The pathname for the folder being used by a workflow.

        • OverwriteExisting — (String)

          A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

          Possible values include:
          • "TRUE"
          • "FALSE"
      • CustomStepDetails — (map)

        Details for a step that invokes a lambda function.

        Consists of the lambda function name, target, and timeout (in seconds).

        • Name — (String)

          The name of the step, used as an identifier.

        • Target — (String)

          The ARN for the lambda function that is being called.

        • TimeoutSeconds — (Integer)

          Timeout, in seconds, for the step.

      • DeleteStepDetails — (map)

        You need to specify the name of the file to be deleted.

        • Name — (String)

          The name of the step, used as an identifier.

      • TagStepDetails — (map)

        Details for a step that creates one or more tags.

        You specify one or more tags: each tag contains a key/value pair.

        • Name — (String)

          The name of the step, used as an identifier.

        • Tags — (Array<map>)

          Array that contains from 1 to 10 key/value pairs.

          • Keyrequired — (String)

            The name assigned to the tag that you create.

          • Valuerequired — (String)

            The value that corresponds to the key.

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        The name assigned to the tag that you create.

      • Valuerequired — (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:

      • WorkflowId — (String)

        A unique identifier for the workflow.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the deleteAccess operation

var params = {
  ExternalId: 'STRING_VALUE', /* required */
  ServerId: 'STRING_VALUE' /* required */
};
transfer.deleteAccess(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 server that has this user assigned.

    • ExternalId — (String)

      A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

      Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

      In that command, replace YourGroupName with the name of your Active Directory group.

      The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

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.

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

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 server instance that has the user assigned to it.

    • UserName — (String)

      A unique string that identifies a user that is being deleted from a 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.

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

Deletes the specified workflow.

Service Reference:

Examples:

Calling the deleteWorkflow operation

var params = {
  WorkflowId: 'STRING_VALUE' /* required */
};
transfer.deleteWorkflow(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: {})
    • WorkflowId — (String)

      A unique identifier for the workflow.

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.

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

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.

Service Reference:

Examples:

Calling the describeAccess operation

var params = {
  ExternalId: 'STRING_VALUE', /* required */
  ServerId: 'STRING_VALUE' /* required */
};
transfer.describeAccess(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 server that has this access assigned.

    • ExternalId — (String)

      A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

      Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

      In that command, replace YourGroupName with the name of your Active Directory group.

      The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

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 server that has this access assigned.

      • Access — (map)

        The external ID of the server that the access is attached to.

        • HomeDirectory — (String)

          The landing directory (folder) for a user when they log in to the server using the client.

          A HomeDirectory example is /bucket_name/home/mydirectory.

        • HomeDirectoryMappings — (Array<map>)

          Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

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

          • Entryrequired — (String)

            Represents an entry for HomeDirectoryMappings.

          • Targetrequired — (String)

            Represents the map target that is used in a HomeDirectorymapEntry.

        • HomeDirectoryType — (String)

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

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

          A session policy for your user so that 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}.

        • PosixProfile — (map)

          The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

          • Uidrequired — (Integer)

            The POSIX user ID used for all EFS operations by this user.

          • Gidrequired — (Integer)

            The POSIX group ID used for all EFS operations by this user.

          • SecondaryGids — (Array<Integer>)

            The secondary POSIX group IDs used for all EFS operations by this user.

        • Role — (String)

          Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

        • ExternalId — (String)

          A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

          Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

          In that command, replace YourGroupName with the name of your Active Directory group.

          The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Returns:

  • (AWS.Request)

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

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

You can use DescribeExecution to check the details of the execution of the specified workflow.

Service Reference:

Examples:

Calling the describeExecution operation

var params = {
  ExecutionId: 'STRING_VALUE', /* required */
  WorkflowId: 'STRING_VALUE' /* required */
};
transfer.describeExecution(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: {})
    • ExecutionId — (String)

      A unique identifier for the execution of a workflow.

    • WorkflowId — (String)

      A unique identifier for the workflow.

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:

      • WorkflowId — (String)

        A unique identifier for the workflow.

      • Execution — (map)

        The structure that contains the details of the workflow' execution.

        • ExecutionId — (String)

          A unique identifier for the execution of a workflow.

        • InitialFileLocation — (map)

          A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

          • S3FileLocation — (map)

            Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.

            • Bucket — (String)

              Specifies the S3 bucket that contains the file being used.

            • Key — (String)

              The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

            • VersionId — (String)

              Specifies the file version.

            • Etag — (String)

              The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.

          • EfsFileLocation — (map)

            Specifies the Amazon EFS ID and the path for the file being used.

            • FileSystemId — (String)

              The ID of the file system, assigned by Amazon EFS.

            • Path — (String)

              The pathname for the folder being used by a workflow.

        • ServiceMetadata — (map)

          A container object for the session details associated with a workflow.

          • UserDetailsrequired — (map)

            The Server ID (ServerId), Session ID (SessionId) and user (UserName) make up the UserDetails.

            • UserNamerequired — (String)

              A unique string that identifies a user account associated with a server.

            • ServerIdrequired — (String)

              The system-assigned unique identifier for a Transfer server instance.

            • SessionId — (String)

              The system-assigned unique identifier for a session that corresponds to the workflow.

        • ExecutionRole — (String)

          The IAM role associated with the execution.

        • LoggingConfiguration — (map)

          The IAM logging role associated with the execution.

          • LoggingRole — (String)

            Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

          • LogGroupName — (String)

            The name of the CloudWatch logging group for the Amazon Web Services Transfer server to which this workflow belongs.

        • PosixProfile — (map)

          The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

          • Uidrequired — (Integer)

            The POSIX user ID used for all EFS operations by this user.

          • Gidrequired — (Integer)

            The POSIX group ID used for all EFS operations by this user.

          • SecondaryGids — (Array<Integer>)

            The secondary POSIX group IDs used for all EFS operations by this user.

        • Status — (String)

          The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
          • "EXCEPTION"
          • "HANDLING_EXCEPTION"
        • Results — (map)

          A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

          • Steps — (Array<map>)

            Specifies the details for the steps that are in the specified workflow.

            • StepType — (String)

              One of the available step types.

              • Copy: copy the file to another location

              • Custom: custom step with a lambda target

              • Delete: delete the file

              • Tag: add a tag to the file

              Possible values include:
              • "COPY"
              • "CUSTOM"
              • "TAG"
              • "DELETE"
            • Outputs — (String)

              The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

            • Error — (map)

              Specifies the details for an error, if it occurred during execution of the specified workfow step.

              • Typerequired — (String)

                Specifies the error type: currently, the only valid value is PERMISSION_DENIED, which occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

                Possible values include:
                • "PERMISSION_DENIED"
              • Messagerequired — (String)

                Specifies the descriptive message that corresponds to the ErrorType.

          • OnExceptionSteps — (Array<map>)

            Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

            • StepType — (String)

              One of the available step types.

              • Copy: copy the file to another location

              • Custom: custom step with a lambda target

              • Delete: delete the file

              • Tag: add a tag to the file

              Possible values include:
              • "COPY"
              • "CUSTOM"
              • "TAG"
              • "DELETE"
            • Outputs — (String)

              The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

            • Error — (map)

              Specifies the details for an error, if it occurred during execution of the specified workfow step.

              • Typerequired — (String)

                Specifies the error type: currently, the only valid value is PERMISSION_DENIED, which occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

                Possible values include:
                • "PERMISSION_DENIED"
              • Messagerequired — (String)

                Specifies the descriptive message that corresponds to the ErrorType.

Returns:

  • (AWS.Request)

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

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.

Service Reference:

Examples:

Calling the describeSecurityPolicy operation

var params = {
  SecurityPolicyName: 'STRING_VALUE' /* required */
};
transfer.describeSecurityPolicy(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: {})
    • SecurityPolicyName — (String)

      Specifies the name of the security policy that is attached to the 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:

      • SecurityPolicy — (map)

        An array containing the properties of the security policy.

        • Fips — (Boolean)

          Specifies whether this policy enables Federal Information Processing Standards (FIPS).

        • SecurityPolicyNamerequired — (String)

          Specifies the name of the security policy that is attached to the server.

        • SshCiphers — (Array<String>)

          Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.

        • SshKexs — (Array<String>)

          Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.

        • SshMacs — (Array<String>)

          Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.

        • TlsCiphers — (Array<String>)

          Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

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 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 server with the ServerID you specified.

        • Arnrequired — (String)

          Specifies the unique Amazon Resource Name (ARN) of the server.

        • Certificate — (String)

          Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

        • ProtocolDetails — (map)

          The protocol settings that are configured for your server.

          Use the PassiveIp parameter to indicate passive mode. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

          • PassiveIp — (String)

            Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. For example:

            aws transfer update-server --protocol-details PassiveIp=0.0.0.0

            Replace 0.0.0.0 in the example above with the actual IP address you want to use.

            Note: If you change the PassiveIp value, you must stop and then restart your Transfer server for the change to take effect. For details on using Passive IP (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family.
        • Domain — (String)

          Specifies the domain of the storage system that is used for file transfers.

          Possible values include:
          • "S3"
          • "EFS"
        • EndpointDetails — (map)

          The virtual private cloud (VPC) endpoint settings that are configured for your 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 IP addresses 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 server's endpoint.

            Note: This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.
          • SubnetIds — (Array<String>)

            A list of subnet IDs that are required to host your server endpoint in your VPC.

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

            The ID of the VPC endpoint.

            Note: This property can only be set when EndpointType is set to VPC_ENDPOINT. For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
          • VpcId — (String)

            The VPC ID of the VPC in which a server's endpoint will be hosted.

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

            A list of security groups IDs that are available to attach to your server's endpoint.

            Note: This property can only be set when EndpointType is set to VPC. You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.
        • EndpointType — (String)

          Defines the type of endpoint that your 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 server is AWS_DIRECTORY_SERVICE or 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.

          • DirectoryId — (String)

            The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.

        • IdentityProviderType — (String)

          Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

          Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

          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"
          • "AWS_DIRECTORY_SERVICE"
        • LoggingRole — (String)

          Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS 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

        • SecurityPolicyName — (String)

          Specifies the name of the security policy that is attached to the server.

        • ServerId — (String)

          Specifies the unique system-assigned identifier for a server that you instantiate.

        • State — (String)

          Specifies the condition of a 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 servers that were assigned to the server that was described.

          • Keyrequired — (String)

            The name assigned to the tag that you create.

          • Valuerequired — (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 server you specified with the ServerId.

        • WorkflowDetails — (map)

          Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

          • OnUploadrequired — (Array<map>)

            A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

            • WorkflowIdrequired — (String)

              A unique identifier for the workflow.

            • ExecutionRolerequired — (String)

              Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

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 server that has this user assigned.

    • UserName — (String)

      The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Amazon Web Services 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 server that has this user assigned.

      • User — (map)

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

        • Arnrequired — (String)

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

        • HomeDirectory — (String)

          The landing directory (folder) for a user when they log in to the server using the client.

          A HomeDirectory example is /bucket_name/home/mydirectory.

        • HomeDirectoryMappings — (Array<map>)

          Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

          In most cases, you can use this value instead of the session 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.

          • Entryrequired — (String)

            Represents an entry for HomeDirectoryMappings.

          • Targetrequired — (String)

            Represents the map target that is used in a HomeDirectorymapEntry.

        • HomeDirectoryType — (String)

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

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

          A session policy for your user so that 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}.

        • PosixProfile — (map)

          Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

          • Uidrequired — (Integer)

            The POSIX user ID used for all EFS operations by this user.

          • Gidrequired — (Integer)

            The POSIX group ID used for all EFS operations by this user.

          • SecondaryGids — (Array<Integer>)

            The secondary POSIX group IDs used for all EFS operations by this user.

        • Role — (String)

          Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the 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.

          • DateImportedrequired — (Date)

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

          • SshPublicKeyBodyrequired — (String)

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

          • SshPublicKeyIdrequired — (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.

          • Keyrequired — (String)

            The name assigned to the tag that you create.

          • Valuerequired — (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 server.

Returns:

  • (AWS.Request)

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

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

Describes the specified workflow.

Service Reference:

Examples:

Calling the describeWorkflow operation

var params = {
  WorkflowId: 'STRING_VALUE' /* required */
};
transfer.describeWorkflow(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: {})
    • WorkflowId — (String)

      A unique identifier for the workflow.

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:

      • Workflow — (map)

        The structure that contains the details of the workflow.

        • Arnrequired — (String)

          Specifies the unique Amazon Resource Name (ARN) for the workflow.

        • Description — (String)

          Specifies the text description for the workflow.

        • Steps — (Array<map>)

          Specifies the details for the steps that are in the specified workflow.

          • Type — (String)

            Currently, the following step types are supported.

            • Copy: copy the file to another location

            • Custom: custom step with a lambda target

            • Delete: delete the file

            • Tag: add a tag to the file

            Possible values include:
            • "COPY"
            • "CUSTOM"
            • "TAG"
            • "DELETE"
          • CopyStepDetails — (map)

            Details for a step that performs a file copy.

            Consists of the following values:

            • A description

            • An S3 or EFS location for the destination of the file copy.

            • A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

            • Name — (String)

              The name of the step, used as an identifier.

            • DestinationFileLocation — (map)

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

              • S3FileLocation — (map)

                Specifies the details for the S3 file being copied.

                • Bucket — (String)

                  Specifies the S3 bucket that contains the file being copied.

                • Key — (String)

                  The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

              • EfsFileLocation — (map)

                Specifies the details for the Amazon EFS file being copied.

                • FileSystemId — (String)

                  The ID of the file system, assigned by Amazon EFS.

                • Path — (String)

                  The pathname for the folder being used by a workflow.

            • OverwriteExisting — (String)

              A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

              Possible values include:
              • "TRUE"
              • "FALSE"
          • CustomStepDetails — (map)

            Details for a step that invokes a lambda function.

            Consists of the lambda function name, target, and timeout (in seconds).

            • Name — (String)

              The name of the step, used as an identifier.

            • Target — (String)

              The ARN for the lambda function that is being called.

            • TimeoutSeconds — (Integer)

              Timeout, in seconds, for the step.

          • DeleteStepDetails — (map)

            You need to specify the name of the file to be deleted.

            • Name — (String)

              The name of the step, used as an identifier.

          • TagStepDetails — (map)

            Details for a step that creates one or more tags.

            You specify one or more tags: each tag contains a key/value pair.

            • Name — (String)

              The name of the step, used as an identifier.

            • Tags — (Array<map>)

              Array that contains from 1 to 10 key/value pairs.

              • Keyrequired — (String)

                The name assigned to the tag that you create.

              • Valuerequired — (String)

                The value that corresponds to the key.

        • OnExceptionSteps — (Array<map>)

          Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

          • Type — (String)

            Currently, the following step types are supported.

            • Copy: copy the file to another location

            • Custom: custom step with a lambda target

            • Delete: delete the file

            • Tag: add a tag to the file

            Possible values include:
            • "COPY"
            • "CUSTOM"
            • "TAG"
            • "DELETE"
          • CopyStepDetails — (map)

            Details for a step that performs a file copy.

            Consists of the following values:

            • A description

            • An S3 or EFS location for the destination of the file copy.

            • A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

            • Name — (String)

              The name of the step, used as an identifier.

            • DestinationFileLocation — (map)

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

              • S3FileLocation — (map)

                Specifies the details for the S3 file being copied.

                • Bucket — (String)

                  Specifies the S3 bucket that contains the file being copied.

                • Key — (String)

                  The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

              • EfsFileLocation — (map)

                Specifies the details for the Amazon EFS file being copied.

                • FileSystemId — (String)

                  The ID of the file system, assigned by Amazon EFS.

                • Path — (String)

                  The pathname for the folder being used by a workflow.

            • OverwriteExisting — (String)

              A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

              Possible values include:
              • "TRUE"
              • "FALSE"
          • CustomStepDetails — (map)

            Details for a step that invokes a lambda function.

            Consists of the lambda function name, target, and timeout (in seconds).

            • Name — (String)

              The name of the step, used as an identifier.

            • Target — (String)

              The ARN for the lambda function that is being called.

            • TimeoutSeconds — (Integer)

              Timeout, in seconds, for the step.

          • DeleteStepDetails — (map)

            You need to specify the name of the file to be deleted.

            • Name — (String)

              The name of the step, used as an identifier.

          • TagStepDetails — (map)

            Details for a step that creates one or more tags.

            You specify one or more tags: each tag contains a key/value pair.

            • Name — (String)

              The name of the step, used as an identifier.

            • Tags — (Array<map>)

              Array that contains from 1 to 10 key/value pairs.

              • Keyrequired — (String)

                The name assigned to the tag that you create.

              • Valuerequired — (String)

                The value that corresponds to the key.

        • WorkflowId — (String)

          A unique identifier for the workflow.

        • Tags — (Array<map>)

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

          • Keyrequired — (String)

            The name assigned to the tag that you create.

          • Valuerequired — (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.

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

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

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

Service Reference:

Examples:

Calling the listAccesses operation

var params = {
  ServerId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
transfer.listAccesses(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 maximum number of access SIDs to return.

    • NextToken — (String)

      When you can get additional results from the ListAccesses 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 accesses.

    • ServerId — (String)

      A system-assigned unique identifier for a 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 ListAccesses 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 accesses.

      • ServerId — (String)

        A system-assigned unique identifier for a server that has users assigned to it.

      • Accesses — (Array<map>)

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

        • HomeDirectory — (String)

          The landing directory (folder) for a user when they log in to the server using the client.

          A HomeDirectory example is /bucket_name/home/mydirectory.

        • HomeDirectoryType — (String)

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

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

          Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

        • ExternalId — (String)

          A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

          Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

          In that command, replace YourGroupName with the name of your Active Directory group.

          The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Returns:

  • (AWS.Request)

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

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

Lists all executions for the specified workflow.

Service Reference:

Examples:

Calling the listExecutions operation

var params = {
  WorkflowId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
transfer.listExecutions(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 aximum number of executions to return.

    • NextToken — (String)

      ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

      This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

      aws transfer list-executions --max-results 10

      This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

      aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

      This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

    • WorkflowId — (String)

      A unique identifier for the workflow.

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)

        ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

      • WorkflowId — (String)

        A unique identifier for the workflow.

      • Executions — (Array<map>)

        Returns the details for each execution.

        • NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.

        • StartTime: timestamp indicating when the execution began.

        • Executions: details of the execution, including the execution ID, initial file location, and Service metadata.

        • Status: one of the following values: IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.

        • ExecutionId — (String)

          A unique identifier for the execution of a workflow.

        • InitialFileLocation — (map)

          A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

          • S3FileLocation — (map)

            Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.

            • Bucket — (String)

              Specifies the S3 bucket that contains the file being used.

            • Key — (String)

              The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

            • VersionId — (String)

              Specifies the file version.

            • Etag — (String)

              The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.

          • EfsFileLocation — (map)

            Specifies the Amazon EFS ID and the path for the file being used.

            • FileSystemId — (String)

              The ID of the file system, assigned by Amazon EFS.

            • Path — (String)

              The pathname for the folder being used by a workflow.

        • ServiceMetadata — (map)

          A container object for the session details associated with a workflow.

          • UserDetailsrequired — (map)

            The Server ID (ServerId), Session ID (SessionId) and user (UserName) make up the UserDetails.

            • UserNamerequired — (String)

              A unique string that identifies a user account associated with a server.

            • ServerIdrequired — (String)

              The system-assigned unique identifier for a Transfer server instance.

            • SessionId — (String)

              The system-assigned unique identifier for a session that corresponds to the workflow.

        • Status — (String)

          The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
          • "EXCEPTION"
          • "HANDLING_EXCEPTION"

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listSecurityPolicies operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
transfer.listSecurityPolicies(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 security policies to return as a response to the ListSecurityPolicies query.

    • NextToken — (String)

      When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies.

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 ListSecurityPolicies operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing security policies.

      • SecurityPolicyNames — (Array<String>)

        An array of security policies that were listed.

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 Amazon Web Services 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 servers to return as a response to the ListServers query.

    • NextToken — (String)

      When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional 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 servers.

      • Servers — (Array<map>)

        An array of servers that were listed.

        • Arnrequired — (String)

          Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

        • Domain — (String)

          Specifies the domain of the storage system that is used for file transfers.

          Possible values include:
          • "S3"
          • "EFS"
        • IdentityProviderType — (String)

          Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

          Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

          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"
          • "AWS_DIRECTORY_SERVICE"
        • EndpointType — (String)

          Specifies the type of VPC endpoint that your 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 Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

        • ServerId — (String)

          Specifies the unique system assigned identifier for the servers that were listed.

        • State — (String)

          Specifies the condition of a 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 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 Name (ARN) that 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 Amazon Web Services 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.

        • Keyrequired — (String)

          The name assigned to the tag that you create.

        • Valuerequired — (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 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 server that the users are assigned to.

      • Users — (Array<map>)

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

        • Arnrequired — (String)

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

        • HomeDirectory — (String)

          The landing directory (folder) for a user when they log in to the server using the client.

          A HomeDirectory example is /bucket_name/home/mydirectory.

        • HomeDirectoryType — (String)

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

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

          Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

          Note: The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS. The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
        • 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.

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

Lists all of your workflows.

Service Reference:

Examples:

Calling the listWorkflows operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
transfer.listWorkflows(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 maximum number of workflows to return.

    • NextToken — (String)

      ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

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)

        ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

      • Workflows — (Array<map>)

        Returns the Arn, WorkflowId, and Description for each workflow.

        • WorkflowId — (String)

          A unique identifier for the workflow.

        • Description — (String)

          Specifies the text description for the workflow.

        • Arn — (String)

          Specifies the unique Amazon Resource Name (ARN) for the workflow.

Returns:

  • (AWS.Request)

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

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

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

Service Reference:

Examples:

Calling the sendWorkflowStepState operation

var params = {
  ExecutionId: 'STRING_VALUE', /* required */
  Status: SUCCESS | FAILURE, /* required */
  Token: 'STRING_VALUE', /* required */
  WorkflowId: 'STRING_VALUE' /* required */
};
transfer.sendWorkflowStepState(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: {})
    • WorkflowId — (String)

      A unique identifier for the workflow.

    • ExecutionId — (String)

      A unique identifier for the execution of a workflow.

    • Token — (String)

      Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.

    • Status — (String)

      Indicates whether the specified step succeeded or failed.

      Possible values include:
      • "SUCCESS"
      • "FAILURE"

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.

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

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.

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 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 Amazon Web Services 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.

      • Keyrequired — (String)

        The name assigned to the tag that you create.

      • Valuerequired — (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 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.

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

Note: You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
  • If you provide any incorrect values for any parameters, the Response field is empty.

  • If you provide a server ID for a server that uses service-managed users, you get an error:

    An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth

  • If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

    An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server

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 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 Amazon Web Services 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.

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

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

Service Reference:

Examples:

Calling the updateAccess operation

var params = {
  ExternalId: 'STRING_VALUE', /* required */
  ServerId: 'STRING_VALUE', /* required */
  HomeDirectory: 'STRING_VALUE',
  HomeDirectoryMappings: [
    {
      Entry: 'STRING_VALUE', /* required */
      Target: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  HomeDirectoryType: PATH | LOGICAL,
  Policy: 'STRING_VALUE',
  PosixProfile: {
    Gid: 'NUMBER_VALUE', /* required */
    Uid: 'NUMBER_VALUE', /* required */
    SecondaryGids: [
      'NUMBER_VALUE',
      /* more items */
    ]
  },
  Role: 'STRING_VALUE'
};
transfer.updateAccess(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 server using the client.

      A HomeDirectory example is /bucket_name/home/mydirectory.

    • HomeDirectoryType — (String)

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

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

      Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

      The following is an Entry and Target pair example.

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

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

      The following is an Entry and Target pair example for chroot.

      [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

      Note: If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs 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.
      • Entryrequired — (String)

        Represents an entry for HomeDirectoryMappings.

      • Targetrequired — (String)

        Represents the map target that is used in a HomeDirectorymapEntry.

    • Policy — (String)

      A session policy for your user so that 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: This only applies when the domain of ServerId is S3. EFS does not use session policies. For session policies, Amazon Web Services 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 session policy, see Example session policy. For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.
    • PosixProfile — (map)

      The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

      • Uidrequired — (Integer)

        The POSIX user ID used for all EFS operations by this user.

      • Gidrequired — (Integer)

        The POSIX group ID used for all EFS operations by this user.

      • SecondaryGids — (Array<Integer>)

        The secondary POSIX group IDs used for all EFS operations by this user.

    • Role — (String)

      Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

    • ServerId — (String)

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

    • ExternalId — (String)

      A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

      Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

      In that command, replace YourGroupName with the name of your Active Directory group.

      The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

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 server that the user is attached to.

      • ExternalId — (String)

        The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.

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 */
    ],
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ],
    VpcEndpointId: 'STRING_VALUE',
    VpcId: 'STRING_VALUE'
  },
  EndpointType: PUBLIC | VPC | VPC_ENDPOINT,
  HostKey: 'STRING_VALUE',
  IdentityProviderDetails: {
    DirectoryId: 'STRING_VALUE',
    InvocationRole: 'STRING_VALUE',
    Url: 'STRING_VALUE'
  },
  LoggingRole: 'STRING_VALUE',
  ProtocolDetails: {
    PassiveIp: 'STRING_VALUE'
  },
  Protocols: [
    SFTP | FTP | FTPS,
    /* more items */
  ],
  SecurityPolicyName: 'STRING_VALUE',
  WorkflowDetails: {
    OnUpload: [ /* required */
      {
        ExecutionRole: 'STRING_VALUE', /* required */
        WorkflowId: 'STRING_VALUE' /* required */
      },
      /* 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 Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

      To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.

      To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.

      To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate 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.
    • ProtocolDetails — (map)

      The protocol settings that are configured for your server.

      Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

      • PassiveIp — (String)

        Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. For example:

        aws transfer update-server --protocol-details PassiveIp=0.0.0.0

        Replace 0.0.0.0 in the example above with the actual IP address you want to use.

        Note: If you change the PassiveIp value, you must stop and then restart your Transfer server for the change to take effect. For details on using Passive IP (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family.
    • EndpointDetails — (map)

      The virtual private cloud (VPC) endpoint settings that are configured for your 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 IP addresses 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 server's endpoint.

        Note: This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.
      • SubnetIds — (Array<String>)

        A list of subnet IDs that are required to host your server endpoint in your VPC.

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

        The ID of the VPC endpoint.

        Note: This property can only be set when EndpointType is set to VPC_ENDPOINT. For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
      • VpcId — (String)

        The VPC ID of the VPC in which a server's endpoint will be hosted.

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

        A list of security groups IDs that are available to attach to your server's endpoint.

        Note: This property can only be set when EndpointType is set to VPC. You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.
    • EndpointType — (String)

      The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

      Note: After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC. For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. 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 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 Amazon Web ServicesTransfer 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.

      • DirectoryId — (String)

        The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.

    • LoggingRole — (String)

      Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS 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:

      • 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 Amazon Web ServicesCertificate 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 AWS_DIRECTORY_SERVICE or 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.
    • SecurityPolicyName — (String)

      Specifies the name of the security policy that is attached to the server.

    • ServerId — (String)

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

    • WorkflowDetails — (map)

      Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

      • OnUploadrequired — (Array<map>)

        A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

        • WorkflowIdrequired — (String)

          A unique identifier for the workflow.

        • ExecutionRolerequired — (String)

          Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

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 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',
  PosixProfile: {
    Gid: 'NUMBER_VALUE', /* required */
    Uid: 'NUMBER_VALUE', /* required */
    SecondaryGids: [
      'NUMBER_VALUE',
      /* more items */
    ]
  },
  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)

      The landing directory (folder) for a user when they log in to the server using the client.

      A HomeDirectory example is /bucket_name/home/mydirectory.

    • HomeDirectoryType — (String)

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

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

      Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

      The following is an Entry and Target pair example.

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

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

      The following is an Entry and Target pair example for chroot.

      [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

      Note: If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs 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.
      • Entryrequired — (String)

        Represents an entry for HomeDirectoryMappings.

      • Targetrequired — (String)

        Represents the map target that is used in a HomeDirectorymapEntry.

    • Policy — (String)

      A session policy for your user so that 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: This only applies when the domain of ServerId is S3. EFS does not use session policies. For session policies, Amazon Web Services 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 session policy, see Creating a session policy. For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
    • PosixProfile — (map)

      Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.

      • Uidrequired — (Integer)

        The POSIX user ID used for all EFS operations by this user.

      • Gidrequired — (Integer)

        The POSIX group ID used for all EFS operations by this user.

      • SecondaryGids — (Array<Integer>)

        The secondary POSIX group IDs used for all EFS operations by this user.

    • Role — (String)

      Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

    • ServerId — (String)

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

    • UserName — (String)

      A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

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 server instance that the user account is assigned to.

      • UserName — (String)

        The unique identifier for a user that is assigned to a server instance that was specified in the request.

Returns:

  • (AWS.Request)

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