lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.76.0 vs lib/aws-sdk-transfer/client.rb in aws-sdk-transfer-1.77.0
- old
+ new
@@ -582,10 +582,16 @@
# protocol.
#
# 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
# `--send-file-paths /bucket/dir/file.txt`, parent directory is
# `/bucket/dir/`) to temporarily store a processed AS2 message file,
@@ -601,10 +607,18 @@
# access role requires the `secretsmanager:GetSecretValue` permission
# for the secret. If the secret is encrypted using a customer-managed
# key instead of the Amazon Web Services managed key in Secrets Manager,
# then the role also needs the `kms:Decrypt` permission for that key.
#
+ # **For SFTP connectors**
+ #
+ # Make sure that the access role provides read and write access to the
+ # parent directory of the file location that's used in the
+ # `StartFileTransfer` request. Additionally, make sure that the role
+ # provides `secretsmanager:GetSecretValue` permission to Secrets
+ # Manager.
+ #
# @option params [String] :status
# The status of the agreement. The agreement can be either `ACTIVE` or
# `INACTIVE`.
#
# @option params [Array<Types::Tag>] :tags
@@ -643,31 +657,41 @@
def create_agreement(params = {}, options = {})
req = build_request(:create_agreement, params)
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`).
#
# </note>
#
#
#
# [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.
#
# @option params [Types::As2ConnectorConfig] :as_2_config
# 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
# `--send-file-paths /bucket/dir/file.txt`, parent directory is
# `/bucket/dir/`) to temporarily store a processed AS2 message file,
@@ -683,10 +707,18 @@
# access role requires the `secretsmanager:GetSecretValue` permission
# for the secret. If the secret is encrypted using a customer-managed
# key instead of the Amazon Web Services managed key in Secrets Manager,
# then the role also needs the `kms:Decrypt` permission for that key.
#
+ # **For SFTP connectors**
+ #
+ # Make sure that the access role provides read and write access to the
+ # parent directory of the file location that's used in the
+ # `StartFileTransfer` request. Additionally, make sure that the role
+ # provides `secretsmanager:GetSecretValue` permission to Secrets
+ # Manager.
+ #
# @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
# Amazon S3 events. When set, you can view connector activity in your
# CloudWatch logs.
@@ -3264,12 +3296,12 @@
#
# * For an SFTP connector, the file transfer can be either outbound or
# 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.
#
# * If you are transferring file to a partner's SFTP server from
# Amazon Web Services storage, you specify one or more
@@ -3282,10 +3314,14 @@
# @option params [Array<String>] :send_file_paths
# 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>
+ #
# @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.
#
# @option params [String] :local_directory_path
@@ -3788,10 +3824,16 @@
# To change the landing directory (folder) for files that are
# transferred, provide the bucket folder that you want to use; for
# 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
# `--send-file-paths /bucket/dir/file.txt`, parent directory is
# `/bucket/dir/`) to temporarily store a processed AS2 message file,
@@ -3807,10 +3849,18 @@
# access role requires the `secretsmanager:GetSecretValue` permission
# for the secret. If the secret is encrypted using a customer-managed
# key instead of the Amazon Web Services managed key in Secrets Manager,
# then the role also needs the `kms:Decrypt` permission for that key.
#
+ # **For SFTP connectors**
+ #
+ # Make sure that the access role provides read and write access to the
+ # parent directory of the file location that's used in the
+ # `StartFileTransfer` request. Additionally, make sure that the role
+ # provides `secretsmanager:GetSecretValue` permission to Secrets
+ # Manager.
+ #
# @return [Types::UpdateAgreementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateAgreementResponse#agreement_id #agreement_id} => String
#
# @example Request syntax with placeholder values
@@ -3891,10 +3941,16 @@
#
# @option params [Types::As2ConnectorConfig] :as_2_config
# 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
# `--send-file-paths /bucket/dir/file.txt`, parent directory is
# `/bucket/dir/`) to temporarily store a processed AS2 message file,
@@ -3910,10 +3966,18 @@
# access role requires the `secretsmanager:GetSecretValue` permission
# for the secret. If the secret is encrypted using a customer-managed
# key instead of the Amazon Web Services managed key in Secrets Manager,
# then the role also needs the `kms:Decrypt` permission for that key.
#
+ # **For SFTP connectors**
+ #
+ # Make sure that the access role provides read and write access to the
+ # parent directory of the file location that's used in the
+ # `StartFileTransfer` request. Additionally, make sure that the role
+ # provides `secretsmanager:GetSecretValue` permission to Secrets
+ # Manager.
+ #
# @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
# Amazon S3 events. When set, you can view connector activity in your
# CloudWatch logs.
@@ -4512,10 +4576,10 @@
operation: config.api.operation(operation_name),
client: self,
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
# Polls an API operation until a resource enters a desired state.
#