aws-sdk-transfer 1.74.0 → 1.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e379146c733532ac161e8ed5a63dffc3118cd4d7b69294ff56a8f0f664cbc9a
-  data.tar.gz: 2ff49c06ec9b15c8ef9ded0ecd274734b4c28ff73f50821f408c435aec741798
+  metadata.gz: fe6bcc7cd53f1c16ce55c7e85f0cdcc9b74df5709602cdfd3ba72b6deff1bd1d
+  data.tar.gz: b5a2de2447abcbe9dfecf06a61b9660269e289358c634db76d0648cafd9128c4
 SHA512:
-  metadata.gz: 0aa7f1029f5861457cac7999837fd4e3244e5a90b6d413a0dbf19165e8f924f403661e222195fda2cf5ec220d080795a97f599d757c456c690ab525d9418c2a1
-  data.tar.gz: 71e5f56fa75d4e284f86734802d583765b5593fe72c7d7c3487f35f681e3fc4190a1a9bb893a107283357cca15eb259ca2cf26a5f1f4bc763880187537747db3
+  metadata.gz: a515010e1ac93f3f4fd7b7d6844fb4159a8b9c1930305f375ce42a7a03df623e9ca59a6cd724b65652d86da42f48a998792d8e70d40c35179b29a3b0d4a4bd69
+  data.tar.gz: d267ddcf2706834f1ca7240500d3de7e075e61303191e7435c313c7160bdd1821fc38f7adcd35f70a29cfadf2765453a094da71e842467eb31154341bb3ac5ee

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.76.0 (2023-07-25)
+------------------
+
+* Feature - This release adds support for SFTP Connectors.
+
+1.75.0 (2023-07-11)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.74.0 (2023-07-06)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.74.0
+1.76.0

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

@@ -216,6 +216,10 @@ module Aws::Transfer
     #   @option options [Boolean] :endpoint_discovery (false)
     #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
+    #   @option options [Boolean] :ignore_configured_endpoint_urls
+    #     Setting to true disables use of endpoint URLs provided via environment
+    #     variables and the shared configuration file.
+    #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
     #
@@ -642,19 +646,24 @@ module Aws::Transfer
     end
 
     # Creates the connector, which captures the parameters for an outbound
-    # connection for the AS2 protocol. The connector is required for sending
-    # files to an externally hosted AS2 server. For more details about
-    # connectors, see [Create AS2 connectors][1].
+    # 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].
+    #
+    # <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
     #
     # @option params [required, String] :url
-    #   The URL of the partner's AS2 endpoint.
+    #   The URL of the partner's AS2 or SFTP endpoint.
     #
-    # @option params [required, Types::As2ConnectorConfig] :as_2_config
-    #   A structure that contains the parameters for a connector object.
+    # @option params [Types::As2ConnectorConfig] :as_2_config
+    #   A structure that contains the parameters for an AS2 connector object.
     #
     # @option params [required, String] :access_role
     #   With AS2, you can send files by calling `StartFileTransfer` and
@@ -686,6 +695,9 @@ module Aws::Transfer
     #   Key-value pairs that can be used to group and search for connectors.
     #   Tags are metadata attached to connectors for any purpose.
     #
+    # @option params [Types::SftpConnectorConfig] :sftp_config
+    #   A structure that contains the parameters for an SFTP connector object.
+    #
     # @return [Types::CreateConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateConnectorResponse#connector_id #connector_id} => String
@@ -694,7 +706,7 @@ module Aws::Transfer
     #
     #   resp = client.create_connector({
     #     url: "Url", # required
-    #     as_2_config: { # required
+    #     as_2_config: {
     #       local_profile_id: "ProfileId",
     #       partner_profile_id: "ProfileId",
     #       message_subject: "MessageSubject",
@@ -713,6 +725,10 @@ module Aws::Transfer
     #         value: "TagValue", # required
     #       },
     #     ],
+    #     sftp_config: {
+    #       user_secret_id: "SecretId",
+    #       trusted_host_keys: ["SftpConnectorTrustedHostKey"],
+    #     },
     #   })
     #
     # @example Response structure
@@ -1183,8 +1199,8 @@ module Aws::Transfer
     #
     #   In most cases, you can use this value instead of the session policy to
     #   lock your user down to the designated home directory ("`chroot`").
-    #   To do this, you can set `Entry` to `/` and set `Target` to the
-    #   HomeDirectory parameter value.
+    #   To do this, you can set `Entry` to `/` and set `Target` to the value
+    #   the user should see for their home directory when they log in.
     #
     #   The following is an `Entry` and `Target` pair example for `chroot`.
     #
@@ -1602,7 +1618,7 @@ module Aws::Transfer
       req.send_request(options)
     end
 
-    # Deletes the agreement that's specified in the provided `ConnectorId`.
+    # Deletes the connector that's specified in the provided `ConnectorId`.
     #
     # @option params [required, String] :connector_id
     #   The unique identifier for the connector.
@@ -1975,6 +1991,9 @@ module Aws::Transfer
     #   resp.connector.tags #=> Array
     #   resp.connector.tags[0].key #=> String
     #   resp.connector.tags[0].value #=> String
+    #   resp.connector.sftp_config.user_secret_id #=> String
+    #   resp.connector.sftp_config.trusted_host_keys #=> Array
+    #   resp.connector.sftp_config.trusted_host_keys[0] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeConnector AWS API Documentation
     #
@@ -3237,16 +3256,49 @@ module Aws::Transfer
       req.send_request(options)
     end
 
-    # Begins an outbound file transfer to a remote AS2 server. You specify
-    # the `ConnectorId` and the file paths for where to send the files.
+    # Begins a file transfer between local Amazon Web Services storage and a
+    # remote AS2 or SFTP server.
+    #
+    # * For an AS2 connector, you specify the `ConnectorId` and one or more
+    #   `SendFilePaths` to identify the files you want to transfer.
+    #
+    # * 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
+    #     `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
+    #     `SendFilePaths` to identify the files you want to transfer, and a
+    #     `RemoteDirectoryPath` to specify the destination folder.
     #
     # @option params [required, String] :connector_id
     #   The unique identifier for the connector.
     #
-    # @option params [required, Array<String>] :send_file_paths
-    #   An array of strings. Each string represents the absolute path for one
-    #   outbound file transfer. For example, ` DOC-EXAMPLE-BUCKET/myfile.txt
-    #   `.
+    # @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 `.
+    #
+    # @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
+    #   For an inbound transfer, the `LocaDirectoryPath` specifies the
+    #   destination for one or more files that are transferred from the
+    #   partner's SFTP server.
+    #
+    # @option params [String] :remote_directory_path
+    #   For an outbound transfer, the `RemoteDirectoryPath` specifies the
+    #   destination for one or more files that are transferred to the
+    #   partner's SFTP server. If you don't specify a `RemoteDirectoryPath`,
+    #   the destination for transferred files is the SFTP user's home
+    #   directory.
     #
     # @return [Types::StartFileTransferResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -3256,7 +3308,10 @@ module Aws::Transfer
     #
     #   resp = client.start_file_transfer({
     #     connector_id: "ConnectorId", # required
-    #     send_file_paths: ["FilePath"], # required
+    #     send_file_paths: ["FilePath"],
+    #     retrieve_file_paths: ["FilePath"],
+    #     local_directory_path: "FilePath",
+    #     remote_directory_path: "FilePath",
     #   })
     #
     # @example Response structure
@@ -3378,6 +3433,41 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Tests whether your SFTP connector is set up successfully. We highly
+    # recommend that you call this operation to test your ability to
+    # transfer files between a Transfer Family server and a trading
+    # partner's SFTP server.
+    #
+    # @option params [required, String] :connector_id
+    #   The unique identifier for the connector.
+    #
+    # @return [Types::TestConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::TestConnectionResponse#connector_id #connector_id} => String
+    #   * {Types::TestConnectionResponse#status #status} => String
+    #   * {Types::TestConnectionResponse#status_message #status_message} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.test_connection({
+    #     connector_id: "ConnectorId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.connector_id #=> String
+    #   resp.status #=> String
+    #   resp.status_message #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestConnection AWS API Documentation
+    #
+    # @overload test_connection(params = {})
+    # @param [Hash] params ({})
+    def test_connection(params = {}, options = {})
+      req = build_request(:test_connection, params)
+      req.send_request(options)
+    end
+
     # If the `IdentityProviderType` of a file transfer protocol-enabled
     # server is `AWS_DIRECTORY_SERVICE` or `API_Gateway`, tests whether your
     # identity provider is set up successfully. We highly recommend that you
@@ -3797,10 +3887,10 @@ module Aws::Transfer
     #   The unique identifier for the connector.
     #
     # @option params [String] :url
-    #   The URL of the partner's AS2 endpoint.
+    #   The URL of the partner's AS2 or SFTP endpoint.
     #
     # @option params [Types::As2ConnectorConfig] :as_2_config
-    #   A structure that contains the parameters for a connector object.
+    #   A structure that contains the parameters for an AS2 connector object.
     #
     # @option params [String] :access_role
     #   With AS2, you can send files by calling `StartFileTransfer` and
@@ -3828,6 +3918,9 @@ module Aws::Transfer
     #   Amazon S3 events. When set, you can view connector activity in your
     #   CloudWatch logs.
     #
+    # @option params [Types::SftpConnectorConfig] :sftp_config
+    #   A structure that contains the parameters for an SFTP connector object.
+    #
     # @return [Types::UpdateConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateConnectorResponse#connector_id #connector_id} => String
@@ -3850,6 +3943,10 @@ module Aws::Transfer
     #     },
     #     access_role: "Role",
     #     logging_role: "Role",
+    #     sftp_config: {
+    #       user_secret_id: "SecretId",
+    #       trusted_host_keys: ["SftpConnectorTrustedHostKey"],
+    #     },
     #   })
     #
     # @example Response structure
@@ -4417,7 +4514,7 @@ module Aws::Transfer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-transfer'
-      context[:gem_version] = '1.74.0'
+      context[:gem_version] = '1.76.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -236,6 +236,7 @@ module Aws::Transfer
     S3Tags = Shapes::ListShape.new(name: 'S3Tags')
     S3VersionId = Shapes::StringShape.new(name: 'S3VersionId')
     SecondaryGids = Shapes::ListShape.new(name: 'SecondaryGids')
+    SecretId = Shapes::StringShape.new(name: 'SecretId')
     SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
     SecurityGroupIds = Shapes::ListShape.new(name: 'SecurityGroupIds')
     SecurityPolicyName = Shapes::StringShape.new(name: 'SecurityPolicyName')
@@ -251,6 +252,9 @@ module Aws::Transfer
     SessionId = Shapes::StringShape.new(name: 'SessionId')
     SetStatOption = Shapes::StringShape.new(name: 'SetStatOption')
     SftpAuthenticationMethods = Shapes::StringShape.new(name: 'SftpAuthenticationMethods')
+    SftpConnectorConfig = Shapes::StructureShape.new(name: 'SftpConnectorConfig')
+    SftpConnectorTrustedHostKey = Shapes::StringShape.new(name: 'SftpConnectorTrustedHostKey')
+    SftpConnectorTrustedHostKeyList = Shapes::ListShape.new(name: 'SftpConnectorTrustedHostKeyList')
     SigningAlg = Shapes::StringShape.new(name: 'SigningAlg')
     SourceFileLocation = Shapes::StringShape.new(name: 'SourceFileLocation')
     SourceIp = Shapes::StringShape.new(name: 'SourceIp')
@@ -263,6 +267,7 @@ module Aws::Transfer
     StartFileTransferResponse = Shapes::StructureShape.new(name: 'StartFileTransferResponse')
     StartServerRequest = Shapes::StructureShape.new(name: 'StartServerRequest')
     State = Shapes::StringShape.new(name: 'State')
+    Status = Shapes::StringShape.new(name: 'Status')
     StatusCode = Shapes::IntegerShape.new(name: 'StatusCode')
     StepResultOutputsJson = Shapes::StringShape.new(name: 'StepResultOutputsJson')
     StopServerRequest = Shapes::StructureShape.new(name: 'StopServerRequest')
@@ -276,6 +281,8 @@ module Aws::Transfer
     TagStepDetails = Shapes::StructureShape.new(name: 'TagStepDetails')
     TagValue = Shapes::StringShape.new(name: 'TagValue')
     Tags = Shapes::ListShape.new(name: 'Tags')
+    TestConnectionRequest = Shapes::StructureShape.new(name: 'TestConnectionRequest')
+    TestConnectionResponse = Shapes::StructureShape.new(name: 'TestConnectionResponse')
     TestIdentityProviderRequest = Shapes::StructureShape.new(name: 'TestIdentityProviderRequest')
     TestIdentityProviderResponse = Shapes::StructureShape.new(name: 'TestIdentityProviderResponse')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
@@ -371,10 +378,11 @@ module Aws::Transfer
     CreateAgreementResponse.struct_class = Types::CreateAgreementResponse
 
     CreateConnectorRequest.add_member(:url, Shapes::ShapeRef.new(shape: Url, required: true, location_name: "Url"))
-    CreateConnectorRequest.add_member(:as_2_config, Shapes::ShapeRef.new(shape: As2ConnectorConfig, required: true, location_name: "As2Config"))
+    CreateConnectorRequest.add_member(:as_2_config, Shapes::ShapeRef.new(shape: As2ConnectorConfig, location_name: "As2Config"))
     CreateConnectorRequest.add_member(:access_role, Shapes::ShapeRef.new(shape: Role, required: true, location_name: "AccessRole"))
     CreateConnectorRequest.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
     CreateConnectorRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
+    CreateConnectorRequest.add_member(:sftp_config, Shapes::ShapeRef.new(shape: SftpConnectorConfig, location_name: "SftpConfig"))
     CreateConnectorRequest.struct_class = Types::CreateConnectorRequest
 
     CreateConnectorResponse.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
@@ -606,6 +614,7 @@ module Aws::Transfer
     DescribedConnector.add_member(:access_role, Shapes::ShapeRef.new(shape: Role, location_name: "AccessRole"))
     DescribedConnector.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
     DescribedConnector.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
+    DescribedConnector.add_member(:sftp_config, Shapes::ShapeRef.new(shape: SftpConnectorConfig, location_name: "SftpConfig"))
     DescribedConnector.struct_class = Types::DescribedConnector
 
     DescribedExecution.add_member(:execution_id, Shapes::ShapeRef.new(shape: ExecutionId, location_name: "ExecutionId"))
@@ -1046,6 +1055,12 @@ module Aws::Transfer
     ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ServiceErrorMessage, location_name: "Message"))
     ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
 
+    SftpConnectorConfig.add_member(:user_secret_id, Shapes::ShapeRef.new(shape: SecretId, location_name: "UserSecretId"))
+    SftpConnectorConfig.add_member(:trusted_host_keys, Shapes::ShapeRef.new(shape: SftpConnectorTrustedHostKeyList, location_name: "TrustedHostKeys"))
+    SftpConnectorConfig.struct_class = Types::SftpConnectorConfig
+
+    SftpConnectorTrustedHostKeyList.member = Shapes::ShapeRef.new(shape: SftpConnectorTrustedHostKey)
+
     SshPublicKey.add_member(:date_imported, Shapes::ShapeRef.new(shape: DateImported, required: true, location_name: "DateImported"))
     SshPublicKey.add_member(:ssh_public_key_body, Shapes::ShapeRef.new(shape: SshPublicKeyBody, required: true, location_name: "SshPublicKeyBody"))
     SshPublicKey.add_member(:ssh_public_key_id, Shapes::ShapeRef.new(shape: SshPublicKeyId, required: true, location_name: "SshPublicKeyId"))
@@ -1054,7 +1069,10 @@ module Aws::Transfer
     SshPublicKeys.member = Shapes::ShapeRef.new(shape: SshPublicKey)
 
     StartFileTransferRequest.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
-    StartFileTransferRequest.add_member(:send_file_paths, Shapes::ShapeRef.new(shape: FilePaths, required: true, location_name: "SendFilePaths"))
+    StartFileTransferRequest.add_member(:send_file_paths, Shapes::ShapeRef.new(shape: FilePaths, location_name: "SendFilePaths"))
+    StartFileTransferRequest.add_member(:retrieve_file_paths, Shapes::ShapeRef.new(shape: FilePaths, location_name: "RetrieveFilePaths"))
+    StartFileTransferRequest.add_member(:local_directory_path, Shapes::ShapeRef.new(shape: FilePath, location_name: "LocalDirectoryPath"))
+    StartFileTransferRequest.add_member(:remote_directory_path, Shapes::ShapeRef.new(shape: FilePath, location_name: "RemoteDirectoryPath"))
     StartFileTransferRequest.struct_class = Types::StartFileTransferRequest
 
     StartFileTransferResponse.add_member(:transfer_id, Shapes::ShapeRef.new(shape: TransferId, required: true, location_name: "TransferId"))
@@ -1087,6 +1105,14 @@ module Aws::Transfer
 
     Tags.member = Shapes::ShapeRef.new(shape: Tag)
 
+    TestConnectionRequest.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
+    TestConnectionRequest.struct_class = Types::TestConnectionRequest
+
+    TestConnectionResponse.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, location_name: "ConnectorId"))
+    TestConnectionResponse.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "Status"))
+    TestConnectionResponse.add_member(:status_message, Shapes::ShapeRef.new(shape: Message, location_name: "StatusMessage"))
+    TestConnectionResponse.struct_class = Types::TestConnectionResponse
+
     TestIdentityProviderRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
     TestIdentityProviderRequest.add_member(:server_protocol, Shapes::ShapeRef.new(shape: Protocol, location_name: "ServerProtocol"))
     TestIdentityProviderRequest.add_member(:source_ip, Shapes::ShapeRef.new(shape: SourceIp, location_name: "SourceIp"))
@@ -1148,6 +1174,7 @@ module Aws::Transfer
     UpdateConnectorRequest.add_member(:as_2_config, Shapes::ShapeRef.new(shape: As2ConnectorConfig, location_name: "As2Config"))
     UpdateConnectorRequest.add_member(:access_role, Shapes::ShapeRef.new(shape: Role, location_name: "AccessRole"))
     UpdateConnectorRequest.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
+    UpdateConnectorRequest.add_member(:sftp_config, Shapes::ShapeRef.new(shape: SftpConnectorConfig, location_name: "SftpConfig"))
     UpdateConnectorRequest.struct_class = Types::UpdateConnectorRequest
 
     UpdateConnectorResponse.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
@@ -1920,6 +1947,18 @@ module Aws::Transfer
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:test_connection, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "TestConnection"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: TestConnectionRequest)
+        o.output = Shapes::ShapeRef.new(shape: TestConnectionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:test_identity_provider, Seahorse::Model::Operation.new.tap do |o|
         o.name = "TestIdentityProvider"
         o.http_method = "POST"

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

@@ -684,6 +684,20 @@ module Aws::Transfer
       end
     end
 
+    class TestConnection
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::Transfer::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class TestIdentityProvider
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-transfer/plugins/endpoints.rb

@@ -152,6 +152,8 @@ module Aws::Transfer
             Aws::Transfer::Endpoints::StopServer.build(context)
           when :tag_resource
             Aws::Transfer::Endpoints::TagResource.build(context)
+          when :test_connection
+            Aws::Transfer::Endpoints::TestConnection.build(context)
           when :test_identity_provider
             Aws::Transfer::Endpoints::TestIdentityProvider.build(context)
           when :untag_resource

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

@@ -23,8 +23,8 @@ module Aws::Transfer
       include Aws::Structure
     end
 
-    # Contains the details for a connector object. The connector object is
-    # used for AS2 outbound processes, to connect the Transfer Family
+    # Contains the details for an AS2 connector object. The connector object
+    # is used for AS2 outbound processes, to connect the Transfer Family
     # customer with the trading partner.
     #
     # @!attribute [rw] local_profile_id
@@ -445,11 +445,12 @@ module Aws::Transfer
     end
 
     # @!attribute [rw] url
-    #   The URL of the partner's AS2 endpoint.
+    #   The URL of the partner's AS2 or SFTP endpoint.
     #   @return [String]
     #
     # @!attribute [rw] as_2_config
-    #   A structure that contains the parameters for a connector object.
+    #   A structure that contains the parameters for an AS2 connector
+    #   object.
     #   @return [Types::As2ConnectorConfig]
     #
     # @!attribute [rw] access_role
@@ -486,6 +487,11 @@ module Aws::Transfer
     #   Tags are metadata attached to connectors for any purpose.
     #   @return [Array<Types::Tag>]
     #
+    # @!attribute [rw] sftp_config
+    #   A structure that contains the parameters for an SFTP connector
+    #   object.
+    #   @return [Types::SftpConnectorConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateConnectorRequest AWS API Documentation
     #
     class CreateConnectorRequest < Struct.new(
@@ -493,7 +499,8 @@ module Aws::Transfer
       :as_2_config,
       :access_role,
       :logging_role,
-      :tags)
+      :tags,
+      :sftp_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -931,7 +938,8 @@ module Aws::Transfer
     #   In most cases, you can use this value instead of the session policy
     #   to lock your user down to the designated home directory
     #   ("`chroot`"). To do this, you can set `Entry` to `/` and set
-    #   `Target` to the HomeDirectory parameter value.
+    #   `Target` to the value the user should see for their home directory
+    #   when they log in.
     #
     #   The following is an `Entry` and `Target` pair example for `chroot`.
     #
@@ -2050,11 +2058,12 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] url
-    #   The URL of the partner's AS2 endpoint.
+    #   The URL of the partner's AS2 or SFTP endpoint.
     #   @return [String]
     #
     # @!attribute [rw] as_2_config
-    #   A structure that contains the parameters for a connector object.
+    #   A structure that contains the parameters for an AS2 connector
+    #   object.
     #   @return [Types::As2ConnectorConfig]
     #
     # @!attribute [rw] access_role
@@ -2090,6 +2099,11 @@ module Aws::Transfer
     #   Key-value pairs that can be used to group and search for connectors.
     #   @return [Array<Types::Tag>]
     #
+    # @!attribute [rw] sftp_config
+    #   A structure that contains the parameters for an SFTP connector
+    #   object.
+    #   @return [Types::SftpConnectorConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedConnector AWS API Documentation
     #
     class DescribedConnector < Struct.new(
@@ -2099,7 +2113,8 @@ module Aws::Transfer
       :as_2_config,
       :access_role,
       :logging_role,
-      :tags)
+      :tags,
+      :sftp_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4018,7 +4033,7 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] url
-    #   The URL of the partner's AS2 endpoint.
+    #   The URL of the partner's AS2 or SFTP endpoint.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedConnector AWS API Documentation
@@ -4702,6 +4717,44 @@ module Aws::Transfer
       include Aws::Structure
     end
 
+    # Contains the details for an SFTP connector object. The connector
+    # object is used for transferring files to and from a partner's SFTP
+    # server.
+    #
+    # @!attribute [rw] user_secret_id
+    #   The identifiers for the secrets (in Amazon Web Services Secrets
+    #   Manager) that contain the SFTP user's private keys or passwords.
+    #   @return [String]
+    #
+    # @!attribute [rw] trusted_host_keys
+    #   The public portion of the host key, or keys, that are used to
+    #   authenticate the user to the external server to which you are
+    #   connecting. You can use the `ssh-keyscan` command against the SFTP
+    #   server to retrieve the necessary key.
+    #
+    #   The three standard SSH public key format elements are `<key type>`,
+    #   `<body base64>`, and an optional `<comment>`, with spaces between
+    #   each element.
+    #
+    #   For the trusted host key, Transfer Family accepts RSA and ECDSA
+    #   keys.
+    #
+    #   * For RSA keys, the key type is `ssh-rsa`.
+    #
+    #   * 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 [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/SftpConnectorConfig AWS API Documentation
+    #
+    class SftpConnectorConfig < Struct.new(
+      :user_secret_id,
+      :trusted_host_keys)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides information about the public Secure Shell (SSH) key that is
     # associated with a Transfer Family user for the specific file transfer
     # protocol-enabled server (as identified by `ServerId`). The information
@@ -4741,22 +4794,44 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] send_file_paths
-    #   An array of strings. Each string represents the absolute path for
-    #   one outbound file transfer. For example, `
-    #   DOC-EXAMPLE-BUCKET/myfile.txt `.
+    #   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 `.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] 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.
     #   @return [Array<String>]
     #
+    # @!attribute [rw] local_directory_path
+    #   For an inbound transfer, the `LocaDirectoryPath` specifies the
+    #   destination for one or more files that are transferred from the
+    #   partner's SFTP server.
+    #   @return [String]
+    #
+    # @!attribute [rw] remote_directory_path
+    #   For an outbound transfer, the `RemoteDirectoryPath` specifies the
+    #   destination for one or more files that are transferred to the
+    #   partner's SFTP server. If you don't specify a
+    #   `RemoteDirectoryPath`, the destination for transferred files is the
+    #   SFTP user's home directory.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartFileTransferRequest AWS API Documentation
     #
     class StartFileTransferRequest < Struct.new(
       :connector_id,
-      :send_file_paths)
+      :send_file_paths,
+      :retrieve_file_paths,
+      :local_directory_path,
+      :remote_directory_path)
       SENSITIVE = []
       include Aws::Structure
     end
 
     # @!attribute [rw] transfer_id
-    #   Returns the unique identifier for this file transfer.
+    #   Returns the unique identifier for the file transfer.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartFileTransferResponse AWS API Documentation
@@ -4872,6 +4947,56 @@ module Aws::Transfer
       include Aws::Structure
     end
 
+    # @!attribute [rw] connector_id
+    #   The unique identifier for the connector.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestConnectionRequest AWS API Documentation
+    #
+    class TestConnectionRequest < Struct.new(
+      :connector_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] connector_id
+    #   Returns the identifier of the connector object that you are testing.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   Returns `OK` for successful test, or `ERROR` if the test fails.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_message
+    #   Returns `Connection succeeded` if the test is successful. Or,
+    #   returns a descriptive error message if the test fails. The following
+    #   list provides the details for some error messages and
+    #   troubleshooting steps for each.
+    #
+    #   * **Unable to access secrets manager**: Verify that your secret name
+    #     aligns with the one in Transfer Role permissions.
+    #
+    #   * **Unknown Host/Connection failed**: Verify the server URL in the
+    #     connector configuration , and verify that the login credentials
+    #     work successfully outside of the connector.
+    #
+    #   * **Private key not found**: Verify that the secret exists and is
+    #     formatted correctly.
+    #
+    #   * **Invalid trusted host keys**: Verify that the trusted host key in
+    #     the connector configuration matches the `ssh-keyscan` output.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestConnectionResponse AWS API Documentation
+    #
+    class TestConnectionResponse < Struct.new(
+      :connector_id,
+      :status,
+      :status_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] server_id
     #   A system-assigned identifier for a specific server. That server's
     #   user authentication method is tested with a user name and password.
@@ -5266,11 +5391,12 @@ module Aws::Transfer
     #   @return [String]
     #
     # @!attribute [rw] url
-    #   The URL of the partner's AS2 endpoint.
+    #   The URL of the partner's AS2 or SFTP endpoint.
     #   @return [String]
     #
     # @!attribute [rw] as_2_config
-    #   A structure that contains the parameters for a connector object.
+    #   A structure that contains the parameters for an AS2 connector
+    #   object.
     #   @return [Types::As2ConnectorConfig]
     #
     # @!attribute [rw] access_role
@@ -5302,6 +5428,11 @@ module Aws::Transfer
     #   CloudWatch logs.
     #   @return [String]
     #
+    # @!attribute [rw] sftp_config
+    #   A structure that contains the parameters for an SFTP connector
+    #   object.
+    #   @return [Types::SftpConnectorConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateConnectorRequest AWS API Documentation
     #
     class UpdateConnectorRequest < Struct.new(
@@ -5309,7 +5440,8 @@ module Aws::Transfer
       :url,
       :as_2_config,
       :access_role,
-      :logging_role)
+      :logging_role,
+      :sftp_config)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-transfer.rb

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

metadata

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