Class: AWS.Transfer

var params = {
  AccessRole: 'STRING_VALUE', /* required */
  BaseDirectory: 'STRING_VALUE', /* required */
  LocalProfileId: 'STRING_VALUE', /* required */
  PartnerProfileId: 'STRING_VALUE', /* required */
  ServerId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Status: ACTIVE | INACTIVE,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transfer.createAgreement(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 name or short description to identify the agreement.

  • ServerId — (String)

    A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

  • LocalProfileId — (String)

    A unique identifier for the AS2 local profile.

  • PartnerProfileId — (String)

    A unique identifier for the partner profile used in the agreement.

  • BaseDirectory — (String)

    The landing directory (folder) for files transferred by using the AS2 protocol.

    A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

  • AccessRole — (String)

    Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

    For AS2 connectors

    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

    If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

    For SFTP connectors

    Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

  • Status — (String)

    The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

    Possible values include:
    • "ACTIVE"
    • "INACTIVE"
  • Tags — (Array<map>)

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

    • Key — required — (String)

      The name assigned to the tag that you create.

    • Value — required — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • AgreementId — (String)

      The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.

Returns:

• (AWS.Request) —

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

var params = {
  AccessRole: 'STRING_VALUE', /* required */
  Url: 'STRING_VALUE', /* required */
  As2Config: {
    BasicAuthSecretId: 'STRING_VALUE',
    Compression: ZLIB | DISABLED,
    EncryptionAlgorithm: AES128_CBC | AES192_CBC | AES256_CBC | DES_EDE3_CBC | NONE,
    LocalProfileId: 'STRING_VALUE',
    MdnResponse: SYNC | NONE,
    MdnSigningAlgorithm: SHA256 | SHA384 | SHA512 | SHA1 | NONE | DEFAULT,
    MessageSubject: 'STRING_VALUE',
    PartnerProfileId: 'STRING_VALUE',
    SigningAlgorithm: SHA256 | SHA384 | SHA512 | SHA1 | NONE
  },
  LoggingRole: 'STRING_VALUE',
  SecurityPolicyName: 'STRING_VALUE',
  SftpConfig: {
    TrustedHostKeys: [
      'STRING_VALUE',
      /* more items */
    ],
    UserSecretId: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transfer.createConnector(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: {}) —
  • Url — (String)

    The URL of the partner's AS2 or SFTP endpoint.

  • As2Config — (map)

    A structure that contains the parameters for an AS2 connector object.

    • LocalProfileId — (String)

      A unique identifier for the AS2 local profile.

    • PartnerProfileId — (String)

      A unique identifier for the partner profile for the connector.

    • MessageSubject — (String)

      Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

    • Compression — (String)

      Specifies whether the AS2 file is compressed.

      Possible values include:
      • "ZLIB"
      • "DISABLED"
    • EncryptionAlgorithm — (String)

      The algorithm that is used to encrypt the file.

      Note the following:

      • Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

      • You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

      Possible values include:
      • "AES128_CBC"
      • "AES192_CBC"
      • "AES256_CBC"
      • "DES_EDE3_CBC"
      • "NONE"
    • SigningAlgorithm — (String)

      The algorithm that is used to sign the AS2 messages sent with the connector.

      Possible values include:
      • "SHA256"
      • "SHA384"
      • "SHA512"
      • "SHA1"
      • "NONE"
    • MdnSigningAlgorithm — (String)

      The signing algorithm for the MDN response.

      Note: If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.
      Possible values include:
      • "SHA256"
      • "SHA384"
      • "SHA512"
      • "SHA1"
      • "NONE"
      • "DEFAULT"
    • MdnResponse — (String)

      Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

      • SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

      • NONE: Specifies that no MDN response is required.

      Possible values include:
      • "SYNC"
      • "NONE"
    • BasicAuthSecretId — (String)

      Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

      The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

      If the connector should use Basic authentication, the secret needs to be in the following format:

      { "Username": "user-name", "Password": "user-password" }

      Replace user-name and user-password with the credentials for the actual user that is being authenticated.

      Note the following:

      • You are storing these credentials in Secrets Manager, not passing them directly into this API.

      • If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

      If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

      update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

  • AccessRole — (String)

    Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

    For AS2 connectors

    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

    If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

    For SFTP connectors

    Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

  • LoggingRole — (String)

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

  • Tags — (Array<map>)

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

    • Key — required — (String)

      The name assigned to the tag that you create.

    • Value — required — (String)

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

  • SftpConfig — (map)

    A structure that contains the parameters for an SFTP connector object.

    • UserSecretId — (String)

      The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.

    • TrustedHostKeys — (Array<String>)

      The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

      The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element. Specify only the <key type> and <body base64>: do not enter the <comment> portion of the key.

      For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

      • For RSA keys, the <key type> string is ssh-rsa.

      • For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

      Run this command to retrieve the SFTP server host key, where your SFTP server name is ftp.host.com.

      ssh-keyscan ftp.host.com

      This prints the public host key to standard output.

      ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key

      Copy and paste this string into the TrustedHostKeys field for the create-connector command or into the Trusted host keys field in the console.

  • SecurityPolicyName — (String)

    Specifies the name of the security policy for the connector.

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:

    • ConnectorId — (String)

      The unique identifier for the connector, returned after the API call succeeds.

Returns:

• (AWS.Request) —

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

var params = {
  As2Id: 'STRING_VALUE', /* required */
  ProfileType: LOCAL | PARTNER, /* required */
  CertificateIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
transfer.createProfile(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: {}) —
  • As2Id — (String)

    The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

  • ProfileType — (String)

    Determines the type of profile to create:

    • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.

    • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

    Possible values include:
    • "LOCAL"
    • "PARTNER"
  • CertificateIds — (Array<String>)

    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

  • Tags — (Array<map>)

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

    • Key — required — (String)

      The name assigned to the tag that you create.

    • Value — required — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProfileId — (String)

      The unique identifier for the AS2 profile, returned after the API call succeeds.

Returns:

• (AWS.Request) —

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

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',
    Function: 'STRING_VALUE',
    InvocationRole: 'STRING_VALUE',
    SftpAuthenticationMethods: PASSWORD | PUBLIC_KEY | PUBLIC_KEY_OR_PASSWORD | PUBLIC_KEY_AND_PASSWORD,
    Url: 'STRING_VALUE'
  },
  IdentityProviderType: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA,
  LoggingRole: 'STRING_VALUE',
  PostAuthenticationLoginBanner: 'STRING_VALUE',
  PreAuthenticationLoginBanner: 'STRING_VALUE',
  ProtocolDetails: {
    As2Transports: [
      HTTP,
      /* more items */
    ],
    PassiveIp: 'STRING_VALUE',
    SetStatOption: DEFAULT | ENABLE_NO_OP,
    TlsSessionResumptionMode: DISABLED | ENABLED | ENFORCED
  },
  Protocols: [
    SFTP | FTP | FTPS | AS2,
    /* more items */
  ],
  S3StorageOptions: {
    DirectoryListingOptimization: ENABLED | DISABLED
  },
  SecurityPolicyName: 'STRING_VALUE',
  StructuredLogDestinations: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  WorkflowDetails: {
    OnPartialUpload: [
      {
        ExecutionRole: 'STRING_VALUE', /* required */
        WorkflowId: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    OnUpload: [
      {
        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 Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

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

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

    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the 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 your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint 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.

      An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the allocationId field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.

      This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server.

      Note: This property can only be set as follows:

      • EndpointType must be set to VPC
      • The Transfer Family server must be offline.
      • You cannot set this parameter for Transfer Family servers that use the FTP protocol.
      • The server must already have SubnetIds populated (SubnetIds and AddressAllocationIds cannot be updated simultaneously).
      • AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. For example, if you have three subnet IDs, you must also specify three address allocation IDs.
      • Call the UpdateServer API to set or change this parameter.
    • 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 identifier 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 identifier 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, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

    Use the following command to generate an RSA 2048 bit key with no passphrase:

    ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.

    Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

    Use the following command to generate an ECDSA 256 bit key with no passphrase:

    ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.

    Valid values for the -b option for ECDSA are 256, 384, and 521.

    Use the following command to generate an ED25519 key with no passphrase:

    ssh-keygen -t ed25519 -N "" -f my-new-server-key.

    For all of these commands, you can replace my-new-server-key with a string of your choice.

    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 Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.

  • IdentityProviderDetails — (map)

    Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA 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)

      This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

    • DirectoryId — (String)

      The identifier of the Directory Service directory that you want to use as your identity provider.

    • Function — (String)

      The ARN for a Lambda function to use for the Identity provider.

    • SftpAuthenticationMethods — (String)

      For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

      • PASSWORD - users must provide their password to connect.

      • PUBLIC_KEY - users must provide their private key to connect.

      • PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

      • PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

      Possible values include:
      • "PASSWORD"
      • "PUBLIC_KEY"
      • "PUBLIC_KEY_OR_PASSWORD"
      • "PUBLIC_KEY_AND_PASSWORD"
  • IdentityProviderType — (String)

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

    Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by 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 Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

    Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

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

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

  • PostAuthenticationLoginBanner — (String)

    Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

    Note: The SFTP protocol does not support post-authentication display banners.
  • PreAuthenticationLoginBanner — (String)

    Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

  • 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

    • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

    Note:

    • If you select FTPS, you must choose a certificate stored in 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 either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, 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 any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.
    • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.
  • ProtocolDetails — (map)

    The protocol settings that are configured for your server.

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

    • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

    • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

    • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

    • PassiveIp — (String)

      Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public 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 Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Transfer Family.

      Special values

      The AUTO and 0.0.0.0 are special values for the PassiveIp parameter. The value PassiveIp=AUTO is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0 has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the PassiveIp parameter. This reduces the effectiveness of having High Availability. In this case, you can specify PassiveIp=0.0.0.0. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the PassiveIp=0.0.0.0 response.

    • TlsSessionResumptionMode — (String)

      A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. TlsSessionResumptionMode determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls. If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.

      • DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.

      • ENABLED: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.

      • ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to ENFORCED, test your clients.

        Note: Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the ENFORCED value, you need to test your clients.
      Possible values include:
      • "DISABLED"
      • "ENABLED"
      • "ENFORCED"
    • SetStatOption — (String)

      Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.

      Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.

      Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. While the SetStatOption ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.

      Note: If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.
      Possible values include:
      • "DEFAULT"
      • "ENABLE_NO_OP"
    • As2Transports — (Array<String>)

      Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

  • SecurityPolicyName — (String)

    Specifies the name of the security policy for the server.

  • Tags — (Array<map>)

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

    • Key — required — (String)

      The name assigned to the tag that you create.

    • Value — required — (String)

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

  • WorkflowDetails — (map)

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

    In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

    • OnUpload — (Array<map>)

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

      To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

      aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

      • WorkflowId — required — (String)

        A unique identifier for the workflow.

      • ExecutionRole — required — (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

    • OnPartialUpload — (Array<map>)

      A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

      A partial upload occurs when a file is open when the session disconnects.

      • WorkflowId — required — (String)

        A unique identifier for the workflow.

      • ExecutionRole — required — (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

  • StructuredLogDestinations — (Array<String>)

    Specifies the log groups to which your server logs are sent.

    To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

    arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

    For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

    If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

    update-server --server-id s-1234567890abcdef0 --structured-log-destinations

  • S3StorageOptions — (map)

    Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

    By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

    • DirectoryListingOptimization — (String)

      Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

      By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

      Possible values include:
      • "ENABLED"
      • "DISABLED"

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 identifier of the server that is created.

Returns:

• (AWS.Request) —

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

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 */
      Type: FILE | DIRECTORY
    },
    /* 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.

    Note: The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
  • HomeDirectoryType — (String)

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

    Note: If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.
    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 Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

    The following is an Entry and Target pair example.

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

    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 value the user should see for their home directory when they log in.

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

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

    • Entry — required — (String)

      Represents an entry for HomeDirectoryMappings.

    • Target — required — (String)

      Represents the map target that is used in a HomeDirectoryMapEntry.

    • Type — (String)

      Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

      Note: By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.
      Possible values include:
      • "FILE"
      • "DIRECTORY"
  • Policy — (String)

    A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's 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 policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies. For session policies, 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.

    • Uid — required — (Integer)

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

    • Gid — required — (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)

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.

    The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element.

    Transfer Family accepts RSA, ECDSA, and ED25519 keys.

    • For RSA keys, the key type is ssh-rsa.

    • For ED25519 keys, the key type is ssh-ed25519.

    • For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

  • Tags — (Array<map>)

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

    • Key — required — (String)

      The name assigned to the tag that you create.

    • Value — required — (String)

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

  • UserName — (String)

    A unique string that identifies a user and is associated with a 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 identifier of the server that the user is attached to.

    • UserName — (String)

      A unique string that identifies a Transfer Family user.

Returns:

• (AWS.Request) —

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

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,
        SourceFileLocation: 'STRING_VALUE'
      },
      CustomStepDetails: {
        Name: 'STRING_VALUE',
        SourceFileLocation: 'STRING_VALUE',
        Target: 'STRING_VALUE',
        TimeoutSeconds: 'NUMBER_VALUE'
      },
      DecryptStepDetails: {
        DestinationFileLocation: { /* required */
          EfsFileLocation: {
            FileSystemId: 'STRING_VALUE',
            Path: 'STRING_VALUE'
          },
          S3FileLocation: {
            Bucket: 'STRING_VALUE',
            Key: 'STRING_VALUE'
          }
        },
        Type: PGP, /* required */
        Name: 'STRING_VALUE',
        OverwriteExisting: TRUE | FALSE,
        SourceFileLocation: 'STRING_VALUE'
      },
      DeleteStepDetails: {
        Name: 'STRING_VALUE',
        SourceFileLocation: 'STRING_VALUE'
      },
      TagStepDetails: {
        Name: 'STRING_VALUE',
        SourceFileLocation: 'STRING_VALUE',
        Tags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      Type: COPY | CUSTOM | TAG | DELETE | DECRYPT
    },
    /* 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,
        SourceFileLocation: 'STRING_VALUE'
      },
      CustomStepDetails: {
        Name: 'STRING_VALUE',
        SourceFileLocation: 'STRING_VALUE',
        Target: 'STRING_VALUE',
        TimeoutSeconds: 'NUMBER_VALUE'
      },
      DecryptStepDetails: {
        DestinationFileLocation: { /* required */
          EfsFileLocation: {
            FileSystemId: 'STRING_VALUE',
            Path: 'STRING_VALUE'
          },
          S3FileLocation: {
            Bucket: 'STRING_VALUE',
            Key: 'STRING_VALUE'
          }
        },
        Type: PGP, /* required */
        Name: 'STRING_VALUE',
        OverwriteExisting: TRUE | FALSE,
        SourceFileLocation: 'STRING_VALUE'
      },
      DeleteStepDetails: {
        Name: 'STRING_VALUE',
        SourceFileLocation: 'STRING_VALUE'
      },
      TagStepDetails: {
        Name: 'STRING_VALUE',
        SourceFileLocation: 'STRING_VALUE',
        Tags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      Type: COPY | CUSTOM | TAG | DELETE | DECRYPT
    },
    /* 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 - Perform a custom step with an Lambda function target.

    • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

    • DELETE - Delete the file.

    • TAG - Add a tag to the file.

    Note: Currently, copying and tagging are supported only on S3.

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

    • Type — (String)

      Currently, the following step types are supported.

      • COPY - Copy the file to another location.

      • CUSTOM - Perform a custom step with an Lambda function target.

      • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

      • DELETE - Delete the file.

      • TAG - Add a tag to the file.

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

      Details for a step that performs a file copy.

      Consists of the following values:

      • A description

      • An Amazon S3 location for the destination of the file copy.

      • A flag that indicates whether 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. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

        • Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

        • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

          Note: The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
        • S3FileLocation — (map)

          Specifies the details for the Amazon S3 file that's being copied or decrypted.

          • Bucket — (String)

            Specifies the S3 bucket for the customer input file.

          • Key — (String)

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

        • EfsFileLocation — (map)

          Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

          • FileSystemId — (String)

            The identifier 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 to overwrite an existing file of the same name. The default is FALSE.

        If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

        • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

        • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

        Possible values include:
        • "TRUE"
        • "FALSE"
      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

    • CustomStepDetails — (map)

      Details for a step that invokes an Lambda function.

      Consists of the Lambda function's 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.

      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

    • DeleteStepDetails — (map)

      Details for a step that deletes the file.

      • Name — (String)

        The name of the step, used as an identifier.

      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

          The value that corresponds to the key.

      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

    • DecryptStepDetails — (map)

      Details for a step that decrypts an encrypted file.

      Consists of the following values:

      • A descriptive name

      • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.

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

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

      • The type of encryption that's used. Currently, only PGP encryption is supported.

      • Name — (String)

        The name of the step, used as an identifier.

      • Type — required — (String)

        The type of encryption used. Currently, this value must be PGP.

        Possible values include:
        • "PGP"
      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

      • OverwriteExisting — (String)

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

        If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

        • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

        • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

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

        Specifies the location for the file being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

        • Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

        • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

          Note: The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
        • S3FileLocation — (map)

          Specifies the details for the Amazon S3 file that's being copied or decrypted.

          • Bucket — (String)

            Specifies the S3 bucket for the customer input file.

          • Key — (String)

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

        • EfsFileLocation — (map)

          Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

          • FileSystemId — (String)

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

          • Path — (String)

            The pathname for the folder being used by a workflow.

  • OnExceptionSteps — (Array<map>)

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

    Note: For custom steps, the Lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the Lambda does not send SUCCESS before it times out, the exception steps are executed.
    • Type — (String)

      Currently, the following step types are supported.

      • COPY - Copy the file to another location.

      • CUSTOM - Perform a custom step with an Lambda function target.

      • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

      • DELETE - Delete the file.

      • TAG - Add a tag to the file.

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

      Details for a step that performs a file copy.

      Consists of the following values:

      • A description

      • An Amazon S3 location for the destination of the file copy.

      • A flag that indicates whether 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. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

        • Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

        • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

          Note: The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
        • S3FileLocation — (map)

          Specifies the details for the Amazon S3 file that's being copied or decrypted.

          • Bucket — (String)

            Specifies the S3 bucket for the customer input file.

          • Key — (String)

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

        • EfsFileLocation — (map)

          Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

          • FileSystemId — (String)

            The identifier 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 to overwrite an existing file of the same name. The default is FALSE.

        If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

        • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

        • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

        Possible values include:
        • "TRUE"
        • "FALSE"
      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

    • CustomStepDetails — (map)

      Details for a step that invokes an Lambda function.

      Consists of the Lambda function's 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.

      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

    • DeleteStepDetails — (map)

      Details for a step that deletes the file.

      • Name — (String)

        The name of the step, used as an identifier.

      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

          The value that corresponds to the key.

      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

    • DecryptStepDetails — (map)

      Details for a step that decrypts an encrypted file.

      Consists of the following values:

      • A descriptive name

      • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.

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

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

      • The type of encryption that's used. Currently, only PGP encryption is supported.

      • Name — (String)

        The name of the step, used as an identifier.

      • Type — required — (String)

        The type of encryption used. Currently, this value must be PGP.

        Possible values include:
        • "PGP"
      • SourceFileLocation — (String)

        Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

        • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

        • To use the originally uploaded file location as input for this step, enter ${original.file}.

      • OverwriteExisting — (String)

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

        If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

        • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

        • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

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

        Specifies the location for the file being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

        • Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

        • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

          Note: The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
        • S3FileLocation — (map)

          Specifies the details for the Amazon S3 file that's being copied or decrypted.

          • Bucket — (String)

            Specifies the S3 bucket for the customer input file.

          • Key — (String)

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

        • EfsFileLocation — (map)

          Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

          • FileSystemId — (String)

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

          • Path — (String)

            The pathname for the folder being used by a 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.

    • Key — required — (String)

      The name assigned to the tag that you create.

    • Value — required — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • WorkflowId — (String)

      A unique identifier for the workflow.

Returns:

• (AWS.Request) —

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

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

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

    A unique identifier for the agreement. This identifier is returned when you create an agreement.

  • ServerId — (String)

    The server identifier associated with the agreement that you are deleting.

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.

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

    The identifier of the certificate object that you are deleting.

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.

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

    The unique identifier for the connector.

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.

var params = {
  HostKeyId: 'STRING_VALUE', /* required */
  ServerId: 'STRING_VALUE' /* required */
};
transfer.deleteHostKey(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)

    The identifier of the server that contains the host key that you are deleting.

  • HostKeyId — (String)

    The identifier of the host key that you are deleting.

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.

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

    The identifier of the profile that you are deleting.

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.

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.

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.

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.

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.

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 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 regular expression 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 identifier 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.

        Note: The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
      • 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 Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only 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.

        • Entry — required — (String)

          Represents an entry for HomeDirectoryMappings.

        • Target — required — (String)

          Represents the map target that is used in a HomeDirectoryMapEntry.

        • Type — (String)

          Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

          Note: By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.
          Possible values include:
          • "FILE"
          • "DIRECTORY"
      • HomeDirectoryType — (String)

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

        Note: If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.
        Possible values include:
        • "PATH"
        • "LOGICAL"
      • Policy — (String)

        A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's 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.

        • Uid — required — (Integer)

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

        • Gid — required — (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)

        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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 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 regular expression 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.

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

    A unique identifier for the agreement. This identifier is returned when you create an agreement.

  • ServerId — (String)

    The server identifier that's associated with the agreement.

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:

    • Agreement — (map)

      The details for the specified agreement, returned as a DescribedAgreement object.

      • Arn — required — (String)

        The unique Amazon Resource Name (ARN) for the agreement.

      • AgreementId — (String)

        A unique identifier for the agreement. This identifier is returned when you create an agreement.

      • Description — (String)

        The name or short description that's used to identify the agreement.

      • Status — (String)

        The current status of the agreement, either ACTIVE or INACTIVE.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • ServerId — (String)

        A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

      • LocalProfileId — (String)

        A unique identifier for the AS2 local profile.

      • PartnerProfileId — (String)

        A unique identifier for the partner profile used in the agreement.

      • BaseDirectory — (String)

        The landing directory (folder) for files that are transferred by using the AS2 protocol.

      • AccessRole — (String)

        Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

        For AS2 connectors

        With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

        If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

        For SFTP connectors

        Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

      • Tags — (Array<map>)

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

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

Returns:

• (AWS.Request) —

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

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

    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

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:

    • Certificate — (map)

      The details for the specified certificate, returned as an object.

      • Arn — required — (String)

        The unique Amazon Resource Name (ARN) for the certificate.

      • CertificateId — (String)

        An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

      • Usage — (String)

        Specifies how this certificate is used. It can be used in the following ways:

        • SIGNING: For signing AS2 messages

        • ENCRYPTION: For encrypting AS2 messages

        • TLS: For securing AS2 communications sent over HTTPS

        Possible values include:
        • "SIGNING"
        • "ENCRYPTION"
        • "TLS"
      • Status — (String)

        The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

        Possible values include:
        • "ACTIVE"
        • "PENDING_ROTATION"
        • "INACTIVE"
      • Certificate — (String)

        The file name for the certificate.

      • CertificateChain — (String)

        The list of certificates that make up the chain for the certificate.

      • ActiveDate — (Date)

        An optional date that specifies when the certificate becomes active.

      • InactiveDate — (Date)

        An optional date that specifies when the certificate becomes inactive.

      • Serial — (String)

        The serial number for the certificate.

      • NotBeforeDate — (Date)

        The earliest date that the certificate is valid.

      • NotAfterDate — (Date)

        The final date that the certificate is valid.

      • Type — (String)

        If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

        Possible values include:
        • "CERTIFICATE"
        • "CERTIFICATE_WITH_PRIVATE_KEY"
      • Description — (String)

        The name or description that's used to identity the certificate.

      • Tags — (Array<map>)

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

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

Returns:

• (AWS.Request) —

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

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

    The unique identifier for the connector.

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:

    • Connector — (map)

      The structure that contains the details of the connector.

      • Arn — required — (String)

        The unique Amazon Resource Name (ARN) for the connector.

      • ConnectorId — (String)

        The unique identifier for the connector.

      • Url — (String)

        The URL of the partner's AS2 or SFTP endpoint.

      • As2Config — (map)

        A structure that contains the parameters for an AS2 connector object.

        • LocalProfileId — (String)

          A unique identifier for the AS2 local profile.

        • PartnerProfileId — (String)

          A unique identifier for the partner profile for the connector.

        • MessageSubject — (String)

          Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

        • Compression — (String)

          Specifies whether the AS2 file is compressed.

          Possible values include:
          • "ZLIB"
          • "DISABLED"
        • EncryptionAlgorithm — (String)

          The algorithm that is used to encrypt the file.

          Note the following:

          • Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

          • You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

          Possible values include:
          • "AES128_CBC"
          • "AES192_CBC"
          • "AES256_CBC"
          • "DES_EDE3_CBC"
          • "NONE"
        • SigningAlgorithm — (String)

          The algorithm that is used to sign the AS2 messages sent with the connector.

          Possible values include:
          • "SHA256"
          • "SHA384"
          • "SHA512"
          • "SHA1"
          • "NONE"
        • MdnSigningAlgorithm — (String)

          The signing algorithm for the MDN response.

          Note: If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.
          Possible values include:
          • "SHA256"
          • "SHA384"
          • "SHA512"
          • "SHA1"
          • "NONE"
          • "DEFAULT"
        • MdnResponse — (String)

          Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

          • SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

          • NONE: Specifies that no MDN response is required.

          Possible values include:
          • "SYNC"
          • "NONE"
        • BasicAuthSecretId — (String)

          Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

          The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

          If the connector should use Basic authentication, the secret needs to be in the following format:

          { "Username": "user-name", "Password": "user-password" }

          Replace user-name and user-password with the credentials for the actual user that is being authenticated.

          Note the following:

          • You are storing these credentials in Secrets Manager, not passing them directly into this API.

          • If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

          If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

          update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

      • AccessRole — (String)

        Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

        For AS2 connectors

        With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

        If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

        For SFTP connectors

        Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

      • LoggingRole — (String)

        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

      • Tags — (Array<map>)

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

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

      • SftpConfig — (map)

        A structure that contains the parameters for an SFTP connector object.

        • UserSecretId — (String)

          The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier must be the Amazon Resource Name (ARN) of the secret.

        • TrustedHostKeys — (Array<String>)

          The public portion of the host key, or keys, that are used to identify the external server to which you are connecting. You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

          The three standard SSH public key format elements are <key type>, <body base64>, and an optional <comment>, with spaces between each element. Specify only the <key type> and <body base64>: do not enter the <comment> portion of the key.

          For the trusted host key, Transfer Family accepts RSA and ECDSA keys.

          • For RSA keys, the <key type> string is ssh-rsa.

          • For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

          Run this command to retrieve the SFTP server host key, where your SFTP server name is ftp.host.com.

          ssh-keyscan ftp.host.com

          This prints the public host key to standard output.

          ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key

          Copy and paste this string into the TrustedHostKeys field for the create-connector command or into the Trusted host keys field in the console.

      • ServiceManagedEgressIpAddresses — (Array<String>)

        The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

      • SecurityPolicyName — (String)

        The text name of the security policy for the specified connector.

Returns:

• (AWS.Request) —

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

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 Amazon 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 identifier and the path for the file being used.

          • FileSystemId — (String)

            The identifier 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 that are associated with a workflow.

        • UserDetails — required — (map)

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

          • UserName — required — (String)

            A unique string that identifies a Transfer Family user associated with a server.

          • ServerId — required — (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)

          The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

        • LogGroupName — (String)

          The name of the CloudWatch logging group for the Transfer Family 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.

        • Uid — required — (Integer)

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

        • Gid — required — (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 - Perform a custom step with an Lambda function target.

            • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

            • DELETE - Delete the file.

            • TAG - Add a tag to the file.

            Possible values include:
            • "COPY"
            • "CUSTOM"
            • "TAG"
            • "DELETE"
            • "DECRYPT"
          • 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 workflow step.

            • Type — required — (String)

              Specifies the error type.

              • ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

              • BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

              • CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

              • INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

              • NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

              • PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

              • TIMEOUT: occurs when the execution times out.

                Note: You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

              • THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

              Possible values include:
              • "PERMISSION_DENIED"
              • "CUSTOM_STEP_FAILED"
              • "THROTTLED"
              • "ALREADY_EXISTS"
              • "NOT_FOUND"
              • "BAD_REQUEST"
              • "TIMEOUT"
              • "INTERNAL_SERVER_ERROR"
            • Message — required — (String)

              Specifies the descriptive message that corresponds to the ErrorType.

        • OnExceptionSteps — (Array<map>)

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

          • StepType — (String)

            One of the available step types.

            • COPY - Copy the file to another location.

            • CUSTOM - Perform a custom step with an Lambda function target.

            • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

            • DELETE - Delete the file.

            • TAG - Add a tag to the file.

            Possible values include:
            • "COPY"
            • "CUSTOM"
            • "TAG"
            • "DELETE"
            • "DECRYPT"
          • 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 workflow step.

            • Type — required — (String)

              Specifies the error type.

              • ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

              • BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

              • CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

              • INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

              • NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

              • PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

              • TIMEOUT: occurs when the execution times out.

                Note: You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

              • THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

              Possible values include:
              • "PERMISSION_DENIED"
              • "CUSTOM_STEP_FAILED"
              • "THROTTLED"
              • "ALREADY_EXISTS"
              • "NOT_FOUND"
              • "BAD_REQUEST"
              • "TIMEOUT"
              • "INTERNAL_SERVER_ERROR"
            • Message — required — (String)

              Specifies the descriptive message that corresponds to the ErrorType.

Returns:

• (AWS.Request) —

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

var params = {
  HostKeyId: 'STRING_VALUE', /* required */
  ServerId: 'STRING_VALUE' /* required */
};
transfer.describeHostKey(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)

    The identifier of the server that contains the host key that you want described.

  • HostKeyId — (String)

    The identifier of the host key that you want described.

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:

    • HostKey — (map)

      Returns the details for the specified host key.

      • Arn — required — (String)

        The unique Amazon Resource Name (ARN) for the host key.

      • HostKeyId — (String)

        A unique identifier for the host key.

      • HostKeyFingerprint — (String)

        The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

      • Description — (String)

        The text description for this host key.

      • Type — (String)

        The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

        • ssh-rsa

        • ssh-ed25519

        • ecdsa-sha2-nistp256

        • ecdsa-sha2-nistp384

        • ecdsa-sha2-nistp521

      • DateImported — (Date)

        The date on which the host key was added to the server.

      • Tags — (Array<map>)

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

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

Returns:

• (AWS.Request) —

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

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

    The identifier of the profile that you want described.

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:

    • Profile — (map)

      The details of the specified profile, returned as an object.

      • Arn — required — (String)

        The unique Amazon Resource Name (ARN) for the profile.

      • ProfileId — (String)

        A unique identifier for the local or partner AS2 profile.

      • ProfileType — (String)

        Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

        Possible values include:
        • "LOCAL"
        • "PARTNER"
      • As2Id — (String)

        The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

      • CertificateIds — (Array<String>)

        An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

      • Tags — (Array<map>)

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

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

Returns:

• (AWS.Request) —

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

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)

    Specify the text name of the security policy for which you want the details.

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). This parameter applies to both server and connector security policies.

      • SecurityPolicyName — required — (String)

        The text name of the specified security policy.

      • SshCiphers — (Array<String>)

        Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

      • SshKexs — (Array<String>)

        Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

      • SshMacs — (Array<String>)

        Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

      • TlsCiphers — (Array<String>)

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

        Note: This parameter only applies to security policies for servers.
      • SshHostKeyAlgorithms — (Array<String>)

        Lists the host key algorithms for the security policy.

        Note: This parameter only applies to security policies for connectors.
      • Type — (String)

        The resource type to which the security policy applies, either server or connector.

        Possible values include:
        • "SERVER"
        • "CONNECTOR"
      • Protocols — (Array<String>)

        Lists the file transfer protocols that the security policy applies to.

Returns:

• (AWS.Request) —

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

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.

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

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

        • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

        • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

        • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

        • PassiveIp — (String)

          Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public 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 Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Transfer Family.

          Special values

          The AUTO and 0.0.0.0 are special values for the PassiveIp parameter. The value PassiveIp=AUTO is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0 has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the PassiveIp parameter. This reduces the effectiveness of having High Availability. In this case, you can specify PassiveIp=0.0.0.0. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the PassiveIp=0.0.0.0 response.

        • TlsSessionResumptionMode — (String)

          A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. TlsSessionResumptionMode determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls. If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.

          • DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.

          • ENABLED: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.

          • ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to ENFORCED, test your clients.

            Note: Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the ENFORCED value, you need to test your clients.
          Possible values include:
          • "DISABLED"
          • "ENABLED"
          • "ENFORCED"
        • SetStatOption — (String)

          Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.

          Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.

          Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. While the SetStatOption ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.

          Note: If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.
          Possible values include:
          • "DEFAULT"
          • "ENABLE_NO_OP"
        • As2Transports — (Array<String>)

          Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

      • Domain — (String)

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

        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 your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint 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.

          An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the allocationId field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.

          This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server.

          Note: This property can only be set as follows:

          • EndpointType must be set to VPC
          • The Transfer Family server must be offline.
          • You cannot set this parameter for Transfer Family servers that use the FTP protocol.
          • The server must already have SubnetIds populated (SubnetIds and AddressAllocationIds cannot be updated simultaneously).
          • AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds. For example, if you have three subnet IDs, you must also specify three address allocation IDs.
          • Call the UpdateServer API to set or change this parameter.
        • 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 identifier 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 identifier 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)

          This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

        • DirectoryId — (String)

          The identifier of the Directory Service directory that you want to use as your identity provider.

        • Function — (String)

          The ARN for a Lambda function to use for the Identity provider.

        • SftpAuthenticationMethods — (String)

          For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

          • PASSWORD - users must provide their password to connect.

          • PUBLIC_KEY - users must provide their private key to connect.

          • PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

          • PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

          Possible values include:
          • "PASSWORD"
          • "PUBLIC_KEY"
          • "PUBLIC_KEY_OR_PASSWORD"
          • "PUBLIC_KEY_AND_PASSWORD"
      • IdentityProviderType — (String)

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

        Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by 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 Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

        Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

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

        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

      • PostAuthenticationLoginBanner — (String)

        Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

        Note: The SFTP protocol does not support post-authentication display banners.
      • PreAuthenticationLoginBanner — (String)

        Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

        This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

      • 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

        • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

        Note:

        • If you select FTPS, you must choose a certificate stored in 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 either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, 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 any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.
        • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.
      • SecurityPolicyName — (String)

        Specifies the name of the security policy for the server.

      • ServerId — (String)

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

      • State — (String)

        The condition of 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.

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

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

      • UserCount — (Integer)

        Specifies the number of users that are assigned to a server you specified with the ServerId.

      • WorkflowDetails — (map)

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

        In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

        • OnUpload — (Array<map>)

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

          To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

          aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

          • WorkflowId — required — (String)

            A unique identifier for the workflow.

          • ExecutionRole — required — (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

        • OnPartialUpload — (Array<map>)

          A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

          A partial upload occurs when a file is open when the session disconnects.

          • WorkflowId — required — (String)

            A unique identifier for the workflow.

          • ExecutionRole — required — (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

      • StructuredLogDestinations — (Array<String>)

        Specifies the log groups to which your server logs are sent.

        To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

        arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

        For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

        If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

        update-server --server-id s-1234567890abcdef0 --structured-log-destinations

      • S3StorageOptions — (map)

        Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

        By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

        • DirectoryListingOptimization — (String)

          Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

          By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • As2ServiceManagedEgressIpAddresses — (Array<String>)

        The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

        These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• serverOffline

• serverOnline

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 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 Transfer Family user for the ServerID value that you specified.

      • Arn — required — (String)

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

      • HomeDirectory — (String)

        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.

        Note: The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
      • 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 Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only 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.

        • Entry — required — (String)

          Represents an entry for HomeDirectoryMappings.

        • Target — required — (String)

          Represents the map target that is used in a HomeDirectoryMapEntry.

        • Type — (String)

          Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory.

          Note: By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.
          Possible values include:
          • "FILE"
          • "DIRECTORY"
      • HomeDirectoryType — (String)

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

        Note: If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.
        Possible values include:
        • "PATH"
        • "LOGICAL"
      • Policy — (String)

        A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's 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.

        • Uid — required — (Integer)

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

        • Gid — required — (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)

        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.

        • DateImported — required — (Date)

          Specifies the date that the public key was added to the Transfer Family user.

        • SshPublicKeyBody — required — (String)

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

          Transfer Family accepts RSA, ECDSA, and ED25519 keys.

        • SshPublicKeyId — required — (String)

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

      • Tags — (Array<map>)

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

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

      • UserName — (String)

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

Returns:

• (AWS.Request) —

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

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.

      • Arn — required — (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 - Perform a custom step with an Lambda function target.

          • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

          • DELETE - Delete the file.

          • TAG - Add a tag to the file.

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

          Details for a step that performs a file copy.

          Consists of the following values:

          • A description

          • An Amazon S3 location for the destination of the file copy.

          • A flag that indicates whether 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. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

            • Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

            • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

              Note: The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
            • S3FileLocation — (map)

              Specifies the details for the Amazon S3 file that's being copied or decrypted.

              • Bucket — (String)

                Specifies the S3 bucket for the customer input file.

              • Key — (String)

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

            • EfsFileLocation — (map)

              Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

              • FileSystemId — (String)

                The identifier 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 to overwrite an existing file of the same name. The default is FALSE.

            If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

            • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

            • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

            Possible values include:
            • "TRUE"
            • "FALSE"
          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

        • CustomStepDetails — (map)

          Details for a step that invokes an Lambda function.

          Consists of the Lambda function's 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.

          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

        • DeleteStepDetails — (map)

          Details for a step that deletes the file.

          • Name — (String)

            The name of the step, used as an identifier.

          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

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

            • Key — required — (String)

              The name assigned to the tag that you create.

            • Value — required — (String)

              The value that corresponds to the key.

          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

        • DecryptStepDetails — (map)

          Details for a step that decrypts an encrypted file.

          Consists of the following values:

          • A descriptive name

          • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.

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

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

          • The type of encryption that's used. Currently, only PGP encryption is supported.

          • Name — (String)

            The name of the step, used as an identifier.

          • Type — required — (String)

            The type of encryption used. Currently, this value must be PGP.

            Possible values include:
            • "PGP"
          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

          • OverwriteExisting — (String)

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

            If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

            • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

            • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

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

            Specifies the location for the file being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

            • Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

            • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

              Note: The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
            • S3FileLocation — (map)

              Specifies the details for the Amazon S3 file that's being copied or decrypted.

              • Bucket — (String)

                Specifies the S3 bucket for the customer input file.

              • Key — (String)

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

            • EfsFileLocation — (map)

              Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

              • FileSystemId — (String)

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

              • Path — (String)

                The pathname for the folder being used by a workflow.

      • OnExceptionSteps — (Array<map>)

        Specifies the steps (actions) to take if 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 - Perform a custom step with an Lambda function target.

          • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

          • DELETE - Delete the file.

          • TAG - Add a tag to the file.

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

          Details for a step that performs a file copy.

          Consists of the following values:

          • A description

          • An Amazon S3 location for the destination of the file copy.

          • A flag that indicates whether 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. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

            • Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

            • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

              Note: The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
            • S3FileLocation — (map)

              Specifies the details for the Amazon S3 file that's being copied or decrypted.

              • Bucket — (String)

                Specifies the S3 bucket for the customer input file.

              • Key — (String)

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

            • EfsFileLocation — (map)

              Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

              • FileSystemId — (String)

                The identifier 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 to overwrite an existing file of the same name. The default is FALSE.

            If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

            • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

            • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

            Possible values include:
            • "TRUE"
            • "FALSE"
          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

        • CustomStepDetails — (map)

          Details for a step that invokes an Lambda function.

          Consists of the Lambda function's 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.

          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

        • DeleteStepDetails — (map)

          Details for a step that deletes the file.

          • Name — (String)

            The name of the step, used as an identifier.

          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

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

            • Key — required — (String)

              The name assigned to the tag that you create.

            • Value — required — (String)

              The value that corresponds to the key.

          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

        • DecryptStepDetails — (map)

          Details for a step that decrypts an encrypted file.

          Consists of the following values:

          • A descriptive name

          • An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.

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

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

          • The type of encryption that's used. Currently, only PGP encryption is supported.

          • Name — (String)

            The name of the step, used as an identifier.

          • Type — required — (String)

            The type of encryption used. Currently, this value must be PGP.

            Possible values include:
            • "PGP"
          • SourceFileLocation — (String)

            Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

            • To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

            • To use the originally uploaded file location as input for this step, enter ${original.file}.

          • OverwriteExisting — (String)

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

            If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

            • If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

            • If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

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

            Specifies the location for the file being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

            • Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

            • Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

              Note: The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
            • S3FileLocation — (map)

              Specifies the details for the Amazon S3 file that's being copied or decrypted.

              • Bucket — (String)

                Specifies the S3 bucket for the customer input file.

              • Key — (String)

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

            • EfsFileLocation — (map)

              Specifies the details for the Amazon Elastic File System (Amazon EFS) file that's being decrypted.

              • FileSystemId — (String)

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

              • Path — (String)

                The pathname for the folder being used by a workflow.

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

        • Key — required — (String)

          The name assigned to the tag that you create.

        • Value — required — (String)

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