aws-sdk-transfer 1.66.0 → 1.68.0

data/lib/aws-sdk-transfer/types.rb

@@ -46,6 +46,11 @@ module Aws::Transfer
     #
     # @!attribute [rw] encryption_algorithm
     #   The algorithm that is used to encrypt the file.
+    #
+    #   <note markdown="1"> You can only specify `NONE` if the URL for your connector uses
+    #   HTTPS. This ensures that no traffic is sent in clear text.
+    #
+    #    </note>
     #   @return [String]
     #
     # @!attribute [rw] signing_algorithm
@@ -57,7 +62,7 @@ module Aws::Transfer
     #   The signing algorithm for the MDN response.
     #
     #   <note markdown="1"> If set to DEFAULT (or not set at all), the value for
-    #   `SigningAlogorithm` is used.
+    #   `SigningAlgorithm` is used.
     #
     #    </note>
     #   @return [String]
@@ -68,10 +73,10 @@ module Aws::Transfer
     #   transfers is synchronous or asynchronous. Specify either of the
     #   following values:
     #
-    #   * `SYNC`\: The system expects a synchronous MDN response, confirming
+    #   * `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.
+    #   * `NONE`: Specifies that no MDN response is required.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/As2ConnectorConfig AWS API Documentation
@@ -111,14 +116,37 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] destination_file_location
-    #   Specifies the location for the file being copied. Only applicable
-    #   for Copy type workflow steps. Use `$\{Transfer:username\}` in this
-    #   field to parametrize the destination prefix by username.
+    #   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 markdown="1"> The system resolves `UploadDate` to a date format of *YYYY-MM-DD*,
+    #     based on the date the file is uploaded in UTC.
+    #
+    #      </note>
     #   @return [Types::InputFileLocation]
     #
     # @!attribute [rw] overwrite_existing
-    #   A flag that indicates whether or not to overwrite an existing file
-    #   of the same name. The default is `FALSE`.
+    #   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.
     #   @return [String]
     #
     # @!attribute [rw] source_file_location
@@ -126,12 +154,12 @@ module Aws::Transfer
     #   the output from the previous step, or the originally uploaded file
     #   for the workflow.
     #
-    #   * Enter `$\{previous.file\}` to use the previous file as the input.
+    #   * 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.
     #
-    #   * Enter `$\{original.file\}` to use the originally-uploaded file
-    #     location as input for this step.
+    #   * To use the originally uploaded file location as input for this
+    #     step, enter `$\{original.file\}`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CopyStepDetails AWS API Documentation
@@ -316,8 +344,7 @@ module Aws::Transfer
     #   The landing directory (folder) for files transferred by using the
     #   AS2 protocol.
     #
-    #   A `BaseDirectory` example is
-    #   *DOC-EXAMPLE-BUCKET*/*home*/*mydirectory*.
+    #   A `BaseDirectory` example is `/DOC-EXAMPLE-BUCKET/home/mydirectory`.
     #   @return [String]
     #
     # @!attribute [rw] access_role
@@ -609,7 +636,7 @@ module Aws::Transfer
     #   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 [Update host keys for your SFTP-enabled
+    #   For more information, see [Manage host keys for your SFTP-enabled
     #   server][1] in the *Transfer Family User Guide*.
     #
     #
@@ -619,11 +646,12 @@ module Aws::Transfer
     #
     # @!attribute [rw] identity_provider_details
     #   Required when `IdentityProviderType` is set to
-    #   `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`. Accepts an array
-    #   containing all of the information required to use a directory in
-    #   `AWS_DIRECTORY_SERVICE` or invoke a customer-supplied authentication
-    #   API, including the API Gateway URL. Not required when
-    #   `IdentityProviderType` is set to `SERVICE_MANAGED`.
+    #   `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`.
     #   @return [Types::IdentityProviderDetails]
     #
     # @!attribute [rw] identity_provider_type
@@ -645,7 +673,7 @@ module Aws::Transfer
     #
     #   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 or the
