aws-sdk-transfer 1.103.0 → 1.105.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5ed096b05c5086ef0d5cfc225970d2a3e9eb433fc278dfede513e3bbd271a7e0
4
- data.tar.gz: 69c0b155a6aae64da434dc2400bbd68ea2d047988d65e9ff2f3bfa1ce197ec54
3
+ metadata.gz: cada85840ed32ce20f5f4774c814bac6d9ca7190670f142d33fa78cc31b1716c
4
+ data.tar.gz: 8f6ba01de571827f8fafc05e984ac612bca61e86ba0e2a78f3f6f52baa3bdb79
5
5
  SHA512:
6
- metadata.gz: 4b49520623b0d69af56a4bfde0465b481a998dc42c238737eaab321e3fcea5b693178b319bc3e307b4ab4f66e92dba889978fae29c7a18b2b7e92bbcc1b96e19
7
- data.tar.gz: d549092719cc15bb8b3f9ea0679f1c80db63062368ca1207f8c054b12a5b3f370da14d2ebf3f3fd681a2426be8a88576c2e7cd511817cbc5af91fa5060c992e7
6
+ metadata.gz: dcd755713b5cfab286ac2210e14250b612a9e3e8201b7ed202c0618a4300595737ebe9c0b07f8e18c23ef6f4804076773e7f9cfc726834a0bcaab92ac34aa477
7
+ data.tar.gz: d1eb3bd557e48081d9c4b50021decfbcd03ec64fcb1e079f961a7606c4e242e01a4882fe3a211f8cd20555af8dead4901e41e99055b3e80e4e8de096ce5474a0
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.105.0 (2024-10-14)
5
+ ------------------
6
+
7
+ * 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.
8
+
9
+ 1.104.0 (2024-09-24)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.103.0 (2024-09-23)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.103.0
1
+ 1.105.0
@@ -36,8 +36,6 @@ require 'aws-sdk-core/plugins/telemetry.rb'
36
36
  require 'aws-sdk-core/plugins/sign.rb'
37
37
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
38
38
 
39
- Aws::Plugins::GlobalConfiguration.add_identifier(:transfer)
40
-
41
39
  module Aws::Transfer
42
40
  # An API client for Transfer. To construct a client, you need to configure a `:region` and `:credentials`.
43
41
  #
@@ -653,7 +651,7 @@ module Aws::Transfer
653
651
  # The landing directory (folder) for files transferred by using the AS2
654
652
  # protocol.
655
653
  #
656
- # A `BaseDirectory` example is `/DOC-EXAMPLE-BUCKET/home/mydirectory`.
654
+ # A `BaseDirectory` example is `/amzn-s3-demo-bucket/home/mydirectory`.
657
655
  #
658
656
  # @option params [required, String] :access_role
659
657
  # Connectors are used to send files using either the AS2 or SFTP
@@ -3032,6 +3030,73 @@ module Aws::Transfer
3032
3030
  req.send_request(options)
3033
3031
  end
3034
3032
 
3033
+ # Returns real-time updates and detailed information on the status of
3034
+ # each individual file being transferred in a specific file transfer
3035
+ # operation. You specify the file transfer by providing its
3036
+ # `ConnectorId` and its `TransferId`.
3037
+ #
3038
+ # <note markdown="1"> File transfer results are available up to 7 days after an operation
3039
+ # has been requested.
3040
+ #
3041
+ # </note>
3042
+ #
3043
+ # @option params [required, String] :connector_id
3044
+ # A unique identifier for a connector. This value should match the value
3045
+ # supplied to the corresponding `StartFileTransfer` call.
3046
+ #
3047
+ # @option params [required, String] :transfer_id
3048
+ # A unique identifier for a file transfer. This value should match the
3049
+ # value supplied to the corresponding `StartFileTransfer` call.
3050
+ #
3051
+ # @option params [String] :next_token
3052
+ # If there are more file details than returned in this call, use this
3053
+ # value for a subsequent call to `ListFileTransferResults` to retrieve
3054
+ # them.
3055
+ #
3056
+ # @option params [Integer] :max_results
3057
+ # The maximum number of files to return in a single page. Note that
3058
+ # currently you can specify a maximum of 10 file paths in a single
3059
+ # [StartFileTransfer][1] operation. Thus, the maximum number of file
3060
+ # transfer results that can be returned in a single page is 10.
3061
+ #
3062
+ #
3063
+ #
3064
+ # [1]: https://docs.aws.amazon.com/transfer/latest/APIReference/API_StartFileTransfer.html
3065
+ #
3066
+ # @return [Types::ListFileTransferResultsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3067
+ #
3068
+ # * {Types::ListFileTransferResultsResponse#file_transfer_results #file_transfer_results} => Array&lt;Types::ConnectorFileTransferResult&gt;
3069
+ # * {Types::ListFileTransferResultsResponse#next_token #next_token} => String
3070
+ #
3071
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3072
+ #
3073
+ # @example Request syntax with placeholder values
3074
+ #
3075
+ # resp = client.list_file_transfer_results({
3076
+ # connector_id: "ConnectorId", # required
3077
+ # transfer_id: "TransferId", # required
3078
+ # next_token: "NextToken",
3079
+ # max_results: 1,
3080
+ # })
3081
+ #
3082
+ # @example Response structure
3083
+ #
3084
+ # resp.file_transfer_results #=> Array
3085
+ # resp.file_transfer_results[0].file_path #=> String
3086
+ # resp.file_transfer_results[0].status_code #=> String, one of "QUEUED", "IN_PROGRESS", "COMPLETED", "FAILED"
3087
+ # resp.file_transfer_results[0].failure_code #=> String
3088
+ # resp.file_transfer_results[0].failure_message #=> String
3089
+ # resp.next_token #=> String
3090
+ #
3091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListFileTransferResults AWS API Documentation
3092
+ #
3093
+ # @overload list_file_transfer_results(params = {})
3094
+ # @param [Hash] params ({})
3095
+ def list_file_transfer_results(params = {}, options = {})
3096
+ req = build_request(:list_file_transfer_results, params)
3097
+ req.send_request(options)
3098
+ end
3099
+
3035
3100
  # Returns a list of host keys for the server that's specified by the
