aws-sdk-transfer 1.76.0 → 1.77.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe6bcc7cd53f1c16ce55c7e85f0cdcc9b74df5709602cdfd3ba72b6deff1bd1d
-  data.tar.gz: b5a2de2447abcbe9dfecf06a61b9660269e289358c634db76d0648cafd9128c4
+  metadata.gz: e39f03b80d097b542f1c6a2b6f9e9cbb550daa88f0d94969bbe01c1f8b3359b5
+  data.tar.gz: 8552dba4bfc488adf4529ffba349e028d3b9bac9ef7def0dfff0254bca396cc2
 SHA512:
-  metadata.gz: a515010e1ac93f3f4fd7b7d6844fb4159a8b9c1930305f375ce42a7a03df623e9ca59a6cd724b65652d86da42f48a998792d8e70d40c35179b29a3b0d4a4bd69
-  data.tar.gz: d267ddcf2706834f1ca7240500d3de7e075e61303191e7435c313c7160bdd1821fc38f7adcd35f70a29cfadf2765453a094da71e842467eb31154341bb3ac5ee
+  metadata.gz: 89b5c9f925280f5ba79c4fbd3b51555b7daa285f8a7257cc8c6e62abddddb904bc4c2ba624ce800fa372ea308a6dc5f2f8dbf8726aaf358dfc2a65b55a5af5d4
+  data.tar.gz: 0b290b7857671578d61780cc996a818ee204e92c621575bb3fa3bb080e2b0053e8248b69578785d75e8c45bc471f5460610d896576ca987a92cc2fe799d56f9f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.77.0 (2023-08-10)
+------------------
+
+* Feature - Documentation updates for AW Transfer Family
+
 1.76.0 (2023-07-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.76.0
+1.77.0

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

@@ -584,6 +584,12 @@ module Aws::Transfer
     #   A `BaseDirectory` example is `/DOC-EXAMPLE-BUCKET/home/mydirectory`.
     #
     # @option params [required, String] :access_role
+    #   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
@@ -603,6 +609,14 @@ module Aws::Transfer
     #   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.
+    #
     # @option params [String] :status
     #   The status of the agreement. The agreement can be either `ACTIVE` or
     #   `INACTIVE`.
@@ -645,10 +659,13 @@ module Aws::Transfer
       req.send_request(options)
     end
 
-    # Creates the connector, which captures the parameters for an outbound
-    # connection for the AS2 or SFTP protocol. The connector is required for
-    # sending files to an externally hosted AS2 or SFTP server. For more
-    # details about AS2 connectors, see [Create AS2 connectors][1].
+    # Creates the connector, which captures the parameters for a connection
+    # for the AS2 or SFTP protocol. For AS2, the connector is required for
+    # sending files to an externally hosted AS2 server. For SFTP, the
+    # connector is required when sending files to an SFTP server or
+    # receiving files from an SFTP server. For more details about
+    # connectors, see [Create AS2 connectors][1] and [Create SFTP
+    # connectors][2].
     #
     # <note markdown="1"> You must specify exactly one configuration object: either for AS2
     # (`As2Config`) or SFTP (`SftpConfig`).
@@ -658,6 +675,7 @@ module Aws::Transfer
     #
     #
     # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector
+    # [2]: https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html
     #
     # @option params [required, String] :url
     #   The URL of the partner's AS2 or SFTP endpoint.
@@ -666,6 +684,12 @@ module Aws::Transfer
     #   A structure that contains the parameters for an AS2 connector object.
     #
     # @option params [required, String] :access_role
+    #   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
@@ -685,6 +709,14 @@ module Aws::Transfer
     #   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.
+    #
     # @option params [String] :logging_role
     #   The Amazon Resource Name (ARN) of the Identity and Access Management
     #   (IAM) role that allows a connector to turn on CloudWatch logging for
@@ -3266,8 +3298,8 @@ module Aws::Transfer
     #   inbound. In both cases, you specify the `ConnectorId`. Depending on
     #   the direction of the transfer, you also specify the following items:
     #
-    #   * If you are transferring file from a partner's SFTP server to a
-    #     Transfer Family server, you specify one or more
+    #   * If you are transferring file from a partner's SFTP server to
+    #     Amazon Web Services storage, you specify one or more
     #     `RetreiveFilePaths` to identify the files you want to transfer,
     #     and a `LocalDirectoryPath` to specify the destination folder.
     #
@@ -3284,6 +3316,10 @@ module Aws::Transfer
     #   represents a source file path for one outbound file transfer. For
     #   example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
     #
+    #   <note markdown="1"> Replace ` DOC-EXAMPLE-BUCKET `with one of your actual buckets.
+    #
+    #    </note>
+    #
     # @option params [Array<String>] :retrieve_file_paths
     #   One or more source paths for the partner's SFTP server. Each string
     #   represents a source file path for one inbound file transfer.
@@ -3790,6 +3826,12 @@ module Aws::Transfer
     #   example, `/DOC-EXAMPLE-BUCKET/home/mydirectory `.
     #
     # @option params [String] :access_role
+    #   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
@@ -3809,6 +3851,14 @@ module Aws::Transfer
     #   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.
+    #
     # @return [Types::UpdateAgreementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateAgreementResponse#agreement_id #agreement_id} => String
@@ -3893,6 +3943,12 @@ module Aws::Transfer
     #   A structure that contains the parameters for an AS2 connector object.
     #
     # @option params [String] :access_role
+    #   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
@@ -3912,6 +3968,14 @@ module Aws::Transfer
     #   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.
+    #
     # @option params [String] :logging_role
     #   The Amazon Resource Name (ARN) of the Identity and Access Management
     #   (IAM) role that allows a connector to turn on CloudWatch logging for
@@ -4514,7 +4578,7 @@ module Aws::Transfer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-transfer'
-      context[:gem_version] = '1.76.0'
+      context[:gem_version] = '1.77.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -385,6 +385,12 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] access_role
+    #   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
@@ -404,6 +410,14 @@ module Aws::Transfer
     #   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.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -454,6 +468,12 @@ module Aws::Transfer
     #   @return [Types::As2ConnectorConfig]
     #
     # @!attribute [rw] access_role
+    #   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
@@ -473,6 +493,14 @@ module Aws::Transfer
     #   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.
     #   @return [String]
     #
     # @!attribute [rw] logging_role
@@ -1917,6 +1945,12 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] access_role
+    #   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
@@ -1936,6 +1970,14 @@ module Aws::Transfer
     #   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.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -2067,6 +2109,12 @@ module Aws::Transfer
     #   @return [Types::As2ConnectorConfig]
     #
     # @!attribute [rw] access_role