+    #   the ARN for the Lambda function in the `Function` parameter for the
     #   `IdentityProviderDetails` data type.
     #   @return [String]
     #
@@ -699,14 +727,15 @@ module Aws::Transfer
     #
     #   * If `Protocol` includes either `FTP` or `FTPS`, then the
     #     `EndpointType` must be `VPC` and the `IdentityProviderType` must
-    #     be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
+    #     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 to
-    #     `SERVICE_MANAGED`.
+    #     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.
@@ -753,11 +782,11 @@ module Aws::Transfer
     #   Specifies the workflow ID for the workflow to assign and the
     #   execution role that's used for executing the workflow.
     #
-    #   In additon to a workflow to execute when a file is uploaded
-    #   completely, `WorkflowDeatails` can also contain a workflow ID (and
+    #   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 a file is open when the session
-    #   disconnects.
+    #   partial upload occurs when the server session disconnects while the
+    #   file is still being uploaded.
     #   @return [Types::WorkflowDetails]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerRequest AWS API Documentation
@@ -894,7 +923,19 @@ module Aws::Transfer
     #   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.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -932,8 +973,7 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] user_name
-    #   A unique string that identifies a user account associated with a
-    #   server.
+    #   A unique string that identifies a Transfer Family user.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUserResponse AWS API Documentation
@@ -956,29 +996,33 @@ module Aws::Transfer
     #   The `TYPE` specifies which of the following actions is being taken
     #   for this step.
     #
-    #   * *COPY*\: Copy the file to another location.
+    #   * <b> <code>COPY</code> </b> - Copy the file to another location.
     #
-    #   * *CUSTOM*\: Perform a custom step with an Lambda function target.
+    #   * <b> <code>CUSTOM</code> </b> - Perform a custom step with an
+    #     Lambda function target.
     #
-    #   * *DELETE*\: Delete the file.
+    #   * <b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted
+    #     before it was uploaded.
     #
-    #   * *TAG*\: Add a tag to the file.
+    #   * <b> <code>DELETE</code> </b> - Delete the file.
+    #
+    #   * <b> <code>TAG</code> </b> - Add a tag to the file.
     #
     #   <note markdown="1"> Currently, copying and tagging are supported only on S3.
     #
     #    </note>
     #
-    #   For file location, you specify either the S3 bucket and key, or the
-    #   EFS file system ID and path.
+    #   For file location, you specify either the Amazon S3 bucket and key,
+    #   or the Amazon EFS file system ID and path.
     #   @return [Array<Types::WorkflowStep>]
     #
     # @!attribute [rw] on_exception_steps
     #   Specifies the steps (actions) to take if errors are encountered
     #   during execution of the workflow.
     #
-    #   <note markdown="1"> For custom steps, the lambda function needs to send `FAILURE` to the
+    #   <note markdown="1"> 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
+    #   Lambda does not send `SUCCESS` before it times out, the exception
     #   steps are executed.
     #
     #    </note>
@@ -1019,7 +1063,7 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] target
-    #   The ARN for the lambda function that is being called.
+    #   The ARN for the Lambda function that is being called.
     #   @return [String]
     #
     # @!attribute [rw] timeout_seconds
@@ -1031,12 +1075,12 @@ module Aws::Transfer
     #   the output from the previous step, or the originally uploaded file
     #   for the workflow.
     #
-    #   * Enter `$\{previous.file\}` to use the previous file as the input.
+    #   * 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.
     #
-    #   * Enter `$\{original.file\}` to use the originally-uploaded file
-    #     location as input for this step.
+    #   * To use the originally uploaded file location as input for this
+    #     step, enter `$\{original.file\}`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CustomStepDetails AWS API Documentation
@@ -1050,21 +1094,61 @@ module Aws::Transfer
       include Aws::Structure
     end
 
+    # Each step type has its own `StepDetails` structure.
+    #
     # @!attribute [rw] name
