aws-sdk-transfer 1.75.0 → 1.76.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 +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transfer/client.rb +113 -20
- data/lib/aws-sdk-transfer/client_api.rb +41 -2
- data/lib/aws-sdk-transfer/endpoints.rb +14 -0
- data/lib/aws-sdk-transfer/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-transfer/types.rb +150 -18
- data/lib/aws-sdk-transfer.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fe6bcc7cd53f1c16ce55c7e85f0cdcc9b74df5709602cdfd3ba72b6deff1bd1d
|
4
|
+
data.tar.gz: b5a2de2447abcbe9dfecf06a61b9660269e289358c634db76d0648cafd9128c4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a515010e1ac93f3f4fd7b7d6844fb4159a8b9c1930305f375ce42a7a03df623e9ca59a6cd724b65652d86da42f48a998792d8e70d40c35179b29a3b0d4a4bd69
|
7
|
+
data.tar.gz: d267ddcf2706834f1ca7240500d3de7e075e61303191e7435c313c7160bdd1821fc38f7adcd35f70a29cfadf2765453a094da71e842467eb31154341bb3ac5ee
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.76.0
|
@@ -646,19 +646,24 @@ module Aws::Transfer
|
|
646
646
|
end
|
647
647
|
|
648
648
|
# Creates the connector, which captures the parameters for an outbound
|
649
|
-
# connection for the AS2 protocol. The connector is required for
|
650
|
-
# files to an externally hosted AS2 server. For more
|
651
|
-
# connectors, see [Create AS2 connectors][1].
|
649
|
+
# connection for the AS2 or SFTP protocol. The connector is required for
|
650
|
+
# sending files to an externally hosted AS2 or SFTP server. For more
|
651
|
+
# details about AS2 connectors, see [Create AS2 connectors][1].
|
652
|
+
#
|
653
|
+
# <note markdown="1"> You must specify exactly one configuration object: either for AS2
|
654
|
+
# (`As2Config`) or SFTP (`SftpConfig`).
|
655
|
+
#
|
656
|
+
# </note>
|
652
657
|
#
|
653
658
|
#
|
654
659
|
#
|
655
660
|
# [1]: https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector
|
656
661
|
#
|
657
662
|
# @option params [required, String] :url
|
658
|
-
# The URL of the partner's AS2 endpoint.
|
663
|
+
# The URL of the partner's AS2 or SFTP endpoint.
|
659
664
|
#
|
660
|
-
# @option params [
|
661
|
-
# A structure that contains the parameters for
|
665
|
+
# @option params [Types::As2ConnectorConfig] :as_2_config
|
666
|
+
# A structure that contains the parameters for an AS2 connector object.
|
662
667
|
#
|
663
668
|
# @option params [required, String] :access_role
|
664
669
|
# With AS2, you can send files by calling `StartFileTransfer` and
|
@@ -690,6 +695,9 @@ module Aws::Transfer
|
|
690
695
|
# Key-value pairs that can be used to group and search for connectors.
|
691
696
|
# Tags are metadata attached to connectors for any purpose.
|
692
697
|
#
|
698
|
+
# @option params [Types::SftpConnectorConfig] :sftp_config
|
699
|
+
# A structure that contains the parameters for an SFTP connector object.
|
700
|
+
#
|
693
701
|
# @return [Types::CreateConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
694
702
|
#
|
695
703
|
# * {Types::CreateConnectorResponse#connector_id #connector_id} => String
|
@@ -698,7 +706,7 @@ module Aws::Transfer
|
|
698
706
|
#
|
699
707
|
# resp = client.create_connector({
|
700
708
|
# url: "Url", # required
|
701
|
-
# as_2_config: {
|
709
|
+
# as_2_config: {
|
702
710
|
# local_profile_id: "ProfileId",
|
703
711
|
# partner_profile_id: "ProfileId",
|
704
712
|
# message_subject: "MessageSubject",
|
@@ -717,6 +725,10 @@ module Aws::Transfer
|
|
717
725
|
# value: "TagValue", # required
|
718
726
|
# },
|
719
727
|
# ],
|
728
|
+
# sftp_config: {
|
729
|
+
# user_secret_id: "SecretId",
|
730
|
+
# trusted_host_keys: ["SftpConnectorTrustedHostKey"],
|
731
|
+
# },
|
720
732
|
# })
|
721
733
|
#
|
722
734
|
# @example Response structure
|
@@ -1187,8 +1199,8 @@ module Aws::Transfer
|
|
1187
1199
|
#
|
1188
1200
|
# In most cases, you can use this value instead of the session policy to
|
1189
1201
|
# lock your user down to the designated home directory ("`chroot`").
|
1190
|
-
# To do this, you can set `Entry` to `/` and set `Target` to the
|
1191
|
-
#
|
1202
|
+
# To do this, you can set `Entry` to `/` and set `Target` to the value
|
1203
|
+
# the user should see for their home directory when they log in.
|
1192
1204
|
#
|
1193
1205
|
# The following is an `Entry` and `Target` pair example for `chroot`.
|
1194
1206
|
#
|
@@ -1606,7 +1618,7 @@ module Aws::Transfer
|
|
1606
1618
|
req.send_request(options)
|
1607
1619
|
end
|
1608
1620
|
|
1609
|
-
# Deletes the
|
1621
|
+
# Deletes the connector that's specified in the provided `ConnectorId`.
|
1610
1622
|
#
|
1611
1623
|
# @option params [required, String] :connector_id
|
1612
1624
|
# The unique identifier for the connector.
|
@@ -1979,6 +1991,9 @@ module Aws::Transfer
|
|
1979
1991
|
# resp.connector.tags #=> Array
|
1980
1992
|
# resp.connector.tags[0].key #=> String
|
1981
1993
|
# resp.connector.tags[0].value #=> String
|
1994
|
+
# resp.connector.sftp_config.user_secret_id #=> String
|
1995
|
+
# resp.connector.sftp_config.trusted_host_keys #=> Array
|
1996
|
+
# resp.connector.sftp_config.trusted_host_keys[0] #=> String
|
1982
1997
|
#
|
1983
1998
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeConnector AWS API Documentation
|
1984
1999
|
#
|
@@ -3241,16 +3256,49 @@ module Aws::Transfer
|
|
3241
3256
|
req.send_request(options)
|
3242
3257
|
end
|
3243
3258
|
|
3244
|
-
# Begins
|
3245
|
-
#
|
3259
|
+
# Begins a file transfer between local Amazon Web Services storage and a
|
3260
|
+
# remote AS2 or SFTP server.
|
3261
|
+
#
|
3262
|
+
# * For an AS2 connector, you specify the `ConnectorId` and one or more
|
3263
|
+
# `SendFilePaths` to identify the files you want to transfer.
|
3264
|
+
#
|
3265
|
+
# * For an SFTP connector, the file transfer can be either outbound or
|
3266
|
+
# inbound. In both cases, you specify the `ConnectorId`. Depending on
|
3267
|
+
# the direction of the transfer, you also specify the following items:
|
3268
|
+
#
|
3269
|
+
# * If you are transferring file from a partner's SFTP server to a
|
3270
|
+
# Transfer Family server, you specify one or more
|
3271
|
+
# `RetreiveFilePaths` to identify the files you want to transfer,
|
3272
|
+
# and a `LocalDirectoryPath` to specify the destination folder.
|
3273
|
+
#
|
3274
|
+
# * If you are transferring file to a partner's SFTP server from
|
3275
|
+
# Amazon Web Services storage, you specify one or more
|
3276
|
+
# `SendFilePaths` to identify the files you want to transfer, and a
|
3277
|
+
# `RemoteDirectoryPath` to specify the destination folder.
|
3246
3278
|
#
|
3247
3279
|
# @option params [required, String] :connector_id
|
3248
3280
|
# The unique identifier for the connector.
|
3249
3281
|
#
|
3250
|
-
# @option params [
|
3251
|
-
#
|
3252
|
-
# outbound file transfer. For
|
3253
|
-
# `.
|
3282
|
+
# @option params [Array<String>] :send_file_paths
|
3283
|
+
# One or more source paths for the Transfer Family server. Each string
|
3284
|
+
# represents a source file path for one outbound file transfer. For
|
3285
|
+
# example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
|
3286
|
+
#
|
3287
|
+
# @option params [Array<String>] :retrieve_file_paths
|
3288
|
+
# One or more source paths for the partner's SFTP server. Each string
|
3289
|
+
# represents a source file path for one inbound file transfer.
|
3290
|
+
#
|
3291
|
+
# @option params [String] :local_directory_path
|
3292
|
+
# For an inbound transfer, the `LocaDirectoryPath` specifies the
|
3293
|
+
# destination for one or more files that are transferred from the
|
3294
|
+
# partner's SFTP server.
|
3295
|
+
#
|
3296
|
+
# @option params [String] :remote_directory_path
|
3297
|
+
# For an outbound transfer, the `RemoteDirectoryPath` specifies the
|
3298
|
+
# destination for one or more files that are transferred to the
|
3299
|
+
# partner's SFTP server. If you don't specify a `RemoteDirectoryPath`,
|
3300
|
+
# the destination for transferred files is the SFTP user's home
|
3301
|
+
# directory.
|
3254
3302
|
#
|
3255
3303
|
# @return [Types::StartFileTransferResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3256
3304
|
#
|
@@ -3260,7 +3308,10 @@ module Aws::Transfer
|
|
3260
3308
|
#
|
3261
3309
|
# resp = client.start_file_transfer({
|
3262
3310
|
# connector_id: "ConnectorId", # required
|
3263
|
-
# send_file_paths: ["FilePath"],
|
3311
|
+
# send_file_paths: ["FilePath"],
|
3312
|
+
# retrieve_file_paths: ["FilePath"],
|
3313
|
+
# local_directory_path: "FilePath",
|
3314
|
+
# remote_directory_path: "FilePath",
|
3264
3315
|
# })
|
3265
3316
|
#
|
3266
3317
|
# @example Response structure
|
@@ -3382,6 +3433,41 @@ module Aws::Transfer
|
|
3382
3433
|
req.send_request(options)
|
3383
3434
|
end
|
3384
3435
|
|
3436
|
+
# Tests whether your SFTP connector is set up successfully. We highly
|
3437
|
+
# recommend that you call this operation to test your ability to
|
3438
|
+
# transfer files between a Transfer Family server and a trading
|
3439
|
+
# partner's SFTP server.
|
3440
|
+
#
|
3441
|
+
# @option params [required, String] :connector_id
|
3442
|
+
# The unique identifier for the connector.
|
3443
|
+
#
|
3444
|
+
# @return [Types::TestConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3445
|
+
#
|
3446
|
+
# * {Types::TestConnectionResponse#connector_id #connector_id} => String
|
3447
|
+
# * {Types::TestConnectionResponse#status #status} => String
|
3448
|
+
# * {Types::TestConnectionResponse#status_message #status_message} => String
|
3449
|
+
#
|
3450
|
+
# @example Request syntax with placeholder values
|
3451
|
+
#
|
3452
|
+
# resp = client.test_connection({
|
3453
|
+
# connector_id: "ConnectorId", # required
|
3454
|
+
# })
|
3455
|
+
#
|
3456
|
+
# @example Response structure
|
3457
|
+
#
|
3458
|
+
# resp.connector_id #=> String
|
3459
|
+
# resp.status #=> String
|
3460
|
+
# resp.status_message #=> String
|
3461
|
+
#
|
3462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestConnection AWS API Documentation
|
3463
|
+
#
|
3464
|
+
# @overload test_connection(params = {})
|
3465
|
+
# @param [Hash] params ({})
|
3466
|
+
def test_connection(params = {}, options = {})
|
3467
|
+
req = build_request(:test_connection, params)
|
3468
|
+
req.send_request(options)
|
3469
|
+
end
|
3470
|
+
|
3385
3471
|
# If the `IdentityProviderType` of a file transfer protocol-enabled
|
3386
3472
|
# server is `AWS_DIRECTORY_SERVICE` or `API_Gateway`, tests whether your
|
3387
3473
|
# identity provider is set up successfully. We highly recommend that you
|
@@ -3801,10 +3887,10 @@ module Aws::Transfer
|
|
3801
3887
|
# The unique identifier for the connector.
|
3802
3888
|
#
|
3803
3889
|
# @option params [String] :url
|
3804
|
-
# The URL of the partner's AS2 endpoint.
|
3890
|
+
# The URL of the partner's AS2 or SFTP endpoint.
|
3805
3891
|
#
|
3806
3892
|
# @option params [Types::As2ConnectorConfig] :as_2_config
|
3807
|
-
# A structure that contains the parameters for
|
3893
|
+
# A structure that contains the parameters for an AS2 connector object.
|
3808
3894
|
#
|
3809
3895
|
# @option params [String] :access_role
|
3810
3896
|
# With AS2, you can send files by calling `StartFileTransfer` and
|
@@ -3832,6 +3918,9 @@ module Aws::Transfer
|
|
3832
3918
|
# Amazon S3 events. When set, you can view connector activity in your
|
3833
3919
|
# CloudWatch logs.
|
3834
3920
|
#
|
3921
|
+
# @option params [Types::SftpConnectorConfig] :sftp_config
|
3922
|
+
# A structure that contains the parameters for an SFTP connector object.
|
3923
|
+
#
|
3835
3924
|
# @return [Types::UpdateConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3836
3925
|
#
|
3837
3926
|
# * {Types::UpdateConnectorResponse#connector_id #connector_id} => String
|
@@ -3854,6 +3943,10 @@ module Aws::Transfer
|
|
3854
3943
|
# },
|
3855
3944
|
# access_role: "Role",
|
3856
3945
|
# logging_role: "Role",
|
3946
|
+
# sftp_config: {
|
3947
|
+
# user_secret_id: "SecretId",
|
3948
|
+
# trusted_host_keys: ["SftpConnectorTrustedHostKey"],
|
3949
|
+
# },
|
3857
3950
|
# })
|
3858
3951
|
#
|
3859
3952
|
# @example Response structure
|
@@ -4421,7 +4514,7 @@ module Aws::Transfer
|
|
4421
4514
|
params: params,
|
4422
4515
|
config: config)
|
4423
4516
|
context[:gem_name] = 'aws-sdk-transfer'
|
4424
|
-
context[:gem_version] = '1.
|
4517
|
+
context[:gem_version] = '1.76.0'
|
4425
4518
|
Seahorse::Client::Request.new(handlers, context)
|
4426
4519
|
end
|
4427
4520
|
|
@@ -236,6 +236,7 @@ module Aws::Transfer
|
|
236
236
|
S3Tags = Shapes::ListShape.new(name: 'S3Tags')
|
237
237
|
S3VersionId = Shapes::StringShape.new(name: 'S3VersionId')
|
238
238
|
SecondaryGids = Shapes::ListShape.new(name: 'SecondaryGids')
|
239
|
+
SecretId = Shapes::StringShape.new(name: 'SecretId')
|
239
240
|
SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
|
240
241
|
SecurityGroupIds = Shapes::ListShape.new(name: 'SecurityGroupIds')
|
241
242
|
SecurityPolicyName = Shapes::StringShape.new(name: 'SecurityPolicyName')
|
@@ -251,6 +252,9 @@ module Aws::Transfer
|
|
251
252
|
SessionId = Shapes::StringShape.new(name: 'SessionId')
|
252
253
|
SetStatOption = Shapes::StringShape.new(name: 'SetStatOption')
|
253
254
|
SftpAuthenticationMethods = Shapes::StringShape.new(name: 'SftpAuthenticationMethods')
|
255
|
+
SftpConnectorConfig = Shapes::StructureShape.new(name: 'SftpConnectorConfig')
|
256
|
+
SftpConnectorTrustedHostKey = Shapes::StringShape.new(name: 'SftpConnectorTrustedHostKey')
|
257
|
+
SftpConnectorTrustedHostKeyList = Shapes::ListShape.new(name: 'SftpConnectorTrustedHostKeyList')
|
254
258
|
SigningAlg = Shapes::StringShape.new(name: 'SigningAlg')
|
255
259
|
SourceFileLocation = Shapes::StringShape.new(name: 'SourceFileLocation')
|
256
260
|
SourceIp = Shapes::StringShape.new(name: 'SourceIp')
|
@@ -263,6 +267,7 @@ module Aws::Transfer
|
|
263
267
|
StartFileTransferResponse = Shapes::StructureShape.new(name: 'StartFileTransferResponse')
|
264
268
|
StartServerRequest = Shapes::StructureShape.new(name: 'StartServerRequest')
|
265
269
|
State = Shapes::StringShape.new(name: 'State')
|
270
|
+
Status = Shapes::StringShape.new(name: 'Status')
|
266
271
|
StatusCode = Shapes::IntegerShape.new(name: 'StatusCode')
|
267
272
|
StepResultOutputsJson = Shapes::StringShape.new(name: 'StepResultOutputsJson')
|
268
273
|
StopServerRequest = Shapes::StructureShape.new(name: 'StopServerRequest')
|
@@ -276,6 +281,8 @@ module Aws::Transfer
|
|
276
281
|
TagStepDetails = Shapes::StructureShape.new(name: 'TagStepDetails')
|
277
282
|
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
278
283
|
Tags = Shapes::ListShape.new(name: 'Tags')
|
284
|
+
TestConnectionRequest = Shapes::StructureShape.new(name: 'TestConnectionRequest')
|
285
|
+
TestConnectionResponse = Shapes::StructureShape.new(name: 'TestConnectionResponse')
|
279
286
|
TestIdentityProviderRequest = Shapes::StructureShape.new(name: 'TestIdentityProviderRequest')
|
280
287
|
TestIdentityProviderResponse = Shapes::StructureShape.new(name: 'TestIdentityProviderResponse')
|
281
288
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
@@ -371,10 +378,11 @@ module Aws::Transfer
|
|
371
378
|
CreateAgreementResponse.struct_class = Types::CreateAgreementResponse
|
372
379
|
|
373
380
|
CreateConnectorRequest.add_member(:url, Shapes::ShapeRef.new(shape: Url, required: true, location_name: "Url"))
|
374
|
-
CreateConnectorRequest.add_member(:as_2_config, Shapes::ShapeRef.new(shape: As2ConnectorConfig,
|
381
|
+
CreateConnectorRequest.add_member(:as_2_config, Shapes::ShapeRef.new(shape: As2ConnectorConfig, location_name: "As2Config"))
|
375
382
|
CreateConnectorRequest.add_member(:access_role, Shapes::ShapeRef.new(shape: Role, required: true, location_name: "AccessRole"))
|
376
383
|
CreateConnectorRequest.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
|
377
384
|
CreateConnectorRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
385
|
+
CreateConnectorRequest.add_member(:sftp_config, Shapes::ShapeRef.new(shape: SftpConnectorConfig, location_name: "SftpConfig"))
|
378
386
|
CreateConnectorRequest.struct_class = Types::CreateConnectorRequest
|
379
387
|
|
380
388
|
CreateConnectorResponse.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
|
@@ -606,6 +614,7 @@ module Aws::Transfer
|
|
606
614
|
DescribedConnector.add_member(:access_role, Shapes::ShapeRef.new(shape: Role, location_name: "AccessRole"))
|
607
615
|
DescribedConnector.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
|
608
616
|
DescribedConnector.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
617
|
+
DescribedConnector.add_member(:sftp_config, Shapes::ShapeRef.new(shape: SftpConnectorConfig, location_name: "SftpConfig"))
|
609
618
|
DescribedConnector.struct_class = Types::DescribedConnector
|
610
619
|
|
611
620
|
DescribedExecution.add_member(:execution_id, Shapes::ShapeRef.new(shape: ExecutionId, location_name: "ExecutionId"))
|
@@ -1046,6 +1055,12 @@ module Aws::Transfer
|
|
1046
1055
|
ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ServiceErrorMessage, location_name: "Message"))
|
1047
1056
|
ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
|
1048
1057
|
|
1058
|
+
SftpConnectorConfig.add_member(:user_secret_id, Shapes::ShapeRef.new(shape: SecretId, location_name: "UserSecretId"))
|
1059
|
+
SftpConnectorConfig.add_member(:trusted_host_keys, Shapes::ShapeRef.new(shape: SftpConnectorTrustedHostKeyList, location_name: "TrustedHostKeys"))
|
1060
|
+
SftpConnectorConfig.struct_class = Types::SftpConnectorConfig
|
1061
|
+
|
1062
|
+
SftpConnectorTrustedHostKeyList.member = Shapes::ShapeRef.new(shape: SftpConnectorTrustedHostKey)
|
1063
|
+
|
1049
1064
|
SshPublicKey.add_member(:date_imported, Shapes::ShapeRef.new(shape: DateImported, required: true, location_name: "DateImported"))
|
1050
1065
|
SshPublicKey.add_member(:ssh_public_key_body, Shapes::ShapeRef.new(shape: SshPublicKeyBody, required: true, location_name: "SshPublicKeyBody"))
|
1051
1066
|
SshPublicKey.add_member(:ssh_public_key_id, Shapes::ShapeRef.new(shape: SshPublicKeyId, required: true, location_name: "SshPublicKeyId"))
|
@@ -1054,7 +1069,10 @@ module Aws::Transfer
|
|
1054
1069
|
SshPublicKeys.member = Shapes::ShapeRef.new(shape: SshPublicKey)
|
1055
1070
|
|
1056
1071
|
StartFileTransferRequest.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
|
1057
|
-
StartFileTransferRequest.add_member(:send_file_paths, Shapes::ShapeRef.new(shape: FilePaths,
|
1072
|
+
StartFileTransferRequest.add_member(:send_file_paths, Shapes::ShapeRef.new(shape: FilePaths, location_name: "SendFilePaths"))
|
1073
|
+
StartFileTransferRequest.add_member(:retrieve_file_paths, Shapes::ShapeRef.new(shape: FilePaths, location_name: "RetrieveFilePaths"))
|
1074
|
+
StartFileTransferRequest.add_member(:local_directory_path, Shapes::ShapeRef.new(shape: FilePath, location_name: "LocalDirectoryPath"))
|
1075
|
+
StartFileTransferRequest.add_member(:remote_directory_path, Shapes::ShapeRef.new(shape: FilePath, location_name: "RemoteDirectoryPath"))
|
1058
1076
|
StartFileTransferRequest.struct_class = Types::StartFileTransferRequest
|
1059
1077
|
|
1060
1078
|
StartFileTransferResponse.add_member(:transfer_id, Shapes::ShapeRef.new(shape: TransferId, required: true, location_name: "TransferId"))
|
@@ -1087,6 +1105,14 @@ module Aws::Transfer
|
|
1087
1105
|
|
1088
1106
|
Tags.member = Shapes::ShapeRef.new(shape: Tag)
|
1089
1107
|
|
1108
|
+
TestConnectionRequest.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
|
1109
|
+
TestConnectionRequest.struct_class = Types::TestConnectionRequest
|
1110
|
+
|
1111
|
+
TestConnectionResponse.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, location_name: "ConnectorId"))
|
1112
|
+
TestConnectionResponse.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "Status"))
|
1113
|
+
TestConnectionResponse.add_member(:status_message, Shapes::ShapeRef.new(shape: Message, location_name: "StatusMessage"))
|
1114
|
+
TestConnectionResponse.struct_class = Types::TestConnectionResponse
|
1115
|
+
|
1090
1116
|
TestIdentityProviderRequest.add_member(:server_id, Shapes::ShapeRef.new(shape: ServerId, required: true, location_name: "ServerId"))
|
1091
1117
|
TestIdentityProviderRequest.add_member(:server_protocol, Shapes::ShapeRef.new(shape: Protocol, location_name: "ServerProtocol"))
|
1092
1118
|
TestIdentityProviderRequest.add_member(:source_ip, Shapes::ShapeRef.new(shape: SourceIp, location_name: "SourceIp"))
|
@@ -1148,6 +1174,7 @@ module Aws::Transfer
|
|
1148
1174
|
UpdateConnectorRequest.add_member(:as_2_config, Shapes::ShapeRef.new(shape: As2ConnectorConfig, location_name: "As2Config"))
|
1149
1175
|
UpdateConnectorRequest.add_member(:access_role, Shapes::ShapeRef.new(shape: Role, location_name: "AccessRole"))
|
1150
1176
|
UpdateConnectorRequest.add_member(:logging_role, Shapes::ShapeRef.new(shape: Role, location_name: "LoggingRole"))
|
1177
|
+
UpdateConnectorRequest.add_member(:sftp_config, Shapes::ShapeRef.new(shape: SftpConnectorConfig, location_name: "SftpConfig"))
|
1151
1178
|
UpdateConnectorRequest.struct_class = Types::UpdateConnectorRequest
|
1152
1179
|
|
1153
1180
|
UpdateConnectorResponse.add_member(:connector_id, Shapes::ShapeRef.new(shape: ConnectorId, required: true, location_name: "ConnectorId"))
|
@@ -1920,6 +1947,18 @@ module Aws::Transfer
|
|
1920
1947
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1921
1948
|
end)
|
1922
1949
|
|
1950
|
+
api.add_operation(:test_connection, Seahorse::Model::Operation.new.tap do |o|
|
1951
|
+
o.name = "TestConnection"
|
1952
|
+
o.http_method = "POST"
|
1953
|
+
o.http_request_uri = "/"
|
1954
|
+
o.input = Shapes::ShapeRef.new(shape: TestConnectionRequest)
|
1955
|
+
o.output = Shapes::ShapeRef.new(shape: TestConnectionResponse)
|
1956
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1957
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
1958
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1959
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1960
|
+
end)
|
1961
|
+
|
1923
1962
|
api.add_operation(:test_identity_provider, Seahorse::Model::Operation.new.tap do |o|
|
1924
1963
|
o.name = "TestIdentityProvider"
|
1925
1964
|
o.http_method = "POST"
|
@@ -684,6 +684,20 @@ module Aws::Transfer
|
|
684
684
|
end
|
685
685
|
end
|
686
686
|
|
687
|
+
class TestConnection
|
688
|
+
def self.build(context)
|
689
|
+
unless context.config.regional_endpoint
|
690
|
+
endpoint = context.config.endpoint.to_s
|
691
|
+
end
|
692
|
+
Aws::Transfer::EndpointParameters.new(
|
693
|
+
region: context.config.region,
|
694
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
695
|
+
use_fips: context.config.use_fips_endpoint,
|
696
|
+
endpoint: endpoint,
|
697
|
+
)
|
698
|
+
end
|
699
|
+
end
|
700
|
+
|
687
701
|
class TestIdentityProvider
|
688
702
|
def self.build(context)
|
689
703
|
unless context.config.regional_endpoint
|
@@ -152,6 +152,8 @@ module Aws::Transfer
|
|
152
152
|
Aws::Transfer::Endpoints::StopServer.build(context)
|
153
153
|
when :tag_resource
|
154
154
|
Aws::Transfer::Endpoints::TagResource.build(context)
|
155
|
+
when :test_connection
|
156
|
+
Aws::Transfer::Endpoints::TestConnection.build(context)
|
155
157
|
when :test_identity_provider
|
156
158
|
Aws::Transfer::Endpoints::TestIdentityProvider.build(context)
|
157
159
|
when :untag_resource
|
@@ -23,8 +23,8 @@ module Aws::Transfer
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
-
# Contains the details for
|
27
|
-
# used for AS2 outbound processes, to connect the Transfer Family
|
26
|
+
# Contains the details for an AS2 connector object. The connector object
|
27
|
+
# is used for AS2 outbound processes, to connect the Transfer Family
|
28
28
|
# customer with the trading partner.
|
29
29
|
#
|
30
30
|
# @!attribute [rw] local_profile_id
|
@@ -445,11 +445,12 @@ module Aws::Transfer
|
|
445
445
|
end
|
446
446
|
|
447
447
|
# @!attribute [rw] url
|
448
|
-
# The URL of the partner's AS2 endpoint.
|
448
|
+
# The URL of the partner's AS2 or SFTP endpoint.
|
449
449
|
# @return [String]
|
450
450
|
#
|
451
451
|
# @!attribute [rw] as_2_config
|
452
|
-
# A structure that contains the parameters for
|
452
|
+
# A structure that contains the parameters for an AS2 connector
|
453
|
+
# object.
|
453
454
|
# @return [Types::As2ConnectorConfig]
|
454
455
|
#
|
455
456
|
# @!attribute [rw] access_role
|
@@ -486,6 +487,11 @@ module Aws::Transfer
|
|
486
487
|
# Tags are metadata attached to connectors for any purpose.
|
487
488
|
# @return [Array<Types::Tag>]
|
488
489
|
#
|
490
|
+
# @!attribute [rw] sftp_config
|
491
|
+
# A structure that contains the parameters for an SFTP connector
|
492
|
+
# object.
|
493
|
+
# @return [Types::SftpConnectorConfig]
|
494
|
+
#
|
489
495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateConnectorRequest AWS API Documentation
|
490
496
|
#
|
491
497
|
class CreateConnectorRequest < Struct.new(
|
@@ -493,7 +499,8 @@ module Aws::Transfer
|
|
493
499
|
:as_2_config,
|
494
500
|
:access_role,
|
495
501
|
:logging_role,
|
496
|
-
:tags
|
502
|
+
:tags,
|
503
|
+
:sftp_config)
|
497
504
|
SENSITIVE = []
|
498
505
|
include Aws::Structure
|
499
506
|
end
|
@@ -931,7 +938,8 @@ module Aws::Transfer
|
|
931
938
|
# In most cases, you can use this value instead of the session policy
|
932
939
|
# to lock your user down to the designated home directory
|
933
940
|
# ("`chroot`"). To do this, you can set `Entry` to `/` and set
|
934
|
-
# `Target` to the
|
941
|
+
# `Target` to the value the user should see for their home directory
|
942
|
+
# when they log in.
|
935
943
|
#
|
936
944
|
# The following is an `Entry` and `Target` pair example for `chroot`.
|
937
945
|
#
|
@@ -2050,11 +2058,12 @@ module Aws::Transfer
|
|
2050
2058
|
# @return [String]
|
2051
2059
|
#
|
2052
2060
|
# @!attribute [rw] url
|
2053
|
-
# The URL of the partner's AS2 endpoint.
|
2061
|
+
# The URL of the partner's AS2 or SFTP endpoint.
|
2054
2062
|
# @return [String]
|
2055
2063
|
#
|
2056
2064
|
# @!attribute [rw] as_2_config
|
2057
|
-
# A structure that contains the parameters for
|
2065
|
+
# A structure that contains the parameters for an AS2 connector
|
2066
|
+
# object.
|
2058
2067
|
# @return [Types::As2ConnectorConfig]
|
2059
2068
|
#
|
2060
2069
|
# @!attribute [rw] access_role
|
@@ -2090,6 +2099,11 @@ module Aws::Transfer
|
|
2090
2099
|
# Key-value pairs that can be used to group and search for connectors.
|
2091
2100
|
# @return [Array<Types::Tag>]
|
2092
2101
|
#
|
2102
|
+
# @!attribute [rw] sftp_config
|
2103
|
+
# A structure that contains the parameters for an SFTP connector
|
2104
|
+
# object.
|
2105
|
+
# @return [Types::SftpConnectorConfig]
|
2106
|
+
#
|
2093
2107
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedConnector AWS API Documentation
|
2094
2108
|
#
|
2095
2109
|
class DescribedConnector < Struct.new(
|
@@ -2099,7 +2113,8 @@ module Aws::Transfer
|
|
2099
2113
|
:as_2_config,
|
2100
2114
|
:access_role,
|
2101
2115
|
:logging_role,
|
2102
|
-
:tags
|
2116
|
+
:tags,
|
2117
|
+
:sftp_config)
|
2103
2118
|
SENSITIVE = []
|
2104
2119
|
include Aws::Structure
|
2105
2120
|
end
|
@@ -4018,7 +4033,7 @@ module Aws::Transfer
|
|
4018
4033
|
# @return [String]
|
4019
4034
|
#
|
4020
4035
|
# @!attribute [rw] url
|
4021
|
-
# The URL of the partner's AS2 endpoint.
|
4036
|
+
# The URL of the partner's AS2 or SFTP endpoint.
|
4022
4037
|
# @return [String]
|
4023
4038
|
#
|
4024
4039
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedConnector AWS API Documentation
|
@@ -4702,6 +4717,44 @@ module Aws::Transfer
|
|
4702
4717
|
include Aws::Structure
|
4703
4718
|
end
|
4704
4719
|
|
4720
|
+
# Contains the details for an SFTP connector object. The connector
|
4721
|
+
# object is used for transferring files to and from a partner's SFTP
|
4722
|
+
# server.
|
4723
|
+
#
|
4724
|
+
# @!attribute [rw] user_secret_id
|
4725
|
+
# The identifiers for the secrets (in Amazon Web Services Secrets
|
4726
|
+
# Manager) that contain the SFTP user's private keys or passwords.
|
4727
|
+
# @return [String]
|
4728
|
+
#
|
4729
|
+
# @!attribute [rw] trusted_host_keys
|
4730
|
+
# The public portion of the host key, or keys, that are used to
|
4731
|
+
# authenticate the user to the external server to which you are
|
4732
|
+
# connecting. You can use the `ssh-keyscan` command against the SFTP
|
4733
|
+
# server to retrieve the necessary key.
|
4734
|
+
#
|
4735
|
+
# The three standard SSH public key format elements are `<key type>`,
|
4736
|
+
# `<body base64>`, and an optional `<comment>`, with spaces between
|
4737
|
+
# each element.
|
4738
|
+
#
|
4739
|
+
# For the trusted host key, Transfer Family accepts RSA and ECDSA
|
4740
|
+
# keys.
|
4741
|
+
#
|
4742
|
+
# * For RSA keys, the key type is `ssh-rsa`.
|
4743
|
+
#
|
4744
|
+
# * For ECDSA keys, the key type is either `ecdsa-sha2-nistp256`,
|
4745
|
+
# `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`, depending on the
|
4746
|
+
# size of the key you generated.
|
4747
|
+
# @return [Array<String>]
|
4748
|
+
#
|
4749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/SftpConnectorConfig AWS API Documentation
|
4750
|
+
#
|
4751
|
+
class SftpConnectorConfig < Struct.new(
|
4752
|
+
:user_secret_id,
|
4753
|
+
:trusted_host_keys)
|
4754
|
+
SENSITIVE = []
|
4755
|
+
include Aws::Structure
|
4756
|
+
end
|
4757
|
+
|
4705
4758
|
# Provides information about the public Secure Shell (SSH) key that is
|
4706
4759
|
# associated with a Transfer Family user for the specific file transfer
|
4707
4760
|
# protocol-enabled server (as identified by `ServerId`). The information
|
@@ -4741,22 +4794,44 @@ module Aws::Transfer
|
|
4741
4794
|
# @return [String]
|
4742
4795
|
#
|
4743
4796
|
# @!attribute [rw] send_file_paths
|
4744
|
-
#
|
4745
|
-
# one outbound file transfer. For
|
4746
|
-
# DOC-EXAMPLE-BUCKET/myfile.txt `.
|
4797
|
+
# One or more source paths for the Transfer Family server. Each string
|
4798
|
+
# represents a source file path for one outbound file transfer. For
|
4799
|
+
# example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
|
4800
|
+
# @return [Array<String>]
|
4801
|
+
#
|
4802
|
+
# @!attribute [rw] retrieve_file_paths
|
4803
|
+
# One or more source paths for the partner's SFTP server. Each string
|
4804
|
+
# represents a source file path for one inbound file transfer.
|
4747
4805
|
# @return [Array<String>]
|
4748
4806
|
#
|
4807
|
+
# @!attribute [rw] local_directory_path
|
4808
|
+
# For an inbound transfer, the `LocaDirectoryPath` specifies the
|
4809
|
+
# destination for one or more files that are transferred from the
|
4810
|
+
# partner's SFTP server.
|
4811
|
+
# @return [String]
|
4812
|
+
#
|
4813
|
+
# @!attribute [rw] remote_directory_path
|
4814
|
+
# For an outbound transfer, the `RemoteDirectoryPath` specifies the
|
4815
|
+
# destination for one or more files that are transferred to the
|
4816
|
+
# partner's SFTP server. If you don't specify a
|
4817
|
+
# `RemoteDirectoryPath`, the destination for transferred files is the
|
4818
|
+
# SFTP user's home directory.
|
4819
|
+
# @return [String]
|
4820
|
+
#
|
4749
4821
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartFileTransferRequest AWS API Documentation
|
4750
4822
|
#
|
4751
4823
|
class StartFileTransferRequest < Struct.new(
|
4752
4824
|
:connector_id,
|
4753
|
-
:send_file_paths
|
4825
|
+
:send_file_paths,
|
4826
|
+
:retrieve_file_paths,
|
4827
|
+
:local_directory_path,
|
4828
|
+
:remote_directory_path)
|
4754
4829
|
SENSITIVE = []
|
4755
4830
|
include Aws::Structure
|
4756
4831
|
end
|
4757
4832
|
|
4758
4833
|
# @!attribute [rw] transfer_id
|
4759
|
-
# Returns the unique identifier for
|
4834
|
+
# Returns the unique identifier for the file transfer.
|
4760
4835
|
# @return [String]
|
4761
4836
|
#
|
4762
4837
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartFileTransferResponse AWS API Documentation
|
@@ -4872,6 +4947,56 @@ module Aws::Transfer
|
|
4872
4947
|
include Aws::Structure
|
4873
4948
|
end
|
4874
4949
|
|
4950
|
+
# @!attribute [rw] connector_id
|
4951
|
+
# The unique identifier for the connector.
|
4952
|
+
# @return [String]
|
4953
|
+
#
|
4954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestConnectionRequest AWS API Documentation
|
4955
|
+
#
|
4956
|
+
class TestConnectionRequest < Struct.new(
|
4957
|
+
:connector_id)
|
4958
|
+
SENSITIVE = []
|
4959
|
+
include Aws::Structure
|
4960
|
+
end
|
4961
|
+
|
4962
|
+
# @!attribute [rw] connector_id
|
4963
|
+
# Returns the identifier of the connector object that you are testing.
|
4964
|
+
# @return [String]
|
4965
|
+
#
|
4966
|
+
# @!attribute [rw] status
|
4967
|
+
# Returns `OK` for successful test, or `ERROR` if the test fails.
|
4968
|
+
# @return [String]
|
4969
|
+
#
|
4970
|
+
# @!attribute [rw] status_message
|
4971
|
+
# Returns `Connection succeeded` if the test is successful. Or,
|
4972
|
+
# returns a descriptive error message if the test fails. The following
|
4973
|
+
# list provides the details for some error messages and
|
4974
|
+
# troubleshooting steps for each.
|
4975
|
+
#
|
4976
|
+
# * **Unable to access secrets manager**: Verify that your secret name
|
4977
|
+
# aligns with the one in Transfer Role permissions.
|
4978
|
+
#
|
4979
|
+
# * **Unknown Host/Connection failed**: Verify the server URL in the
|
4980
|
+
# connector configuration , and verify that the login credentials
|
4981
|
+
# work successfully outside of the connector.
|
4982
|
+
#
|
4983
|
+
# * **Private key not found**: Verify that the secret exists and is
|
4984
|
+
# formatted correctly.
|
4985
|
+
#
|
4986
|
+
# * **Invalid trusted host keys**: Verify that the trusted host key in
|
4987
|
+
# the connector configuration matches the `ssh-keyscan` output.
|
4988
|
+
# @return [String]
|
4989
|
+
#
|
4990
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestConnectionResponse AWS API Documentation
|
4991
|
+
#
|
4992
|
+
class TestConnectionResponse < Struct.new(
|
4993
|
+
:connector_id,
|
4994
|
+
:status,
|
4995
|
+
:status_message)
|
4996
|
+
SENSITIVE = []
|
4997
|
+
include Aws::Structure
|
4998
|
+
end
|
4999
|
+
|
4875
5000
|
# @!attribute [rw] server_id
|
4876
5001
|
# A system-assigned identifier for a specific server. That server's
|
4877
5002
|
# user authentication method is tested with a user name and password.
|
@@ -5266,11 +5391,12 @@ module Aws::Transfer
|
|
5266
5391
|
# @return [String]
|
5267
5392
|
#
|
5268
5393
|
# @!attribute [rw] url
|
5269
|
-
# The URL of the partner's AS2 endpoint.
|
5394
|
+
# The URL of the partner's AS2 or SFTP endpoint.
|
5270
5395
|
# @return [String]
|
5271
5396
|
#
|
5272
5397
|
# @!attribute [rw] as_2_config
|
5273
|
-
# A structure that contains the parameters for
|
5398
|
+
# A structure that contains the parameters for an AS2 connector
|
5399
|
+
# object.
|
5274
5400
|
# @return [Types::As2ConnectorConfig]
|
5275
5401
|
#
|
5276
5402
|
# @!attribute [rw] access_role
|
@@ -5302,6 +5428,11 @@ module Aws::Transfer
|
|
5302
5428
|
# CloudWatch logs.
|
5303
5429
|
# @return [String]
|
5304
5430
|
#
|
5431
|
+
# @!attribute [rw] sftp_config
|
5432
|
+
# A structure that contains the parameters for an SFTP connector
|
5433
|
+
# object.
|
5434
|
+
# @return [Types::SftpConnectorConfig]
|
5435
|
+
#
|
5305
5436
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateConnectorRequest AWS API Documentation
|
5306
5437
|
#
|
5307
5438
|
class UpdateConnectorRequest < Struct.new(
|
@@ -5309,7 +5440,8 @@ module Aws::Transfer
|
|
5309
5440
|
:url,
|
5310
5441
|
:as_2_config,
|
5311
5442
|
:access_role,
|
5312
|
-
:logging_role
|
5443
|
+
:logging_role,
|
5444
|
+
:sftp_config)
|
5313
5445
|
SENSITIVE = []
|
5314
5446
|
include Aws::Structure
|
5315
5447
|
end
|
data/lib/aws-sdk-transfer.rb
CHANGED
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.
|
4
|
+
version: 1.76.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: 2023-07-
|
11
|
+
date: 2023-07-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|