3036
3101
  # `ServerId` parameter.
3037
3102
  #
@@ -3527,9 +3592,9 @@ module Aws::Transfer
3527
3592
  # @option params [Array<String>] :send_file_paths
3528
3593
  # One or more source paths for the Amazon S3 storage. Each string
3529
3594
  # represents a source file path for one outbound file transfer. For
3530
- # example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
3595
+ # example, ` amzn-s3-demo-bucket/myfile.txt `.
3531
3596
  #
3532
- # <note markdown="1"> Replace ` DOC-EXAMPLE-BUCKET ` with one of your actual buckets.
3597
+ # <note markdown="1"> Replace ` amzn-s3-demo-bucket ` with one of your actual buckets.
3533
3598
  #
3534
3599
  # </note>
3535
3600
  #
@@ -4050,7 +4115,7 @@ module Aws::Transfer
4050
4115
  # @option params [String] :base_directory
4051
4116
  # To change the landing directory (folder) for files that are
4052
4117
  # transferred, provide the bucket folder that you want to use; for
4053
- # example, `/DOC-EXAMPLE-BUCKET/home/mydirectory `.
4118
+ # example, `/amzn-s3-demo-bucket/home/mydirectory `.
4054
4119
  #
4055
4120
  # @option params [String] :access_role
4056
4121
  # Connectors are used to send files using either the AS2 or SFTP
@@ -4419,10 +4484,10 @@ module Aws::Transfer
4419
4484
  # directly to it.
4420
4485
  #
4421
4486
  # <note markdown="1"> After May 19, 2021, you won't be able to create a server using
4422
- # `EndpointType=VPC_ENDPOINT` in your Amazon Web Servicesaccount if your
4423
- # account hasn't already done so before May 19, 2021. If you have
4487
+ # `EndpointType=VPC_ENDPOINT` in your Amazon Web Services account if
4488
+ # your account hasn't already done so before May 19, 2021. If you have
4424
4489
  # already created servers with `EndpointType=VPC_ENDPOINT` in your
4425
- # Amazon Web Servicesaccount on or before May 19, 2021, you will not be
4490
+ # Amazon Web Services account on or before May 19, 2021, you will not be
4426
4491
  # affected. After this date, use `EndpointType`=`VPC`.
4427
4492
  #
4428
4493
  # For more information, see
@@ -4854,7 +4919,7 @@ module Aws::Transfer
4854
4919
  tracer: tracer
4855
4920
  )
4856
4921
  context[:gem_name] = 'aws-sdk-transfer'
4857
- context[:gem_version] = '1.103.0'
4922
+ context[:gem_version] = '1.105.0'
4858
4923
  Seahorse::Client::Request.new(handlers, context)
4859
4924
  end
4860
4925
 
@@ -38,6 +38,8 @@ module Aws::Transfer
38
38
  CertificateUsageType = Shapes::StringShape.new(name: 'CertificateUsageType')
39
39
  CompressionEnum = Shapes::StringShape.new(name: 'CompressionEnum')
40
40
  ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