+    #   The name of the step, used as an identifier.
     #   @return [String]
     #
     # @!attribute [rw] type
+    #   The type of encryption used. Currently, this value must be `PGP`.
     #   @return [String]
     #
     # @!attribute [rw] source_file_location
+    #   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\}`.
     #   @return [String]
     #
     # @!attribute [rw] overwrite_existing
+    #   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.
     #   @return [String]
     #
     # @!attribute [rw] destination_file_location
-    #   Specifies the location for the file being copied. Only applicable
-    #   for the Copy type of workflow steps.
+    #   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 markdown="1"> The system resolves `UploadDate` to a date format of *YYYY-MM-DD*,
+    #     based on the date the file is uploaded in UTC.
+    #
+    #      </note>
     #   @return [Types::InputFileLocation]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DecryptStepDetails AWS API Documentation
@@ -1233,12 +1317,12 @@ module Aws::Transfer
     #   the output from the previous step, or the originally uploaded file
     #   for the workflow.
     #
-    #   * Enter `$\{previous.file\}` to use the previous file as the input.
+    #   * 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.
     #
-    #   * Enter `$\{original.file\}` to use the originally-uploaded file
-    #     location as input for this step.
+    #   * To use the originally uploaded file location as input for this
+    #     step, enter `$\{original.file\}`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteStepDetails AWS API Documentation
@@ -1578,8 +1662,8 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] user
-    #   An array containing the properties of the user account for the
-    #   `ServerID` value that you specified.
+    #   An array containing the properties of the Transfer Family user for
+    #   the `ServerID` value that you specified.
     #   @return [Types::DescribedUser]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUserResponse AWS API Documentation
@@ -2243,7 +2327,7 @@ module Aws::Transfer
     #
     #   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 or the
+    #   the ARN for the Lambda function in the `Function` parameter for the
     #   `IdentityProviderDetails` data type.
     #   @return [String]
     #
@@ -2297,14 +2381,15 @@ module Aws::Transfer
     #
     #   * If `Protocol` includes either `FTP` or `FTPS`, then the
     #     `EndpointType` must be `VPC` and the `IdentityProviderType` must
-    #     be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
+    #     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 to
-    #     `SERVICE_MANAGED`.
+    #     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.
@@ -2348,11 +2433,11 @@ module Aws::Transfer
     #   Specifies the workflow ID for the workflow to assign and the
     #   execution role that's used for executing the workflow.
     #
-    #   In additon to a workflow to execute when a file is uploaded
-    #   completely, `WorkflowDeatails` can also contain a workflow ID (and
+    #   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 a file is open when the session
-    #   disconnects.
+    #   partial upload occurs when the server session disconnects while the
+    #   file is still being uploaded.
     #   @return [Types::WorkflowDetails]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedServer AWS API Documentation
@@ -2527,7 +2612,9 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # Reserved for future use.
+    # Specifies the details for the file location for the file that's being
+    # used in the workflow. Only applicable if you are using Amazon Elastic
+    # File Systems (Amazon EFS) for storage.
     #
     # @!attribute [rw] file_system_id
     #   The identifier of the file system, assigned by Amazon EFS.
@@ -2642,36 +2729,36 @@ module Aws::Transfer
     # @!attribute [rw] type
     #   Specifies the error type.
     #
-    #   * `ALREADY_EXISTS`\: occurs for a copy step, if the overwrite option
+    #   * `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
+    #   * `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
+    #   * `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
+    #   * `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
+    #   * `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
+    #   * `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.
+    #   * `TIMEOUT`: occurs when the execution times out.
     #
     #     <note markdown="1"> You can set the `TimeoutSeconds` for a custom step, anywhere from
     #     1 second to 1800 seconds (30 minutes).
     #
     #      </note>
     #
-    #   * `THROTTLED`\: occurs if you exceed the new execution refill rate
-    #     of one workflow per second.
+    #   * `THROTTLED`: occurs if you exceed the new execution refill rate of
+    #     one workflow per second.
     #   @return [String]
     #
     # @!attribute [rw] message
