aws-sdk-transfer 1.104.0 → 1.106.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68a3134e59ef4bc497dcb9dce902f554549f6fa1e1e41add47bd9cb697ef479b
-  data.tar.gz: 1bf681f56451447ba814abd0d6b725380b93361d2ca98d8f509b71225f1f1e9b
+  metadata.gz: d9525fda73165bfeb0090612c564749845ffd060e9e5e35f75048dc6bb40b9f5
+  data.tar.gz: 19db50f8561fc71fec777ddda2327546071814fb1c41427b443752585a3fec28
 SHA512:
-  metadata.gz: a3d7517e1d2de81092a8b7af848ec9398b23c60d875f305c5029eef03b52995eb9b5a39115582fb4172521b02c60e1585748bfa5cb76f4abe89aaa8d3a225afa
-  data.tar.gz: 88fa477703e5545c328fedc3303e84ae1250d1c5d83070371ffbcb30125b63ae9232b3a0d257be248deffd59ef645d8f038b8846ca44c11d92d9e3e4002a5639
+  metadata.gz: e82e273622cce4d652e5535bf65380a76a822f6491f7f2ca1de6f0524d36c41ab4a654d5be97212ea498edc9a4af0fd9029a4b2c137485d09f6a2ef3e09095fd
+  data.tar.gz: 58b508d3afee686808283d96a305c2afde31172a52ca7c60351df4d77fbaa2a33b566d4ce0d235caacb4af1b9a6a9e4dc57801d21186a09987d57ba3529c5493

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.106.0 (2024-10-18)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.105.0 (2024-10-14)
+------------------
+
+* Feature - This release enables customers using SFTP connectors to query the transfer status of their files to meet their monitoring needs as well as orchestrate post transfer actions.
+
 1.104.0 (2024-09-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.104.0
+1.106.0

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

@@ -651,7 +651,7 @@ 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 `/amzn-s3-demo-bucket/home/mydirectory`.
     #
     # @option params [required, String] :access_role
     #   Connectors are used to send files using either the AS2 or SFTP
@@ -3030,6 +3030,73 @@ module Aws::Transfer
       req.send_request(options)
     end
 
+    # Returns real-time updates and detailed information on the status of
+    # each individual file being transferred in a specific file transfer
+    # operation. You specify the file transfer by providing its
+    # `ConnectorId` and its `TransferId`.
+    #
+    # <note markdown="1"> File transfer results are available up to 7 days after an operation
+    # has been requested.
+    #
+    #  </note>
+    #
+    # @option params [required, String] :connector_id
+    #   A unique identifier for a connector. This value should match the value
+    #   supplied to the corresponding `StartFileTransfer` call.
+    #
+    # @option params [required, String] :transfer_id
+    #   A unique identifier for a file transfer. This value should match the
+    #   value supplied to the corresponding `StartFileTransfer` call.
+    #
+    # @option params [String] :next_token
+    #   If there are more file details than returned in this call, use this
+    #   value for a subsequent call to `ListFileTransferResults` to retrieve
+    #   them.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of files to return in a single page. Note that
+    #   currently you can specify a maximum of 10 file paths in a single
+    #   [StartFileTransfer][1] operation. Thus, the maximum number of file
+    #   transfer results that can be returned in a single page is 10.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/transfer/latest/APIReference/API_StartFileTransfer.html
+    #
+    # @return [Types::ListFileTransferResultsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListFileTransferResultsResponse#file_transfer_results #file_transfer_results} => Array&lt;Types::ConnectorFileTransferResult&gt;
+    #   * {Types::ListFileTransferResultsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_file_transfer_results({
+    #     connector_id: "ConnectorId", # required
+    #     transfer_id: "TransferId", # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.file_transfer_results #=> Array
+    #   resp.file_transfer_results[0].file_path #=> String
+    #   resp.file_transfer_results[0].status_code #=> String, one of "QUEUED", "IN_PROGRESS", "COMPLETED", "FAILED"
+    #   resp.file_transfer_results[0].failure_code #=> String
+    #   resp.file_transfer_results[0].failure_message #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListFileTransferResults AWS API Documentation
+    #
+    # @overload list_file_transfer_results(params = {})
+    # @param [Hash] params ({})
+    def list_file_transfer_results(params = {}, options = {})
+      req = build_request(:list_file_transfer_results, params)
+      req.send_request(options)
+    end
+
     # Returns a list of host keys for the server that's specified by the
     # `ServerId` parameter.
     #
@@ -3525,9 +3592,9 @@ module Aws::Transfer
     # @option params [Array<String>] :send_file_paths
     #   One or more source paths for the Amazon S3 storage. Each string
     #   represents a source file path for one outbound file transfer. For
-    #   example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
+    #   example, ` amzn-s3-demo-bucket/myfile.txt `.
     #
-    #   <note markdown="1"> Replace ` DOC-EXAMPLE-BUCKET ` with one of your actual buckets.
+    #   <note markdown="1"> Replace ` amzn-s3-demo-bucket ` with one of your actual buckets.
     #
     #    </note>
     #
@@ -4048,7 +4115,7 @@ module Aws::Transfer
     # @option params [String] :base_directory
     #   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 `.
+    #   example, `/amzn-s3-demo-bucket/home/mydirectory `.
     #
     # @option params [String] :access_role
     #   Connectors are used to send files using either the AS2 or SFTP
@@ -4417,10 +4484,10 @@ module Aws::Transfer
     #   directly to it.
     #
     #   <note markdown="1"> After May 19, 2021, you won't be able to create a server using
-    #   `EndpointType=VPC_ENDPOINT` in your Amazon Web Servicesaccount if your
-    #   account hasn't already done so before May 19, 2021. If you have
+    #   `EndpointType=VPC_ENDPOINT` in your Amazon Web Services account if
+    #   your account hasn't already done so before May 19, 2021. If you have
     #   already created servers with `EndpointType=VPC_ENDPOINT` in your
-    #   Amazon Web Servicesaccount on or before May 19, 2021, you will not be
+    #   Amazon Web Services account on or before May 19, 2021, you will not be
     #   affected. After this date, use `EndpointType`=`VPC`.
     #
     #    For more information, see
@@ -4852,7 +4919,7 @@ module Aws::Transfer
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-transfer'
-      context[:gem_version] = '1.104.0'
+      context[:gem_version] = '1.106.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -38,6 +38,8 @@ module Aws::Transfer
     CertificateUsageType = Shapes::StringShape.new(name: 'CertificateUsageType')
     CompressionEnum = Shapes::StringShape.new(name: 'CompressionEnum')
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
+    ConnectorFileTransferResult = Shapes::StructureShape.new(name: 'ConnectorFileTransferResult')
+    ConnectorFileTransferResults = Shapes::ListShape.new(name: 'ConnectorFileTransferResults')
     ConnectorId = Shapes::StringShape.new(name: 'ConnectorId')
     ConnectorSecurityPolicyName = Shapes::StringShape.new(name: 'ConnectorSecurityPolicyName')
     CopyStepDetails = Shapes::StructureShape.new(name: 'CopyStepDetails')
@@ -125,6 +127,7 @@ module Aws::Transfer
     ExecutionStepResult = Shapes::StructureShape.new(name: 'ExecutionStepResult')
     ExecutionStepResults = Shapes::ListShape.new(name: 'ExecutionStepResults')
     ExternalId = Shapes::StringShape.new(name: 'ExternalId')
+    FailureCode = Shapes::StringShape.new(name: 'FailureCode')
     FileLocation = Shapes::StructureShape.new(name: 'FileLocation')
     FilePath = Shapes::StringShape.new(name: 'FilePath')
     FilePaths = Shapes::ListShape.new(name: 'FilePaths')
@@ -161,6 +164,8 @@ module Aws::Transfer
     ListConnectorsResponse = Shapes::StructureShape.new(name: 'ListConnectorsResponse')
     ListExecutionsRequest = Shapes::StructureShape.new(name: 'ListExecutionsRequest')
     ListExecutionsResponse = Shapes::StructureShape.new(name: 'ListExecutionsResponse')
+    ListFileTransferResultsRequest = Shapes::StructureShape.new(name: 'ListFileTransferResultsRequest')
+    ListFileTransferResultsResponse = Shapes::StructureShape.new(name: 'ListFileTransferResultsResponse')
     ListHostKeysRequest = Shapes::StructureShape.new(name: 'ListHostKeysRequest')
     ListHostKeysResponse = Shapes::StructureShape.new(name: 'ListHostKeysResponse')
     ListProfilesRequest = Shapes::StructureShape.new(name: 'ListProfilesRequest')
@@ -303,6 +308,7 @@ module Aws::Transfer
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
     TlsSessionResumptionMode = Shapes::StringShape.new(name: 'TlsSessionResumptionMode')
     TransferId = Shapes::StringShape.new(name: 'TransferId')
+    TransferTableStatus = Shapes::StringShape.new(name: 'TransferTableStatus')
     UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
     UpdateAccessRequest = Shapes::StructureShape.new(name: 'UpdateAccessRequest')
     UpdateAccessResponse = Shapes::StructureShape.new(name: 'UpdateAccessResponse')
@@ -359,6 +365,14 @@ module Aws::Transfer
     ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
     ConflictException.struct_class = Types::ConflictException
 
+    ConnectorFileTransferResult.add_member(:file_path, Shapes::ShapeRef.new(shape: FilePath, required: true, location_name: "FilePath"))
+    ConnectorFileTransferResult.add_member(:status_code, Shapes::ShapeRef.new(shape: TransferTableStatus, required: true, location_name: "StatusCode"))
+    ConnectorFileTransferResult.add_member(:failure_code, Shapes::ShapeRef.new(shape: FailureCode, location_name: "FailureCode"))
+    ConnectorFileTransferResult.add_member(:failure_message, Shapes::ShapeRef.new(shape: Message, location_name: "FailureMessage"))
+    ConnectorFileTransferResult.struct_class = Types::ConnectorFileTransferResult
+
+    ConnectorFileTransferResults.member = Shapes::ShapeRef.new(shape: ConnectorFileTransferResult)
+
     CopyStepDetails.add_member(:name, Shapes::ShapeRef.new(shape: WorkflowStepName, location_name: "Name"))
     CopyStepDetails.add_member(:destination_file_location, Shapes::ShapeRef.new(shape: InputFileLocation, location_name: "DestinationFileLocation"))
     CopyStepDetails.add_member(:overwrite_existing, Shapes::ShapeRef.new(shape: OverwriteExisting, location_name: "OverwriteExisting"))
@@ -855,6 +869,16 @@ module Aws::Transfer
     ListExecutionsResponse.add_member(:executions, Shapes::ShapeRef.new(shape: ListedExecutions, required: true, location_name: "Executions"))
     ListExecutionsResponse.struct_class = Types::ListExecutionsResponse
 
+    ListFileTransferResultsRequest.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
+    ListFileTransferResultsRequest.add_member(:transfer_id, Shapes::ShapeRef.new(shape: TransferId, required: true, location_name: "TransferId"))
+    ListFileTransferResultsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListFileTransferResultsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
+    ListFileTransferResultsRequest.struct_class = Types::ListFileTransferResultsRequest
+
+    ListFileTransferResultsResponse.add_member(:file_transfer_results, Shapes::ShapeRef.new(shape: ConnectorFileTransferResults, required: true, location_name: "FileTransferResults"))
+    ListFileTransferResultsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListFileTransferResultsResponse.struct_class = Types::ListFileTransferResultsResponse
+
     ListHostKeysRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
     ListHostKeysRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListHostKeysRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
@@ -1304,6 +1328,7 @@ module Aws::Transfer
 
       api.metadata = {
         "apiVersion" => "2018-11-05",
+        "auth" => ["aws.auth#sigv4"],
         "endpointPrefix" => "transfer",
         "jsonVersion" => "1.1",
         "protocol" => "json",
@@ -1804,6 +1829,24 @@ module Aws::Transfer
         )
       end)
 
+      api.add_operation(:list_file_transfer_results, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListFileTransferResults"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListFileTransferResultsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListFileTransferResultsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_host_keys, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListHostKeys"
         o.http_method = "POST"

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

@@ -52,15 +52,18 @@ module Aws::Transfer
       self[:region] = options[:region]
       self[:use_dual_stack] = options[:use_dual_stack]
       self[:use_dual_stack] = false if self[:use_dual_stack].nil?
-      if self[:use_dual_stack].nil?
-        raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack"
-      end
       self[:use_fips] = options[:use_fips]
       self[:use_fips] = false if self[:use_fips].nil?
-      if self[:use_fips].nil?
-        raise ArgumentError, "Missing required EndpointParameter: :use_fips"
-      end
       self[:endpoint] = options[:endpoint]
     end
+
+    def self.create(config, options={})
+      new({
+        region: config.region,
+        use_dual_stack: config.use_dualstack_endpoint,
+        use_fips: config.use_fips_endpoint,
+        endpoint: (config.endpoint.to_s unless config.regional_endpoint),
+      }.merge(options))
+    end
   end
 end