+    #   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
@@ -2086,6 +2134,14 @@ module Aws::Transfer
     #   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.
     #   @return [String]
     #
     # @!attribute [rw] logging_role
@@ -4797,6 +4853,10 @@ module Aws::Transfer
     #   One or more source paths for the Transfer Family server. Each string
     #   represents a source file path for one outbound file transfer. For
     #   example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
+    #
+    #   <note markdown="1"> Replace ` DOC-EXAMPLE-BUCKET `with one of your actual buckets.
+    #
+    #    </note>
     #   @return [Array<String>]
     #
     # @!attribute [rw] retrieve_file_paths
@@ -5296,6 +5356,12 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] access_role
+    #   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
@@ -5315,6 +5381,14 @@ module Aws::Transfer
     #   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.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateAgreementRequest AWS API Documentation
@@ -5400,6 +5474,12 @@ module Aws::Transfer
     #   @return [Types::As2ConnectorConfig]
     #
     # @!attribute [rw] access_role
+    #   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
@@ -5419,6 +5499,14 @@ module Aws::Transfer
     #   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.
     #   @return [String]
     #
     # @!attribute [rw] logging_role

data/lib/aws-sdk-transfer.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-transfer/customizations'
 # @!group service
 module Aws::Transfer
 
-  GEM_VERSION = '1.76.0'
+  GEM_VERSION = '1.77.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-transfer
 version: !ruby/object:Gem::Version
-  version: 1.76.0
+  version: 1.77.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-25 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core