@@ -2716,13 +2803,17 @@ module Aws::Transfer
     # @!attribute [rw] step_type
     #   One of the available step types.
     #
-    #   * *COPY*\: Copy the file to another location.
+    #   * <b> <code>COPY</code> </b> - Copy the file to another location.
+    #
+    #   * <b> <code>CUSTOM</code> </b> - Perform a custom step with an
+    #     Lambda function target.
     #
-    #   * *CUSTOM*\: Perform a custom step with an Lambda function target.
+    #   * <b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted
+    #     before it was uploaded.
     #
-    #   * *DELETE*\: Delete the file.
+    #   * <b> <code>DELETE</code> </b> - Delete the file.
     #
-    #   * *TAG*\: Add a tag to the file.
+    #   * <b> <code>TAG</code> </b> - Add a tag to the file.
     #   @return [String]
     #
     # @!attribute [rw] outputs
@@ -2800,8 +2891,9 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] invocation_role
-    #   Provides the type of `InvocationRole` used to authenticate the user
-    #   account.
+    #   This parameter is only applicable if your `IdentityProviderType` is
+    #   `API_GATEWAY`. Provides the type of `InvocationRole` used to
+    #   authenticate the user account.
     #   @return [String]
     #
     # @!attribute [rw] directory_id
@@ -2810,7 +2902,26 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] function
-    #   The ARN for a lambda function to use for the Identity provider.
+    #   The ARN for a Lambda function to use for the Identity provider.
+    #   @return [String]
+    #
+    # @!attribute [rw] sftp_authentication_methods
+    #   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.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/IdentityProviderDetails AWS API Documentation
@@ -2819,7 +2930,8 @@ module Aws::Transfer
       :url,
       :invocation_role,
       :directory_id,
-      :function)
+      :function,
+      :sftp_authentication_methods)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2830,7 +2942,12 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] certificate
-    #   The file that contains the certificate to import.
+    #   * For the CLI, provide a file path for a certificate in URI format.
+    #     For example, `--certificate file://encryption-cert.pem`.
+    #     Alternatively, you can provide the raw content.
+    #
+    #   * For the SDK, specify the raw content of a certificate file. For
+    #     example, `` --certificate "`cat encryption-cert.pem`" ``.
     #   @return [String]
     #
     # @!attribute [rw] certificate_chain
@@ -2839,8 +2956,13 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] private_key
-    #   The file that contains the private key for the certificate that's
-    #   being imported.
+    #   * For the CLI, provide a file path for a private key in URI
+    #     format.For example, `--private-key file://encryption-key.pem`.
+    #     Alternatively, you can provide the raw content of the private key
+    #     file.
+    #
+    #   * For the SDK, specify the raw content of a private key file. For
+    #     example, `` --private-key "`cat encryption-key.pem`" ``
     #   @return [String]
     #
     # @!attribute [rw] active_date
@@ -2895,7 +3017,7 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] host_key_body
-    #   The public key portion of an SSH key pair.
+    #   The private key portion of an SSH key pair.
     #
     #   Transfer Family accepts RSA, ECDSA, and ED25519 keys.
     #   @return [String]
@@ -2947,7 +3069,7 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] user_name
-    #   The name of the user account that is assigned to one or more
+    #   The name of the Transfer Family user that is assigned to one or more
     #   servers.
     #   @return [String]
     #
@@ -2987,15 +3109,16 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # Specifies the location for the file being copied. Only applicable for
-    # the Copy type of workflow steps.
+    # Specifies the location for the file that's being processed.
     #
     # @!attribute [rw] s3_file_location
-    #   Specifies the details for the S3 file being copied.
+    #   Specifies the details for the Amazon S3 file that's being copied or
+    #   decrypted.
     #   @return [Types::S3InputFileLocation]
     #
     # @!attribute [rw] efs_file_location
-    #   Reserved for future use.
+    #   Specifies the details for the Amazon Elastic File System (Amazon
+    #   EFS) file that's being decrypted.
     #   @return [Types::EfsFileLocation]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/InputFileLocation AWS API Documentation
@@ -3234,7 +3357,7 @@ module Aws::Transfer
     #
     #   This is useful for pagination, for instance. If you have 100
     #   executions for a workflow, you might only want to list first 10. If
-    #   so, call the API by specifying the `max-results`\:
+    #   so, call the API by specifying the `max-results`:
     #
     #   `aws transfer list-executions --max-results 10`
     #
@@ -3275,19 +3398,8 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] executions
-    #   Returns the details for each execution.
-    #
-    #   * **NextToken**\: returned from a call to several APIs, you can use
-    #     pass it to a subsequent command to continue listing additional
-    #     executions.
-    #
-    #   * **StartTime**\: timestamp indicating when the execution began.
-    #
-    #   * **Executions**\: details of the execution, including the execution
-    #     ID, initial file location, and Service metadata.
-    #
-    #   * **Status**\: one of the following values: `IN_PROGRESS`,
-    #     `COMPLETED`, `EXCEPTION`, `HANDLING_EXEPTION`.
+    #   Returns the details for each execution, in a `ListedExecution`
+    #   array.
     #   @return [Array<Types::ListedExecution>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListExecutionsResponse AWS API Documentation
@@ -3570,8 +3682,8 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] users
-    #   Returns the user accounts and their properties for the `ServerId`
-    #   value that you specify.
+    #   Returns the Transfer Family users and their properties for the
+    #   `ServerId` value that you specify.
     #   @return [Array<Types::ListedUser>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsersResponse AWS API Documentation
@@ -3970,7 +4082,7 @@ module Aws::Transfer
     #
     #   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 or the
+    #   the ARN for the Lambda function in the `Function` parameter for the
     #   `IdentityProviderDetails` data type.
     #   @return [String]
     #
@@ -4224,15 +4336,15 @@ module Aws::Transfer
     #   `TlsSessionResumptionMode` value is not specified during
     #   `CreateServer`, it is set to `ENFORCED` by default.
     #
-    #   * `DISABLED`\: the server does not process TLS session resumption
+    #   * `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
+    #   * `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
+    #   * `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
@@ -4365,9 +4477,9 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # Specifies the customer input S3 file location. If it is used inside
-    # `copyStepDetails.DestinationFileLocation`, it should be the S3 copy
-    # destination.
+    # Specifies the customer input Amazon S3 file location. If it is used
+    # inside `copyStepDetails.DestinationFileLocation`, it should be the S3
+    # copy destination.
     #
     # You need to provide the bucket and key. The key can represent either a
     # path or a file. This is determined by whether or not you end the key
@@ -4380,7 +4492,7 @@ module Aws::Transfer
     # For example, if your path is `shared-files/bob/`, your uploaded files
     # are copied to the `shared-files/bob/`, folder. If your path is
     # `shared-files/today`, each uploaded file is copied to the
-    # `shared-files` folder and named `today`\: each upload overwrites the
+    # `shared-files` folder and named `today`: each upload overwrites the
     # previous version of the *bob* file.
     #
     # @!attribute [rw] bucket
@@ -4484,15 +4596,15 @@ module Aws::Transfer
     end
 
     # Provides information about the public Secure Shell (SSH) key that is
-    # associated with a user account for the specific file transfer
+    # associated with a Transfer Family user for the specific file transfer
     # protocol-enabled server (as identified by `ServerId`). The information
     # returned includes the date the key was imported, the public key
     # contents, and the public key ID. A user can store more than one SSH
     # public key associated with their user name on a specific server.
     #
     # @!attribute [rw] date_imported
-    #   Specifies the date that the public key was added to the user
-    #   account.
+    #   Specifies the date that the public key was added to the Transfer
+    #   Family user.
     #   @return [Time]
     #
     # @!attribute [rw] ssh_public_key_body
@@ -4604,8 +4716,8 @@ module Aws::Transfer
     #
     # @!attribute [rw] tags
     #   Key-value pairs assigned to ARNs that you can use to group and
-    #   search for resources by type. You can attach this metadata to user
-    #   accounts for any purpose.
+    #   search for resources by type. You can attach this metadata to
+    #   resources (servers, users, workflows, and so on) for any purpose.
     #   @return [Array<Types::Tag>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResourceRequest AWS API Documentation
@@ -4635,12 +4747,12 @@ module Aws::Transfer
     #   the output from the previous step, or the originally uploaded file
     #   for the workflow.
     #
-    #   * Enter `$\{previous.file\}` to use the previous file as the input.
+    #   * 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.
     #
-    #   * Enter `$\{original.file\}` to use the originally-uploaded file
-    #     location as input for this step.
+    #   * To use the originally uploaded file location as input for this
+    #     step, enter `$\{original.file\}`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagStepDetails AWS API Documentation
@@ -4668,18 +4780,20 @@ module Aws::Transfer
     #   * File Transfer Protocol Secure (FTPS)
     #
     #   * File Transfer Protocol (FTP)
+    #
+    #   * Applicability Statement 2 (AS2)
     #   @return [String]
     #
     # @!attribute [rw] source_ip
-    #   The source IP address of the user account to be tested.
+    #   The source IP address of the account to be tested.
     #   @return [String]
     #
     # @!attribute [rw] user_name
-    #   The name of the user account to be tested.
+    #   The name of the account to be tested.
     #   @return [String]
     #
     # @!attribute [rw] user_password
-    #   The password of the user account to be tested.
+    #   The password of the account to be tested.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProviderRequest AWS API Documentation
@@ -4695,11 +4809,13 @@ module Aws::Transfer
     end
 
     # @!attribute [rw] response
-    #   The response that is returned from your API Gateway.
+    #   The response that is returned from your API Gateway or your Lambda
+    #   function.
     #   @return [String]
     #
     # @!attribute [rw] status_code
-    #   The HTTP status code that is the response from your API Gateway.
+    #   The HTTP status code that is the response from your API Gateway or
+    #   your Lambda function.
     #   @return [Integer]
     #
     # @!attribute [rw] message
@@ -5298,7 +5414,7 @@ module Aws::Transfer
     #   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 [Update host keys for your SFTP-enabled
+    #   For more information, see [Manage host keys for your SFTP-enabled
     #   server][1] in the *Transfer Family User Guide*.
     #
     #
@@ -5361,14 +5477,15 @@ module Aws::Transfer
     #
     #   * If `Protocol` includes either `FTP` or `FTPS`, then the
     #     `EndpointType` must be `VPC` and the `IdentityProviderType` must
-    #     be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
+    #     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 to
-    #     `SERVICE_MANAGED`.
+    #     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.
@@ -5383,18 +5500,18 @@ module Aws::Transfer
     #
     # @!attribute [rw] server_id
     #   A system-assigned unique identifier for a server instance that the
-    #   user account is assigned to.
+    #   Transfer Family user is assigned to.
     #   @return [String]
     #
     # @!attribute [rw] workflow_details
     #   Specifies the workflow ID for the workflow to assign and the
     #   execution role that's used for executing the workflow.
     #
-    #   In additon to a workflow to execute when a file is uploaded
-    #   completely, `WorkflowDeatails` can also contain a workflow ID (and
+    #   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 a file is open when the session
-    #   disconnects.
+    #   partial upload occurs when the server session disconnects while the
+    #   file is still being uploaded.
     #
     #   To remove an associated workflow from a server, you can provide an
     #   empty `OnUpload` object, as in the following example.
@@ -5424,8 +5541,8 @@ module Aws::Transfer
     end
 
     # @!attribute [rw] server_id
-    #   A system-assigned unique identifier for a server that the user
-    #   account is assigned to.
+    #   A system-assigned unique identifier for a server that the Transfer
+    #   Family user is assigned to.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServerResponse AWS API Documentation
@@ -5530,8 +5647,8 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] server_id
-    #   A system-assigned unique identifier for a server instance that the
-    #   user account is assigned to.
+    #   A system-assigned unique identifier for a Transfer Family server
+    #   instance that the user is assigned to.
     #   @return [String]
     #
     # @!attribute [rw] user_name
@@ -5562,8 +5679,8 @@ module Aws::Transfer
     # request to update a user's properties.
     #
     # @!attribute [rw] server_id
-    #   A system-assigned unique identifier for a server instance that the
-    #   user account is assigned to.
+    #   A system-assigned unique identifier for a Transfer Family server
+    #   instance that the account is assigned to.
     #   @return [String]
     #
     # @!attribute [rw] user_name
@@ -5583,8 +5700,8 @@ module Aws::Transfer
     # Specifies the user name, server ID, and session ID for a workflow.
     #
     # @!attribute [rw] user_name
-    #   A unique string that identifies a user account associated with a
-    #   server.
+    #   A unique string that identifies a Transfer Family user associated
+    #   with a server.
     #   @return [String]
     #
     # @!attribute [rw] server_id
@@ -5610,10 +5727,11 @@ module Aws::Transfer
     # Specifies the workflow ID for the workflow to assign and the execution
     # role that's used for executing the workflow.
     #
-    # In additon to a workflow to execute when a file is uploaded
-    # completely, `WorkflowDeatails` can also contain a workflow ID (and
+    # 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 a file is open when the session disconnects.
+    # upload occurs when the server session disconnects while the file is
+    # still being uploaded.
     #
     # @!attribute [rw] workflow_id
     #   A unique identifier for the workflow.
@@ -5671,13 +5789,17 @@ module Aws::Transfer
     # @!attribute [rw] type
     #   Currently, the following step types are supported.
     #
-    #   * *COPY*\: Copy the file to another location.
+    #   * <b> <code>COPY</code> </b> - Copy the file to another location.
     #
-    #   * *CUSTOM*\: Perform a custom step with an Lambda function target.
+    #   * <b> <code>CUSTOM</code> </b> - Perform a custom step with an
+    #     Lambda function target.
     #
-    #   * *DELETE*\: Delete the file.
+    #   * <b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted
+    #     before it was uploaded.
     #
-    #   * *TAG*\: Add a tag to the file.
+    #   * <b> <code>DELETE</code> </b> - Delete the file.
+    #
+    #   * <b> <code>TAG</code> </b> - Add a tag to the file.
     #   @return [String]
     #
     # @!attribute [rw] copy_step_details
@@ -5687,16 +5809,16 @@ module Aws::Transfer
     #
     #   * A description
     #
-    #   * An S3 location for the destination of the file copy.
+    #   * An Amazon S3 location for the destination of the file copy.
     #
-    #   * A flag that indicates whether or not to overwrite an existing file
-    #     of the same name. The default is `FALSE`.
+    #   * A flag that indicates whether to overwrite an existing file of the
+    #     same name. The default is `FALSE`.
     #   @return [Types::CopyStepDetails]
     #
     # @!attribute [rw] custom_step_details
-    #   Details for a step that invokes a lambda function.
+    #   Details for a step that invokes an Lambda function.
     #
-    #   Consists of the lambda function name, target, and timeout (in
+    #   Consists of the Lambda function's name, target, and timeout (in
     #   seconds).
     #   @return [Types::CustomStepDetails]
     #
@@ -5707,10 +5829,27 @@ module Aws::Transfer
     # @!attribute [rw] tag_step_details
     #   Details for a step that creates one or more tags.
     #
-    #   You specify one or more tags: each tag contains a key/value pair.
+    #   You specify one or more tags. Each tag contains a key-value pair.
     #   @return [Types::TagStepDetails]
     #
     # @!attribute [rw] decrypt_step_details
+    #   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.
     #   @return [Types::DecryptStepDetails]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WorkflowStep AWS API Documentation