aws-sdk-transfer 1.57.0 → 1.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9979487ffcaf1e591f578ab8ead99de5e8a4762488a0e550ef8ef4ff0f6e6979
-  data.tar.gz: d20d0d5356f22d95f553f54e40921aab60cfd6957b02f1e2b146a0f2c5a73161
+  metadata.gz: 98089ecdcf2e9a746ee65bc0a529c97f48f666deabec6dced02fe323e14d899a
+  data.tar.gz: dd0f7bd139618d8dcfb05ef4b7c8b79ff9e63c7414d999515c4a5ca393cbb8e2
 SHA512:
-  metadata.gz: e00b9bfccaab724d24fd3beadc20ca3193d052e900ca9762f6ca83f6117ecb4b0119e9e84c3a42aa6ae6b727ee46b3830ac6822e50e2355930415ff084a7f286
-  data.tar.gz: 43b51b9c439f02926bb1b6f24548efe1f90e4531f69f86fc7f6b37a16ae497dc567713b9b4eddda13026d526c7cb407a6d61152a20ed16080f3a2806d3874a3c
+  metadata.gz: ad1509226e8f09f092ae565f03782438aeed5440b0aa781df7d1612c0f821e32c9e6685c4ea5d415f14a731070c102cd500aa0202cf48ac56f36ed0ebf68580d
+  data.tar.gz: 6831c9934188d2e9857dfb6a9f52bc7e75bd8b53625970ec18dee2e277efbb08c581a84bc0888d5f1b0a8c2acb52ad7d5b4dcbd1745257691bc032292344ac55

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+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)
+------------------
+
+* Feature - Documentation updates for AWS Transfer Family
+
 1.57.0 (2022-07-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.57.0
+1.59.0

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

@@ -547,9 +547,18 @@ module Aws::Transfer
     #   A `BaseDirectory` example is `/DOC-EXAMPLE-BUCKET/home/mydirectory `.
     #
     # @option params [required, String] :access_role
-    #   The Amazon Resource Name (ARN) of the Identity and Access Management
-    #   (IAM) role that grants access to at least the `HomeDirectory` of your
-    #   users' Amazon S3 buckets.
+    #   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`.
     #
     # @option params [String] :status
     #   The status of the agreement. The agreement can be either `ACTIVE` or
@@ -672,10 +681,10 @@ module Aws::Transfer
     # partner and the AS2 process.
     #
     # @option params [required, String] :as_2_id
-    #   The `As2Id` is the *AS2-name*, as defined in the defined in the [RFC
-    #   4130][1]. 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
+    #   The `As2Id` is the *AS2-name*, as defined in the [RFC 4130][1]. 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.
     #
     #
@@ -1474,6 +1483,33 @@ 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
+    #   Provide the ID of the server that contains the host key that you are
+    #   deleting.
+    #
+    # @option params [required, String] :host_key_id
+    #   The ID 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
@@ -1869,6 +1905,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
+    #   Provide the ID of the server that contains the host key that you want
+    #   described.
+    #
+    # @option params [required, String] :host_key_id
+    #   Provide the ID 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`.
     #
@@ -2224,6 +2302,56 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Adds a host key to the server specified by the `ServerId` parameter.
+    #
+    # @option params [required, String] :server_id
+    #   Provide the ID 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
+    #   Enter a text description to identify 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`.
@@ -2542,6 +2670,56 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Returns a list of host keys for the server specified by the `ServerId`
+    # paramter.
+    #
+    # @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
+    #   Provide the ID 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
@@ -3307,10 +3485,13 @@ module Aws::Transfer
     #   inactive agreement or the reverse.
     #
     # @option params [String] :local_profile_id
+    #   A unique identifier for the AS2 local profile.
+    #
     #   To change the local profile identifier, provide a new value here.
     #
     # @option params [String] :partner_profile_id
-    #   To change the partner profile identifier, provide a new value here.
+    #   A unique identifier for the partner profile. To change the partner
+    #   profile identifier, provide a new value here.
     #
     # @option params [String] :base_directory
     #   To change the landing directory (folder) for files that are
@@ -3318,9 +3499,18 @@ module Aws::Transfer
     #   example, `/DOC-EXAMPLE-BUCKET/home/mydirectory `.
     #
     # @option params [String] :access_role
-    #   The Amazon Resource Name (ARN) of the Identity and Access Management
-    #   (IAM) role that grants access to at least the `HomeDirectory` of your
-    #   users' Amazon S3 buckets.
+    #   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`.
     #
     # @return [Types::UpdateAgreementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -3461,6 +3651,46 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Updates the description for the host key specified by the specified by
+    # the `ServerId` and `HostKeyId` parameters.
+    #
+    # @option params [required, String] :server_id
+    #   Provide the ID of the server that contains the host key that you are
+    #   updating.
+    #
+    # @option params [required, String] :host_key_id
+    #   Provide the ID of the host key that you are updating.
+    #
+    # @option params [required, String] :description
+    #   Provide 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.
@@ -3672,28 +3902,34 @@ module Aws::Transfer
     #   transfer protocol client can connect to your server's endpoint. The
     #   available protocols are:
     #
-    #   * Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over
-    #     SSH
+    #   * `SFTP` (Secure Shell (SSH) File Transfer Protocol): File transfer
+    #     over SSH
     #
-    #   * File Transfer Protocol Secure (FTPS): File transfer with TLS
+    #   * `FTPS` (File Transfer Protocol Secure): File transfer with TLS
     #     encryption
     #
-    #   * File Transfer Protocol (FTP): Unencrypted file transfer
+    #   * `FTP` (File Transfer Protocol): Unencrypted file transfer
+    #
+    #   * `AS2` (Applicability Statement 2): used for transporting structured
+    #     business-to-business data
+    #
+    #   <note markdown="1"> * 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.
     #
-    #   <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in Amazon
-    #   Web ServicesCertificate Manager (ACM) which will be used to identify
-    #   your server when clients connect to it over FTPS.
+    #   * If `Protocol` includes either `FTP` or `FTPS`, then the
+    #     `EndpointType` must be `VPC` and the `IdentityProviderType` must be
+    #     `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
     #
-    #    If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType`
-    #   must be `VPC` and the `IdentityProviderType` must be
-    #   `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
+    #   * If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be
+    #     associated.
     #
-    #    If `Protocol` 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`.
     #
-    #    If `Protocol` is set only to `SFTP`, the `EndpointType` can be set to
-    #   `PUBLIC` and the `IdentityProviderType` can be set to
-    #   `SERVICE_MANAGED`.
+    #   * If `Protocol` includes `AS2`, then the `EndpointType` must be `VPC`,
+    #     and domain must be Amazon S3.
     #
     #    </note>
     #
@@ -3931,7 +4167,7 @@ module Aws::Transfer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-transfer'
-      context[:gem_version] = '1.57.0'
+      context[:gem_version] = '1.59.0'
       Seahorse::Client::Request.new(handlers, context)
     end