aws-sdk-transfer 1.104.0 → 1.106.0

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

@@ -27,7 +27,7 @@ The endpoint provider used to resolve endpoints. Any object that responds to
       class Handler < Seahorse::Client::Handler
         def call(context)
           unless context[:discovered_endpoint]
-            params = parameters_for_operation(context)
+            params = Aws::Transfer::Endpoints.parameters_for_operation(context)
             endpoint = context.config.endpoint_provider.resolve_endpoint(params)
 
             context.http_request.endpoint = endpoint.url
@@ -67,131 +67,6 @@ The endpoint provider used to resolve endpoints. Any object that responds to
             context.http_request.headers[key] = value
           end
         end
-
-        def parameters_for_operation(context)
-          case context.operation_name
-          when :create_access
-            Aws::Transfer::Endpoints::CreateAccess.build(context)
-          when :create_agreement
-            Aws::Transfer::Endpoints::CreateAgreement.build(context)
-          when :create_connector
-            Aws::Transfer::Endpoints::CreateConnector.build(context)
-          when :create_profile
-            Aws::Transfer::Endpoints::CreateProfile.build(context)
-          when :create_server
-            Aws::Transfer::Endpoints::CreateServer.build(context)
-          when :create_user
-            Aws::Transfer::Endpoints::CreateUser.build(context)
-          when :create_workflow
-            Aws::Transfer::Endpoints::CreateWorkflow.build(context)
-          when :delete_access
-            Aws::Transfer::Endpoints::DeleteAccess.build(context)
-          when :delete_agreement
-            Aws::Transfer::Endpoints::DeleteAgreement.build(context)
-          when :delete_certificate
-            Aws::Transfer::Endpoints::DeleteCertificate.build(context)
-          when :delete_connector
-            Aws::Transfer::Endpoints::DeleteConnector.build(context)
-          when :delete_host_key
-            Aws::Transfer::Endpoints::DeleteHostKey.build(context)
-          when :delete_profile
-            Aws::Transfer::Endpoints::DeleteProfile.build(context)
-          when :delete_server
-            Aws::Transfer::Endpoints::DeleteServer.build(context)
-          when :delete_ssh_public_key
-            Aws::Transfer::Endpoints::DeleteSshPublicKey.build(context)
-          when :delete_user
-            Aws::Transfer::Endpoints::DeleteUser.build(context)
-          when :delete_workflow
-            Aws::Transfer::Endpoints::DeleteWorkflow.build(context)
-          when :describe_access
-            Aws::Transfer::Endpoints::DescribeAccess.build(context)
-          when :describe_agreement
-            Aws::Transfer::Endpoints::DescribeAgreement.build(context)
-          when :describe_certificate
-            Aws::Transfer::Endpoints::DescribeCertificate.build(context)
-          when :describe_connector
-            Aws::Transfer::Endpoints::DescribeConnector.build(context)
-          when :describe_execution
-            Aws::Transfer::Endpoints::DescribeExecution.build(context)
-          when :describe_host_key
-            Aws::Transfer::Endpoints::DescribeHostKey.build(context)
-          when :describe_profile
-            Aws::Transfer::Endpoints::DescribeProfile.build(context)
-          when :describe_security_policy
-            Aws::Transfer::Endpoints::DescribeSecurityPolicy.build(context)
-          when :describe_server
-            Aws::Transfer::Endpoints::DescribeServer.build(context)
-          when :describe_user
-            Aws::Transfer::Endpoints::DescribeUser.build(context)
-          when :describe_workflow
-            Aws::Transfer::Endpoints::DescribeWorkflow.build(context)
-          when :import_certificate
-            Aws::Transfer::Endpoints::ImportCertificate.build(context)
-          when :import_host_key
-            Aws::Transfer::Endpoints::ImportHostKey.build(context)
-          when :import_ssh_public_key
-            Aws::Transfer::Endpoints::ImportSshPublicKey.build(context)
-          when :list_accesses
-            Aws::Transfer::Endpoints::ListAccesses.build(context)
-          when :list_agreements
-            Aws::Transfer::Endpoints::ListAgreements.build(context)
-          when :list_certificates
-            Aws::Transfer::Endpoints::ListCertificates.build(context)
-          when :list_connectors
-            Aws::Transfer::Endpoints::ListConnectors.build(context)
-          when :list_executions
-            Aws::Transfer::Endpoints::ListExecutions.build(context)
-          when :list_host_keys
-            Aws::Transfer::Endpoints::ListHostKeys.build(context)
-          when :list_profiles
-            Aws::Transfer::Endpoints::ListProfiles.build(context)
-          when :list_security_policies
-            Aws::Transfer::Endpoints::ListSecurityPolicies.build(context)
-          when :list_servers
-            Aws::Transfer::Endpoints::ListServers.build(context)
-          when :list_tags_for_resource
-            Aws::Transfer::Endpoints::ListTagsForResource.build(context)
-          when :list_users
-            Aws::Transfer::Endpoints::ListUsers.build(context)
-          when :list_workflows
-            Aws::Transfer::Endpoints::ListWorkflows.build(context)
-          when :send_workflow_step_state
-            Aws::Transfer::Endpoints::SendWorkflowStepState.build(context)
-          when :start_directory_listing
-            Aws::Transfer::Endpoints::StartDirectoryListing.build(context)
-          when :start_file_transfer
-            Aws::Transfer::Endpoints::StartFileTransfer.build(context)
-          when :start_server
-            Aws::Transfer::Endpoints::StartServer.build(context)
-          when :stop_server
-            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
-            Aws::Transfer::Endpoints::UntagResource.build(context)
-          when :update_access
-            Aws::Transfer::Endpoints::UpdateAccess.build(context)
-          when :update_agreement
-            Aws::Transfer::Endpoints::UpdateAgreement.build(context)
-          when :update_certificate
-            Aws::Transfer::Endpoints::UpdateCertificate.build(context)
-          when :update_connector
-            Aws::Transfer::Endpoints::UpdateConnector.build(context)
-          when :update_host_key
-            Aws::Transfer::Endpoints::UpdateHostKey.build(context)
-          when :update_profile
-            Aws::Transfer::Endpoints::UpdateProfile.build(context)
-          when :update_server
-            Aws::Transfer::Endpoints::UpdateServer.build(context)
-          when :update_user
-            Aws::Transfer::Endpoints::UpdateUser.build(context)
-          end
-        end
       end
 
       def add_handlers(handlers, _config)

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

@@ -150,6 +150,39 @@ module Aws::Transfer
       include Aws::Structure
     end
 
+    # A structure that contains the details for files transferred using an
+    # SFTP connector, during a single transfer.
+    #
+    # @!attribute [rw] file_path
+    #   The filename and path to where the file was sent to or retrieved
+    #   from.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_code
+    #   The current status for the transfer.
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_code
+    #   For transfers that fail, this parameter contains a code indicating
+    #   the reason. For example, `RETRIEVE_FILE_NOT_FOUND`
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_message
+    #   For transfers that fail, this parameter describes the reason for the
+    #   failure.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ConnectorFileTransferResult AWS API Documentation
+    #
+    class ConnectorFileTransferResult < Struct.new(
+      :file_path,
+      :status_code,
+      :failure_code,
+      :failure_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Each step type has its own `StepDetails` structure.
     #
     # @!attribute [rw] name
@@ -398,7 +431,8 @@ 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`.
     #   @return [String]
     #
     # @!attribute [rw] access_role
@@ -2960,15 +2994,22 @@ module Aws::Transfer
     # API and attach an Elastic IP address to your server's endpoint.
     #
     # <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
     # https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
     #
+    #  It is recommended that you use `VPC` as the `EndpointType`. With this
+    # endpoint type, you have the option to directly associate up to three
+    # Elastic IPv4 addresses (BYO IP included) with your server's endpoint
+    # and use VPC security groups to restrict traffic by the client's
+    # public IP address. This is not possible with `EndpointType` set to
+    # `VPC_ENDPOINT`.
+    #
     #  </note>
     #
     # @!attribute [rw] address_allocation_ids
@@ -3783,6 +3824,77 @@ module Aws::Transfer
       include Aws::Structure
     end
 
+    # @!attribute [rw] connector_id
+    #   A unique identifier for a connector. This value should match the
+    #   value supplied to the corresponding `StartFileTransfer` call.
+    #   @return [String]
+    #
+    # @!attribute [rw] transfer_id
+    #   A unique identifier for a file transfer. This value should match the
+    #   value supplied to the corresponding `StartFileTransfer` call.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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 [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListFileTransferResultsRequest AWS API Documentation
+    #
+    class ListFileTransferResultsRequest < Struct.new(
+      :connector_id,
+      :transfer_id,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] file_transfer_results
+    #   Returns the details for the files transferred in the transfer
+    #   identified by the `TransferId` and `ConnectorId` specified.
+    #
+    #   * `FilePath`: the filename and path to where the file was sent to or
+    #     retrieved from.
+    #
+    #   * `StatusCode`: current status for the transfer. The status returned
+    #     is one of the following values:`QUEUED`, `IN_PROGRESS`,
+    #     `COMPLETED`, or `FAILED`
+    #
+    #   * `FailureCode`: for transfers that fail, this parameter contains a
+    #     code indicating the reason. For example, `RETRIEVE_FILE_NOT_FOUND`
+    #
+    #   * `FailureMessage`: for transfers that fail, this parameter
+    #     describes the reason for the failure.
+    #   @return [Array<Types::ConnectorFileTransferResult>]
+    #
+    # @!attribute [rw] next_token
+    #   Returns a token that you can use to call `ListFileTransferResults`
+    #   again and receive additional results, if there are any (against the
+    #   same `TransferId`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListFileTransferResultsResponse AWS API Documentation
+    #
+    class ListFileTransferResultsResponse < Struct.new(
+      :file_transfer_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] max_results
     #   The maximum number of host keys to return.
     #   @return [Integer]
@@ -5175,9 +5287,9 @@ module Aws::Transfer
     # @!attribute [rw] 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>
     #   @return [Array<String>]
@@ -5687,7 +5799,7 @@ module Aws::Transfer
     # @!attribute [rw] 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 `.
     #   @return [String]
     #
     # @!attribute [rw] access_role
@@ -6044,10 +6156,10 @@ module Aws::Transfer
     #   Elastic IP addresses 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
+    #   `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
+    #   your 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
@@ -6489,6 +6601,10 @@ module Aws::Transfer
     #
     #   `aws transfer update-server --server-id s-01234567890abcdef
     #   --workflow-details '\{"OnUpload":[]\}'`
+    #
+    #   <note markdown="1"> `OnUpload` can contain a maximum of one `WorkflowDetail` object.
+    #
+    #    </note>
     #   @return [Array<Types::WorkflowDetail>]
     #
     # @!attribute [rw] on_partial_upload
@@ -6498,6 +6614,11 @@ module Aws::Transfer
     #
     #   A *partial upload* occurs when a file is open when the session
     #   disconnects.
+    #
+    #   <note markdown="1"> `OnPartialUpload` can contain a maximum of one `WorkflowDetail`
+    #   object.
+    #
+    #    </note>
     #   @return [Array<Types::WorkflowDetail>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WorkflowDetails AWS API Documentation

data/lib/aws-sdk-transfer.rb

@@ -55,7 +55,7 @@ module Aws::Transfer
   autoload :EndpointProvider, 'aws-sdk-transfer/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-transfer/endpoints'
 
-  GEM_VERSION = '1.104.0'
+  GEM_VERSION = '1.106.0'
 
 end
 

data/sig/client.rbs

@@ -708,6 +708,20 @@ module Aws
                            ) -> _ListExecutionsResponseSuccess
                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListExecutionsResponseSuccess
 
+      interface _ListFileTransferResultsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListFileTransferResultsResponse]
+        def file_transfer_results: () -> ::Array[Types::ConnectorFileTransferResult]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_file_transfer_results-instance_method
+      def list_file_transfer_results: (
+                                        connector_id: ::String,
+                                        transfer_id: ::String,
+                                        ?next_token: ::String,
+                                        ?max_results: ::Integer
+                                      ) -> _ListFileTransferResultsResponseSuccess
+                                    | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFileTransferResultsResponseSuccess
+
       interface _ListHostKeysResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListHostKeysResponse]
         def next_token: () -> ::String

data/sig/types.rbs

@@ -31,6 +31,14 @@ module Aws::Transfer
       SENSITIVE: []
     end
 
+    class ConnectorFileTransferResult
+      attr_accessor file_path: ::String
+      attr_accessor status_code: ("QUEUED" | "IN_PROGRESS" | "COMPLETED" | "FAILED")
+      attr_accessor failure_code: ::String
+      attr_accessor failure_message: ::String
+      SENSITIVE: []
+    end
+
     class CopyStepDetails
       attr_accessor name: ::String
       attr_accessor destination_file_location: Types::InputFileLocation
@@ -699,6 +707,20 @@ module Aws::Transfer
       SENSITIVE: []
     end
 
+    class ListFileTransferResultsRequest
+      attr_accessor connector_id: ::String
+      attr_accessor transfer_id: ::String
+      attr_accessor next_token: ::String
+      attr_accessor max_results: ::Integer
+      SENSITIVE: []
+    end
+
+    class ListFileTransferResultsResponse
+      attr_accessor file_transfer_results: ::Array[Types::ConnectorFileTransferResult]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
     class ListHostKeysRequest
       attr_accessor max_results: ::Integer
       attr_accessor next_token: ::String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-transfer
 version: !ruby/object:Gem::Version
-  version: 1.104.0
+  version: 1.106.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.207.0
+        version: 3.210.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,21 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.207.0
+        version: 3.210.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.5'
 description: Official AWS Ruby gem for AWS Transfer Family (AWS Transfer). This gem
   is part of the AWS SDK for Ruby.
 email: