aws-sdk-transfer 1.58.0 → 1.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a13939bb04d1626575a179a207b8c439389cd89ff8d1211e800e9b5cea83ded
-  data.tar.gz: d34fbbe4805f79565e01669650859ab7b749009e85faf046bdb05227fd59d45c
+  metadata.gz: 5669837987ccd1bb143f2599b6bb22fd35ee846843ff935079a7e25d49b6a1dc
+  data.tar.gz: 1b001adbb9be475e9909f1e4da8bf353a3ec565284cc3bb3243454c8c8a347cf
 SHA512:
-  metadata.gz: f714601ebc7a90411c9aaa18d05d10021be58250c78871e908658642e6b2932d75fea6f1699bcee8dc42b62d75f268164d79658950658cedb7c0c05ca27fbcdd
-  data.tar.gz: '089541d2d201998478a1cdfd809f823011b0a0cc37972b99a3d600568911551291d51dc63a50e4340f513e856e2aeffdd5dc27477995fb44595f18392238da3d'
+  metadata.gz: 5dea701e6cb6af0304123df9d7409095cc8b82fc936063b5f3ce01fcd228fadc34c0826c7293a6f3bac23a0be2b22d7be4aab2e67eb6dc79627bc68335adf787
+  data.tar.gz: b3ab9b4ad168381b6461f3779b71c88f8705cd2300c1bb233809f5b2210b883aefd203822a9b433555296addbe5a3cdb08d90750b965a8b3fcc5ae971155c689

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.60.0 (2022-10-13)
+------------------
+
+* Feature - This release adds an option for customers to configure workflows that are triggered when files are only partially received from a client due to premature session disconnect.
+
+1.59.0 (2022-09-13)
+------------------
+
+* Feature - This release introduces the ability to have multiple server host keys for any of your Transfer Family servers that use the SFTP protocol.
+
 1.58.0 (2022-08-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.58.0
+1.60.0

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

@@ -544,7 +544,8 @@ 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*.
     #
     # @option params [required, String] :access_role
     #   With AS2, you can send files by calling `StartFileTransfer` and
@@ -604,7 +605,12 @@ module Aws::Transfer
 
     # Creates the connector, which captures the parameters for an outbound
     # connection for the AS2 protocol. The connector is required for sending
-    # files from a customer's non Amazon Web Services server.
+    # files to an externally hosted AS2 server. For more details about
+    # connectors, see [Create AS2 connectors][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector
     #
     # @option params [required, String] :url
     #   The URL of the partner's AS2 endpoint.
@@ -677,8 +683,7 @@ module Aws::Transfer
       req.send_request(options)
     end
 
-    # Creates the profile for the AS2 process. The agreement is between the
-    # partner and the AS2 process.
+    # Creates the local or partner profile to use for AS2 transfers.
     #
     # @option params [required, String] :as_2_id
     #   The `As2Id` is the *AS2-name*, as defined in the [RFC 4130][1]. For
@@ -692,9 +697,14 @@ module Aws::Transfer
     #   [1]: https://datatracker.ietf.org/doc/html/rfc4130
     #
     # @option params [required, String] :profile_type
-    #   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.
+    #   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.
     #
     # @option params [Array<String>] :certificate_ids
     #   An array of identifiers for the imported certificates. You use this
@@ -824,7 +834,9 @@ module Aws::Transfer
     #    </note>
     #
     # @option params [String] :host_key
-    #   The RSA, ECDSA, or ED25519 private key to use for your server.
+    #   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:
@@ -853,7 +865,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 [Change the host key for your SFTP-enabled
+    #   For more information, see [Update host keys for your SFTP-enabled
     #   server][1] in the *Transfer Family User Guide*.
     #
     #
@@ -985,6 +997,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
+    #   execution role) for a workflow to execute on partial upload. A partial
+    #   upload occurs when a file is open when the session disconnects.
+    #
     # @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateServerResponse#server_id #server_id} => String
@@ -1028,7 +1045,13 @@ module Aws::Transfer
     #       },
     #     ],
     #     workflow_details: {
-    #       on_upload: [ # required
+    #       on_upload: [
+    #         {
+    #           workflow_id: "WorkflowId", # required
+    #           execution_role: "Role", # required
+    #         },
+    #       ],
+    #       on_partial_upload: [
     #         {
     #           workflow_id: "WorkflowId", # required
     #           execution_role: "Role", # required
@@ -1418,7 +1441,8 @@ module Aws::Transfer
     #   when you create an agreement.
     #
     # @option params [required, String] :server_id
-    #   The server ID associated with the agreement that you are deleting.
+    #   The server identifier associated with the agreement that you are
+    #   deleting.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -1442,7 +1466,7 @@ module Aws::Transfer
     # parameter.
     #
     # @option params [required, String] :certificate_id
-    #   The ID of the certificate object that you are deleting.
+    #   The identifier of the certificate object that you are deleting.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -1483,10 +1507,37 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Deletes the host key that's specified in the `HoskKeyId` parameter.
+    #
+    # @option params [required, String] :server_id
+    #   The identifier of the server that contains the host key that you are
+    #   deleting.
+    #
+    # @option params [required, String] :host_key_id
+    #   The identifier of the host key that you are deleting.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_host_key({
+    #     server_id: "ServerId", # required
+    #     host_key_id: "HostKeyId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteHostKey AWS API Documentation
+    #
+    # @overload delete_host_key(params = {})
+    # @param [Hash] params ({})
+    def delete_host_key(params = {}, options = {})
+      req = build_request(:delete_host_key, params)
+      req.send_request(options)
+    end
+
     # Deletes the profile that's specified in the `ProfileId` parameter.
     #
     # @option params [required, String] :profile_id
-    #   The ID of the profile that you are deleting.
+    #   The identifier of the profile that you are deleting.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -1692,7 +1743,7 @@ module Aws::Transfer
     #   when you create an agreement.
     #
     # @option params [required, String] :server_id
-    #   The server ID that's associated with the agreement.
+    #   The server identifier that's associated with the agreement.
     #
     # @return [Types::DescribeAgreementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1878,6 +1929,48 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Returns the details of the host key that's specified by the
+    # `HostKeyId` and `ServerId`.
+    #
+    # @option params [required, String] :server_id
+    #   The identifier of the server that contains the host key that you want
+    #   described.
+    #
+    # @option params [required, String] :host_key_id
+    #   The identifier of the host key that you want described.
+    #
+    # @return [Types::DescribeHostKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeHostKeyResponse#host_key #host_key} => Types::DescribedHostKey
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_host_key({
+    #     server_id: "ServerId", # required
+    #     host_key_id: "HostKeyId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.host_key.arn #=> String
+    #   resp.host_key.host_key_id #=> String
+    #   resp.host_key.host_key_fingerprint #=> String
+    #   resp.host_key.description #=> String
+    #   resp.host_key.type #=> String
+    #   resp.host_key.date_imported #=> Time
+    #   resp.host_key.tags #=> Array
+    #   resp.host_key.tags[0].key #=> String
+    #   resp.host_key.tags[0].value #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeHostKey AWS API Documentation
+    #
+    # @overload describe_host_key(params = {})
+    # @param [Hash] params ({})
+    def describe_host_key(params = {}, options = {})
+      req = build_request(:describe_host_key, params)
+      req.send_request(options)
+    end
+
     # Returns the details of the profile that's specified by the
     # `ProfileId`.
     #
@@ -2020,6 +2113,9 @@ module Aws::Transfer
     #   resp.server.workflow_details.on_upload #=> Array
     #   resp.server.workflow_details.on_upload[0].workflow_id #=> String
     #   resp.server.workflow_details.on_upload[0].execution_role #=> String
+    #   resp.server.workflow_details.on_partial_upload #=> Array
+    #   resp.server.workflow_details.on_partial_upload[0].workflow_id #=> String
+    #   resp.server.workflow_details.on_partial_upload[0].execution_role #=> String
     #
     #
     # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -2233,6 +2329,57 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Adds a host key to the server that's specified by the `ServerId`
+    # parameter.
+    #
+    # @option params [required, String] :server_id
+    #   The identifier of the server that contains the host key that you are
+    #   importing.
+    #
+    # @option params [required, String] :host_key_body
+    #   The public key portion of an SSH key pair.
+    #
+    #   Transfer Family accepts RSA, ECDSA, and ED25519 keys.
+    #
+    # @option params [String] :description
+    #   The text description that identifies this host key.
+    #
+    # @option params [Array<Types::Tag>] :tags
+    #   Key-value pairs that can be used to group and search for host keys.
+    #
+    # @return [Types::ImportHostKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ImportHostKeyResponse#server_id #server_id} => String
+    #   * {Types::ImportHostKeyResponse#host_key_id #host_key_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.import_host_key({
+    #     server_id: "ServerId", # required
+    #     host_key_body: "HostKey", # required
+    #     description: "HostKeyDescription",
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.server_id #=> String
+    #   resp.host_key_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportHostKey AWS API Documentation
+    #
+    # @overload import_host_key(params = {})
+    # @param [Hash] params ({})
+    def import_host_key(params = {}, options = {})
+      req = build_request(:import_host_key, params)
+      req.send_request(options)
+    end
+
     # Adds a Secure Shell (SSH) public key to a user account identified by a
     # `UserName` value assigned to the specific file transfer
     # protocol-enabled server, identified by `ServerId`.
@@ -2551,6 +2698,56 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Returns a list of host keys for the server that's specified by the
+    # `ServerId` parameter.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of host keys to return.
+    #
+    # @option params [String] :next_token
+    #   When there are additional results that were not returned, a
+    #   `NextToken` parameter is returned. You can use that value for a
+    #   subsequent call to `ListHostKeys` to continue listing results.
+    #
+    # @option params [required, String] :server_id
+    #   The identifier of the server that contains the host keys that you want
+    #   to view.
+    #
+    # @return [Types::ListHostKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListHostKeysResponse#next_token #next_token} => String
+    #   * {Types::ListHostKeysResponse#server_id #server_id} => String
+    #   * {Types::ListHostKeysResponse#host_keys #host_keys} => Array&lt;Types::ListedHostKey&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_host_keys({
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #     server_id: "ServerId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.server_id #=> String
+    #   resp.host_keys #=> Array
+    #   resp.host_keys[0].arn #=> String
+    #   resp.host_keys[0].host_key_id #=> String
+    #   resp.host_keys[0].fingerprint #=> String
+    #   resp.host_keys[0].description #=> String
+    #   resp.host_keys[0].type #=> String
+    #   resp.host_keys[0].date_imported #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListHostKeys AWS API Documentation
+    #
+    # @overload list_host_keys(params = {})
+    # @param [Hash] params ({})
+    def list_host_keys(params = {}, options = {})
+      req = build_request(:list_host_keys, params)
+      req.send_request(options)
+    end
+
     # Returns a list of the profiles for your system. If you want to limit
     # the results to a certain number, supply a value for the `MaxResults`
     # parameter. If you ran the command previously and received a value for
@@ -2879,8 +3076,8 @@ module Aws::Transfer
       req.send_request(options)
     end
 
-    # Begins an outbound file transfer. You specify the `ConnectorId` and
-    # the file paths for where to send the files.
+    # Begins an outbound file transfer to a remote AS2 server. You specify
+    # the `ConnectorId` and the file paths for where to send the files.
     #
     # @option params [required, String] :connector_id
     #   The unique identifier for the connector.
@@ -3482,6 +3679,46 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Updates the description for the host key that's specified by the
+    # `ServerId` and `HostKeyId` parameters.
+    #
+    # @option params [required, String] :server_id
+    #   The identifier of the server that contains the host key that you are
+    #   updating.
+    #
+    # @option params [required, String] :host_key_id
+    #   The identifier of the host key that you are updating.
+    #
+    # @option params [required, String] :description
+    #   An updated description for the host key.
+    #
+    # @return [Types::UpdateHostKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateHostKeyResponse#server_id #server_id} => String
+    #   * {Types::UpdateHostKeyResponse#host_key_id #host_key_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_host_key({
+    #     server_id: "ServerId", # required
+    #     host_key_id: "HostKeyId", # required
+    #     description: "HostKeyDescription", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.server_id #=> String
+    #   resp.host_key_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateHostKey AWS API Documentation
+    #
+    # @overload update_host_key(params = {})
+    # @param [Hash] params ({})
+    def update_host_key(params = {}, options = {})
+      req = build_request(:update_host_key, params)
+      req.send_request(options)
+    end
+
     # Updates some of the parameters for an existing profile. Provide the
     # `ProfileId` for the profile that you want to update, along with the
     # new values for the parameters to update.
@@ -3623,7 +3860,9 @@ module Aws::Transfer
     #    </note>
     #
     # @option params [String] :host_key
-    #   The RSA, ECDSA, or ED25519 private key to use for your server.
+    #   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:
@@ -3652,7 +3891,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 [Change the host key for your SFTP-enabled
+    #   For more information, see [Update host keys for your SFTP-enabled
     #   server][1] in the *Transfer Family User Guide*.
     #
     #
@@ -3736,6 +3975,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
+    #   execution role) for a workflow to execute on partial upload. A partial
+    #   upload occurs when a file is open when the session disconnects.
+    #
     #   To remove an associated workflow from a server, you can provide an
     #   empty `OnUpload` object, as in the following example.
     #
@@ -3778,7 +4022,13 @@ module Aws::Transfer
     #     security_policy_name: "SecurityPolicyName",
     #     server_id: "ServerId", # required
     #     workflow_details: {
-    #       on_upload: [ # required
+    #       on_upload: [
+    #         {
+    #           workflow_id: "WorkflowId", # required
+    #           execution_role: "Role", # required
+    #         },
+    #       ],
+    #       on_partial_upload: [
     #         {
     #           workflow_id: "WorkflowId", # required
     #           execution_role: "Role", # required
@@ -3958,7 +4208,7 @@ module Aws::Transfer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-transfer'
-      context[:gem_version] = '1.58.0'
+      context[:gem_version] = '1.60.0'
       Seahorse::Client::Request.new(handlers, context)
     end