41
+ ConnectorFileTransferResult = Shapes::StructureShape.new(name: 'ConnectorFileTransferResult')
42
+ ConnectorFileTransferResults = Shapes::ListShape.new(name: 'ConnectorFileTransferResults')
41
43
  ConnectorId = Shapes::StringShape.new(name: 'ConnectorId')
42
44
  ConnectorSecurityPolicyName = Shapes::StringShape.new(name: 'ConnectorSecurityPolicyName')
43
45
  CopyStepDetails = Shapes::StructureShape.new(name: 'CopyStepDetails')
@@ -125,6 +127,7 @@ module Aws::Transfer
125
127
  ExecutionStepResult = Shapes::StructureShape.new(name: 'ExecutionStepResult')
126
128
  ExecutionStepResults = Shapes::ListShape.new(name: 'ExecutionStepResults')
127
129
  ExternalId = Shapes::StringShape.new(name: 'ExternalId')
130
+ FailureCode = Shapes::StringShape.new(name: 'FailureCode')
128
131
  FileLocation = Shapes::StructureShape.new(name: 'FileLocation')
129
132
  FilePath = Shapes::StringShape.new(name: 'FilePath')
130
133
  FilePaths = Shapes::ListShape.new(name: 'FilePaths')
@@ -161,6 +164,8 @@ module Aws::Transfer
161
164
  ListConnectorsResponse = Shapes::StructureShape.new(name: 'ListConnectorsResponse')
162
165
  ListExecutionsRequest = Shapes::StructureShape.new(name: 'ListExecutionsRequest')
163
166
  ListExecutionsResponse = Shapes::StructureShape.new(name: 'ListExecutionsResponse')
167
+ ListFileTransferResultsRequest = Shapes::StructureShape.new(name: 'ListFileTransferResultsRequest')
168
+ ListFileTransferResultsResponse = Shapes::StructureShape.new(name: 'ListFileTransferResultsResponse')
164
169
  ListHostKeysRequest = Shapes::StructureShape.new(name: 'ListHostKeysRequest')
165
170
  ListHostKeysResponse = Shapes::StructureShape.new(name: 'ListHostKeysResponse')
166
171
  ListProfilesRequest = Shapes::StructureShape.new(name: 'ListProfilesRequest')
@@ -303,6 +308,7 @@ module Aws::Transfer
303
308
  ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
304
309
  TlsSessionResumptionMode = Shapes::StringShape.new(name: 'TlsSessionResumptionMode')
305
310
  TransferId = Shapes::StringShape.new(name: 'TransferId')
311
+ TransferTableStatus = Shapes::StringShape.new(name: 'TransferTableStatus')
306
312
  UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
307
313
  UpdateAccessRequest = Shapes::StructureShape.new(name: 'UpdateAccessRequest')
308
314
  UpdateAccessResponse = Shapes::StructureShape.new(name: 'UpdateAccessResponse')
@@ -359,6 +365,14 @@ module Aws::Transfer
359
365
  ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
360
366
  ConflictException.struct_class = Types::ConflictException
361
367
 
368
+ ConnectorFileTransferResult.add_member(:file_path, Shapes::ShapeRef.new(shape: FilePath, required: true, location_name: "FilePath"))
369
+ ConnectorFileTransferResult.add_member(:status_code, Shapes::ShapeRef.new(shape: TransferTableStatus, required: true, location_name: "StatusCode"))
370
+ ConnectorFileTransferResult.add_member(:failure_code, Shapes::ShapeRef.new(shape: FailureCode, location_name: "FailureCode"))
371
+ ConnectorFileTransferResult.add_member(:failure_message, Shapes::ShapeRef.new(shape: Message, location_name: "FailureMessage"))
372
+ ConnectorFileTransferResult.struct_class = Types::ConnectorFileTransferResult
373
+
374
+ ConnectorFileTransferResults.member = Shapes::ShapeRef.new(shape: ConnectorFileTransferResult)
375
+
362
376
  CopyStepDetails.add_member(:name, Shapes::ShapeRef.new(shape: WorkflowStepName, location_name: "Name"))
363
377
  CopyStepDetails.add_member(:destination_file_location, Shapes::ShapeRef.new(shape: InputFileLocation, location_name: "DestinationFileLocation"))
364
378
  CopyStepDetails.add_member(:overwrite_existing, Shapes::ShapeRef.new(shape: OverwriteExisting, location_name: "OverwriteExisting"))
@@ -855,6 +869,16 @@ module Aws::Transfer
855
869
  ListExecutionsResponse.add_member(:executions, Shapes::ShapeRef.new(shape: ListedExecutions, required: true, location_name: "Executions"))
856
870
  ListExecutionsResponse.struct_class = Types::ListExecutionsResponse
857
871
 
872
+ ListFileTransferResultsRequest.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
873
+ ListFileTransferResultsRequest.add_member(:transfer_id, Shapes::ShapeRef.new(shape: TransferId, required: true, location_name: "TransferId"))
874
+ ListFileTransferResultsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
875
+ ListFileTransferResultsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
876
+ ListFileTransferResultsRequest.struct_class = Types::ListFileTransferResultsRequest
877
+
878
+ ListFileTransferResultsResponse.add_member(:file_transfer_results, Shapes::ShapeRef.new(shape: ConnectorFileTransferResults, required: true, location_name: "FileTransferResults"))
879
+ ListFileTransferResultsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
880
+ ListFileTransferResultsResponse.struct_class = Types::ListFileTransferResultsResponse
881
+
858
882
  ListHostKeysRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
859
883
  ListHostKeysRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
860
884
  ListHostKeysRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
@@ -1304,6 +1328,7 @@ module Aws::Transfer
1304
1328
 
1305
1329
  api.metadata = {
1306
1330
  "apiVersion" => "2018-11-05",
1331
+ "auth" => ["aws.auth#sigv4"],
1307
1332
  "endpointPrefix" => "transfer",
1308
1333
  "jsonVersion" => "1.1",
1309
1334
  "protocol" => "json",
@@ -1804,6 +1829,24 @@ module Aws::Transfer
1804
1829
  )
1805
1830
  end)
1806
1831
 
1832
+ api.add_operation(:list_file_transfer_results, Seahorse::Model::Operation.new.tap do |o|
1833
+ o.name = "ListFileTransferResults"
1834
+ o.http_method = "POST"
1835
+ o.http_request_uri = "/"
1836
+ o.input = Shapes::ShapeRef.new(shape: ListFileTransferResultsRequest)
1837
+ o.output = Shapes::ShapeRef.new(shape: ListFileTransferResultsResponse)
1838
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1839
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1840
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
1841
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
1842
+ o[:pager] = Aws::Pager.new(
1843
+ limit_key: "max_results",
1844
+ tokens: {
1845
+ "next_token" => "next_token"
1846
+ }
1847
+ )
1848
+ end)
1849
+
1807
1850
  api.add_operation(:list_host_keys, Seahorse::Model::Operation.new.tap do |o|
1808
1851
  o.name = "ListHostKeys"
1809
1852
  o.http_method = "POST"
@@ -408,6 +408,17 @@ module Aws::Transfer
408
408
  end
409
409
  end
410
410
 
411
+ class ListFileTransferResults
412
+ def self.build(context)
413
+ Aws::Transfer::EndpointParameters.new(
414
+ region: context.config.region,
415
+ use_dual_stack: context.config.use_dualstack_endpoint,
416
+ use_fips: context.config.use_fips_endpoint,
417
+ endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s,
418
+ )
419
+ end
420
+ end
421
+
411
422
  class ListHostKeys
412
423
  def self.build(context)
413
424
  Aws::Transfer::EndpointParameters.new(
@@ -142,6 +142,8 @@ The endpoint provider used to resolve endpoints. Any object that responds to
142
142
  Aws::Transfer::Endpoints::ListConnectors.build(context)
143
143
  when :list_executions
144
144
  Aws::Transfer::Endpoints::ListExecutions.build(context)
145
+ when :list_file_transfer_results
146
+ Aws::Transfer::Endpoints::ListFileTransferResults.build(context)
145
147
  when :list_host_keys
146
148
  Aws::Transfer::Endpoints::ListHostKeys.build(context)
147
149
  when :list_profiles
@@ -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
@@ -11,6 +11,8 @@
11
11
  require 'aws-sdk-core'
12
12
  require 'aws-sigv4'
13
13
 
14
+ Aws::Plugins::GlobalConfiguration.add_identifier(:transfer)
15
+
14
16
  # This module provides support for AWS Transfer Family. This module is available in the
15
17
  # `aws-sdk-transfer` gem.
16
18
  #
@@ -53,7 +55,7 @@ module Aws::Transfer
53
55
  autoload :EndpointProvider, 'aws-sdk-transfer/endpoint_provider'
54
56
  autoload :Endpoints, 'aws-sdk-transfer/endpoints'
55
57
 
56
- GEM_VERSION = '1.103.0'
58
+ GEM_VERSION = '1.105.0'
57
59
 
58
60
  end
59
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.103.0
4
+ version: 1.105.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-23 00:00:00.000000000 Z
11
+ date: 2024-10-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -36,14 +36,14 @@ dependencies:
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: