aws-sdk-transfer 1.104.0 → 1.106.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -27,7 +27,7 @@ The endpoint provider used to resolve endpoints. Any object that responds to
27
27
  class Handler < Seahorse::Client::Handler
28
28
  def call(context)
29
29
  unless context[:discovered_endpoint]
30
- params = parameters_for_operation(context)
30
+ params = Aws::Transfer::Endpoints.parameters_for_operation(context)
31
31
  endpoint = context.config.endpoint_provider.resolve_endpoint(params)
32
32
 
33
33
  context.http_request.endpoint = endpoint.url
@@ -67,131 +67,6 @@ The endpoint provider used to resolve endpoints. Any object that responds to
67
67
  context.http_request.headers[key] = value
68
68
  end
69
69
  end
70
-
71
- def parameters_for_operation(context)
72
- case context.operation_name
73
- when :create_access
74
- Aws::Transfer::Endpoints::CreateAccess.build(context)
75
- when :create_agreement
76
- Aws::Transfer::Endpoints::CreateAgreement.build(context)
77
- when :create_connector
78
- Aws::Transfer::Endpoints::CreateConnector.build(context)
79
- when :create_profile
80
- Aws::Transfer::Endpoints::CreateProfile.build(context)
81
- when :create_server
82
- Aws::Transfer::Endpoints::CreateServer.build(context)
83
- when :create_user
84
- Aws::Transfer::Endpoints::CreateUser.build(context)
85
- when :create_workflow
86
- Aws::Transfer::Endpoints::CreateWorkflow.build(context)
87
- when :delete_access
88
- Aws::Transfer::Endpoints::DeleteAccess.build(context)
89
- when :delete_agreement
90
- Aws::Transfer::Endpoints::DeleteAgreement.build(context)
91
- when :delete_certificate
92
- Aws::Transfer::Endpoints::DeleteCertificate.build(context)
93
- when :delete_connector
94
- Aws::Transfer::Endpoints::DeleteConnector.build(context)
95
- when :delete_host_key
96
- Aws::Transfer::Endpoints::DeleteHostKey.build(context)
97
- when :delete_profile
98
- Aws::Transfer::Endpoints::DeleteProfile.build(context)
99
- when :delete_server
100
- Aws::Transfer::Endpoints::DeleteServer.build(context)
101
- when :delete_ssh_public_key
102
- Aws::Transfer::Endpoints::DeleteSshPublicKey.build(context)
103
- when :delete_user
104
- Aws::Transfer::Endpoints::DeleteUser.build(context)
105
- when :delete_workflow
106
- Aws::Transfer::Endpoints::DeleteWorkflow.build(context)
107
- when :describe_access
108
- Aws::Transfer::Endpoints::DescribeAccess.build(context)
109
- when :describe_agreement
110
- Aws::Transfer::Endpoints::DescribeAgreement.build(context)
111
- when :describe_certificate
112
- Aws::Transfer::Endpoints::DescribeCertificate.build(context)
113
- when :describe_connector
114
- Aws::Transfer::Endpoints::DescribeConnector.build(context)
115
- when :describe_execution
116
- Aws::Transfer::Endpoints::DescribeExecution.build(context)
117
- when :describe_host_key
118
- Aws::Transfer::Endpoints::DescribeHostKey.build(context)
119
- when :describe_profile
120
- Aws::Transfer::Endpoints::DescribeProfile.build(context)
121
- when :describe_security_policy
122
- Aws::Transfer::Endpoints::DescribeSecurityPolicy.build(context)
123
- when :describe_server
124
- Aws::Transfer::Endpoints::DescribeServer.build(context)
125
- when :describe_user
126
- Aws::Transfer::Endpoints::DescribeUser.build(context)
127
- when :describe_workflow
128
- Aws::Transfer::Endpoints::DescribeWorkflow.build(context)
129
- when :import_certificate
130
- Aws::Transfer::Endpoints::ImportCertificate.build(context)
131
- when :import_host_key
132
- Aws::Transfer::Endpoints::ImportHostKey.build(context)
133
- when :import_ssh_public_key
134
- Aws::Transfer::Endpoints::ImportSshPublicKey.build(context)
135
- when :list_accesses
136
- Aws::Transfer::Endpoints::ListAccesses.build(context)
137
- when :list_agreements
138
- Aws::Transfer::Endpoints::ListAgreements.build(context)
139
- when :list_certificates
140
- Aws::Transfer::Endpoints::ListCertificates.build(context)
141
- when :list_connectors
142
- Aws::Transfer::Endpoints::ListConnectors.build(context)
143
- when :list_executions
144
- Aws::Transfer::Endpoints::ListExecutions.build(context)
145
- when :list_host_keys
146
- Aws::Transfer::Endpoints::ListHostKeys.build(context)
147
- when :list_profiles
148
- Aws::Transfer::Endpoints::ListProfiles.build(context)
149
- when :list_security_policies
150
- Aws::Transfer::Endpoints::ListSecurityPolicies.build(context)
151
- when :list_servers
152
- Aws::Transfer::Endpoints::ListServers.build(context)
153
- when :list_tags_for_resource
154
- Aws::Transfer::Endpoints::ListTagsForResource.build(context)
155
- when :list_users
156
- Aws::Transfer::Endpoints::ListUsers.build(context)
157
- when :list_workflows
158
- Aws::Transfer::Endpoints::ListWorkflows.build(context)
159
- when :send_workflow_step_state
160
- Aws::Transfer::Endpoints::SendWorkflowStepState.build(context)
161
- when :start_directory_listing
162
- Aws::Transfer::Endpoints::StartDirectoryListing.build(context)
163
- when :start_file_transfer
164
- Aws::Transfer::Endpoints::StartFileTransfer.build(context)
165
- when :start_server
166
- Aws::Transfer::Endpoints::StartServer.build(context)
167
- when :stop_server
168
- Aws::Transfer::Endpoints::StopServer.build(context)
169
- when :tag_resource
170
- Aws::Transfer::Endpoints::TagResource.build(context)
171
- when :test_connection
172
- Aws::Transfer::Endpoints::TestConnection.build(context)
173
- when :test_identity_provider
174
- Aws::Transfer::Endpoints::TestIdentityProvider.build(context)
175
- when :untag_resource
176
- Aws::Transfer::Endpoints::UntagResource.build(context)
177
- when :update_access
178
- Aws::Transfer::Endpoints::UpdateAccess.build(context)
179
- when :update_agreement
180
- Aws::Transfer::Endpoints::UpdateAgreement.build(context)
181
- when :update_certificate
182
- Aws::Transfer::Endpoints::UpdateCertificate.build(context)
183
- when :update_connector
184
- Aws::Transfer::Endpoints::UpdateConnector.build(context)
185
- when :update_host_key
186
- Aws::Transfer::Endpoints::UpdateHostKey.build(context)
187
- when :update_profile
188
- Aws::Transfer::Endpoints::UpdateProfile.build(context)
189
- when :update_server
190
- Aws::Transfer::Endpoints::UpdateServer.build(context)
191
- when :update_user
192
- Aws::Transfer::Endpoints::UpdateUser.build(context)
193
- end
194
- end
195
70
  end
196
71
 
197
72
  def add_handlers(handlers, _config)
@@ -150,6 +150,39 @@ module Aws::Transfer
150
150
  include Aws::Structure
151
151
  end
152
152
 
153
+ # A structure that contains the details for files transferred using an
154
+ # SFTP connector, during a single transfer.
155
+ #
156
+ # @!attribute [rw] file_path
157
+ # The filename and path to where the file was sent to or retrieved
158
+ # from.
159
+ # @return [String]
160
+ #
161
+ # @!attribute [rw] status_code
162
+ # The current status for the transfer.
163
+ # @return [String]
164
+ #
165
+ # @!attribute [rw] failure_code
166
+ # For transfers that fail, this parameter contains a code indicating
167
+ # the reason. For example, `RETRIEVE_FILE_NOT_FOUND`
168
+ # @return [String]
169
+ #
170
+ # @!attribute [rw] failure_message
171
+ # For transfers that fail, this parameter describes the reason for the
172
+ # failure.
173
+ # @return [String]
174
+ #
175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ConnectorFileTransferResult AWS API Documentation
176
+ #
177
+ class ConnectorFileTransferResult < Struct.new(
178
+ :file_path,
179
+ :status_code,
180
+ :failure_code,
181
+ :failure_message)
182
+ SENSITIVE = []
183
+ include Aws::Structure
184
+ end
185
+
153
186
  # Each step type has its own `StepDetails` structure.
154
187
  #
155
188
  # @!attribute [rw] name
@@ -398,7 +431,8 @@ module Aws::Transfer
398
431
  # The landing directory (folder) for files transferred by using the
399
432
  # AS2 protocol.
400
433
  #
401
- # A `BaseDirectory` example is `/DOC-EXAMPLE-BUCKET/home/mydirectory`.
434
+ # A `BaseDirectory` example is
435
+ # `/amzn-s3-demo-bucket/home/mydirectory`.
402
436
  # @return [String]
403
437
  #
404
438
  # @!attribute [rw] access_role
@@ -2960,15 +2994,22 @@ module Aws::Transfer
2960
2994
  # API and attach an Elastic IP address to your server's endpoint.
2961
2995
  #
2962
2996
  # <note markdown="1"> After May 19, 2021, you won't be able to create a server using
2963
- # `EndpointType=VPC_ENDPOINT` in your Amazon Web Servicesaccount if your
2964
- # account hasn't already done so before May 19, 2021. If you have
2997
+ # `EndpointType=VPC_ENDPOINT` in your Amazon Web Services account if
2998
+ # your account hasn't already done so before May 19, 2021. If you have
2965
2999
  # already created servers with `EndpointType=VPC_ENDPOINT` in your
2966
- # Amazon Web Servicesaccount on or before May 19, 2021, you will not be
3000
+ # Amazon Web Services account on or before May 19, 2021, you will not be
2967
3001
  # affected. After this date, use `EndpointType`=`VPC`.
2968
3002
  #
2969
3003
  # For more information, see
2970
3004
  # https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
2971
3005
  #
3006
+ # It is recommended that you use `VPC` as the `EndpointType`. With this
3007
+ # endpoint type, you have the option to directly associate up to three
3008
+ # Elastic IPv4 addresses (BYO IP included) with your server's endpoint
3009
+ # and use VPC security groups to restrict traffic by the client's
3010
+ # public IP address. This is not possible with `EndpointType` set to
3011
+ # `VPC_ENDPOINT`.
3012
+ #
2972
3013
  # </note>
2973
3014
  #
2974
3015
  # @!attribute [rw] address_allocation_ids
@@ -3783,6 +3824,77 @@ module Aws::Transfer
3783
3824
  include Aws::Structure
3784
3825
  end
3785
3826
 
3827
+ # @!attribute [rw] connector_id
3828
+ # A unique identifier for a connector. This value should match the
3829
+ # value supplied to the corresponding `StartFileTransfer` call.
3830
+ # @return [String]
3831
+ #
3832
+ # @!attribute [rw] transfer_id
3833
+ # A unique identifier for a file transfer. This value should match the
3834
+ # value supplied to the corresponding `StartFileTransfer` call.
3835
+ # @return [String]
3836
+ #
3837
+ # @!attribute [rw] next_token
3838
+ # If there are more file details than returned in this call, use this
3839
+ # value for a subsequent call to `ListFileTransferResults` to retrieve
3840
+ # them.
3841
+ # @return [String]
3842
+ #
3843
+ # @!attribute [rw] max_results
3844
+ # The maximum number of files to return in a single page. Note that
3845
+ # currently you can specify a maximum of 10 file paths in a single
3846
+ # [StartFileTransfer][1] operation. Thus, the maximum number of file
3847
+ # transfer results that can be returned in a single page is 10.
3848
+ #
3849
+ #
3850
+ #
3851
+ # [1]: https://docs.aws.amazon.com/transfer/latest/APIReference/API_StartFileTransfer.html
3852
+ # @return [Integer]
3853
+ #
3854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListFileTransferResultsRequest AWS API Documentation
3855
+ #
3856
+ class ListFileTransferResultsRequest < Struct.new(
3857
+ :connector_id,
3858
+ :transfer_id,
3859
+ :next_token,
3860
+ :max_results)
3861
+ SENSITIVE = []
3862
+ include Aws::Structure
3863
+ end
3864
+
3865
+ # @!attribute [rw] file_transfer_results
3866
+ # Returns the details for the files transferred in the transfer
3867
+ # identified by the `TransferId` and `ConnectorId` specified.
3868
+ #
3869
+ # * `FilePath`: the filename and path to where the file was sent to or
3870
+ # retrieved from.
3871
+ #
3872
+ # * `StatusCode`: current status for the transfer. The status returned
3873
+ # is one of the following values:`QUEUED`, `IN_PROGRESS`,
3874
+ # `COMPLETED`, or `FAILED`
3875
+ #
3876
+ # * `FailureCode`: for transfers that fail, this parameter contains a
3877
+ # code indicating the reason. For example, `RETRIEVE_FILE_NOT_FOUND`
3878
+ #
3879
+ # * `FailureMessage`: for transfers that fail, this parameter
3880
+ # describes the reason for the failure.
3881
+ # @return [Array<Types::ConnectorFileTransferResult>]
3882
+ #
3883
+ # @!attribute [rw] next_token
3884
+ # Returns a token that you can use to call `ListFileTransferResults`
3885
+ # again and receive additional results, if there are any (against the
3886
+ # same `TransferId`.
3887
+ # @return [String]
3888
+ #
3889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListFileTransferResultsResponse AWS API Documentation
3890
+ #
3891
+ class ListFileTransferResultsResponse < Struct.new(
3892
+ :file_transfer_results,
3893
+ :next_token)
3894
+ SENSITIVE = []
3895
+ include Aws::Structure
3896
+ end
3897
+
3786
3898
  # @!attribute [rw] max_results
3787
3899
  # The maximum number of host keys to return.
3788
3900
  # @return [Integer]
@@ -5175,9 +5287,9 @@ module Aws::Transfer
5175
5287
  # @!attribute [rw] send_file_paths
5176
5288
  # One or more source paths for the Amazon S3 storage. Each string
5177
5289
  # represents a source file path for one outbound file transfer. For
5178
- # example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
5290
+ # example, ` amzn-s3-demo-bucket/myfile.txt `.
5179
5291
  #
5180
- # <note markdown="1"> Replace ` DOC-EXAMPLE-BUCKET ` with one of your actual buckets.
5292
+ # <note markdown="1"> Replace ` amzn-s3-demo-bucket ` with one of your actual buckets.
5181
5293
  #
5182
5294
  # </note>
5183
5295
  # @return [Array<String>]
@@ -5687,7 +5799,7 @@ module Aws::Transfer
5687
5799
  # @!attribute [rw] base_directory
5688
5800
  # To change the landing directory (folder) for files that are
5689
5801
  # transferred, provide the bucket folder that you want to use; for
5690
- # example, `/DOC-EXAMPLE-BUCKET/home/mydirectory `.
5802
+ # example, `/amzn-s3-demo-bucket/home/mydirectory `.
5691
5803
  # @return [String]
5692
5804
  #
5693
5805
  # @!attribute [rw] access_role
@@ -6044,10 +6156,10 @@ module Aws::Transfer
6044
6156
  # Elastic IP addresses directly to it.
6045
6157
  #
6046
6158
  # <note markdown="1"> After May 19, 2021, you won't be able to create a server using
6047
- # `EndpointType=VPC_ENDPOINT` in your Amazon Web Servicesaccount if
6159
+ # `EndpointType=VPC_ENDPOINT` in your Amazon Web Services account if
6048
6160
  # your account hasn't already done so before May 19, 2021. If you
6049
6161
  # have already created servers with `EndpointType=VPC_ENDPOINT` in
6050
- # your Amazon Web Servicesaccount on or before May 19, 2021, you will
6162
+ # your Amazon Web Services account on or before May 19, 2021, you will
6051
6163
  # not be affected. After this date, use `EndpointType`=`VPC`.
6052
6164
  #
6053
6165
  # For more information, see
@@ -6489,6 +6601,10 @@ module Aws::Transfer
6489
6601
  #
6490
6602
  # `aws transfer update-server --server-id s-01234567890abcdef
6491
6603
  # --workflow-details '\{"OnUpload":[]\}'`
6604
+ #
6605
+ # <note markdown="1"> `OnUpload` can contain a maximum of one `WorkflowDetail` object.
6606
+ #
6607
+ # </note>
6492
6608
  # @return [Array<Types::WorkflowDetail>]
6493
6609
  #
6494
6610
  # @!attribute [rw] on_partial_upload
@@ -6498,6 +6614,11 @@ module Aws::Transfer
6498
6614
  #
6499
6615
  # A *partial upload* occurs when a file is open when the session
6500
6616
  # disconnects.
6617
+ #
6618
+ # <note markdown="1"> `OnPartialUpload` can contain a maximum of one `WorkflowDetail`
6619
+ # object.
6620
+ #
6621
+ # </note>
6501
6622
  # @return [Array<Types::WorkflowDetail>]
6502
6623
  #
6503
6624
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WorkflowDetails AWS API Documentation
@@ -55,7 +55,7 @@ module Aws::Transfer
55
55
  autoload :EndpointProvider, 'aws-sdk-transfer/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-transfer/endpoints'
57
57
 
58
- GEM_VERSION = '1.104.0'
58
+ GEM_VERSION = '1.106.0'
59
59
 
60
60
  end
61
61
 
data/sig/client.rbs CHANGED
@@ -708,6 +708,20 @@ module Aws
708
708
  ) -> _ListExecutionsResponseSuccess
709
709
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListExecutionsResponseSuccess
710
710
 
711
+ interface _ListFileTransferResultsResponseSuccess
712
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListFileTransferResultsResponse]
713
+ def file_transfer_results: () -> ::Array[Types::ConnectorFileTransferResult]
714
+ def next_token: () -> ::String
715
+ end
716
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_file_transfer_results-instance_method
717
+ def list_file_transfer_results: (
718
+ connector_id: ::String,
719
+ transfer_id: ::String,
720
+ ?next_token: ::String,
721
+ ?max_results: ::Integer
722
+ ) -> _ListFileTransferResultsResponseSuccess
723
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFileTransferResultsResponseSuccess
724
+
711
725
  interface _ListHostKeysResponseSuccess
712
726
  include ::Seahorse::Client::_ResponseSuccess[Types::ListHostKeysResponse]
713
727
  def next_token: () -> ::String
data/sig/types.rbs CHANGED
@@ -31,6 +31,14 @@ module Aws::Transfer
31
31
  SENSITIVE: []
32
32
  end
33
33
 
34
+ class ConnectorFileTransferResult
35
+ attr_accessor file_path: ::String
36
+ attr_accessor status_code: ("QUEUED" | "IN_PROGRESS" | "COMPLETED" | "FAILED")
37
+ attr_accessor failure_code: ::String
38
+ attr_accessor failure_message: ::String
39
+ SENSITIVE: []
40
+ end
41
+
34
42
  class CopyStepDetails
35
43
  attr_accessor name: ::String
36
44
  attr_accessor destination_file_location: Types::InputFileLocation
@@ -699,6 +707,20 @@ module Aws::Transfer
699
707
  SENSITIVE: []
700
708
  end
701
709
 
710
+ class ListFileTransferResultsRequest
711
+ attr_accessor connector_id: ::String
712
+ attr_accessor transfer_id: ::String
713
+ attr_accessor next_token: ::String
714
+ attr_accessor max_results: ::Integer
715
+ SENSITIVE: []
716
+ end
717
+
718
+ class ListFileTransferResultsResponse
719
+ attr_accessor file_transfer_results: ::Array[Types::ConnectorFileTransferResult]
720
+ attr_accessor next_token: ::String
721
+ SENSITIVE: []
722
+ end
723
+
702
724
  class ListHostKeysRequest
703
725
  attr_accessor max_results: ::Integer
704
726
  attr_accessor next_token: ::String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-transfer
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.104.0
4
+ version: 1.106.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-09-24 00:00:00.000000000 Z
11
+ date: 2024-10-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.207.0
22
+ version: 3.210.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,21 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.207.0
32
+ version: 3.210.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
36
36
  requirements:
37
37
  - - "~>"
38
38
  - !ruby/object:Gem::Version
39
- version: '1.1'
39
+ version: '1.5'
40
40
  type: :runtime
41
41
  prerelease: false
42
42
  version_requirements: !ruby/object:Gem::Requirement
43
43
  requirements:
44
44
  - - "~>"
45
45
  - !ruby/object:Gem::Version
46
- version: '1.1'
46
+ version: '1.5'
47
47
  description: Official AWS Ruby gem for AWS Transfer Family (AWS Transfer). This gem
48
48
  is part of the AWS SDK for Ruby.
49
49
  email: