aws-sdk-transfer 1.57.0 → 1.59.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transfer/client.rb +263 -27
- data/lib/aws-sdk-transfer/client_api.rb +139 -0
- data/lib/aws-sdk-transfer/types.rb +484 -44
- data/lib/aws-sdk-transfer.rb +1 -1
- metadata +2 -2
@@ -42,15 +42,16 @@ module Aws::Transfer
|
|
42
42
|
# }
|
43
43
|
#
|
44
44
|
# @!attribute [rw] local_profile_id
|
45
|
-
# A unique identifier for the AS2
|
45
|
+
# A unique identifier for the AS2 local profile.
|
46
46
|
# @return [String]
|
47
47
|
#
|
48
48
|
# @!attribute [rw] partner_profile_id
|
49
|
-
# A unique identifier for the partner for the connector.
|
49
|
+
# A unique identifier for the partner profile for the connector.
|
50
50
|
# @return [String]
|
51
51
|
#
|
52
52
|
# @!attribute [rw] message_subject
|
53
|
-
#
|
53
|
+
# Used as the `Subject` HTTP header attribute in AS2 messages that are
|
54
|
+
# being sent with the connector.
|
54
55
|
# @return [String]
|
55
56
|
#
|
56
57
|
# @!attribute [rw] compression
|
@@ -62,12 +63,17 @@ module Aws::Transfer
|
|
62
63
|
# @return [String]
|
63
64
|
#
|
64
65
|
# @!attribute [rw] signing_algorithm
|
65
|
-
# The algorithm that is used to sign the AS2
|
66
|
-
#
|
66
|
+
# The algorithm that is used to sign the AS2 messages sent with the
|
67
|
+
# connector.
|
67
68
|
# @return [String]
|
68
69
|
#
|
69
70
|
# @!attribute [rw] mdn_signing_algorithm
|
70
71
|
# The signing algorithm for the MDN response.
|
72
|
+
#
|
73
|
+
# <note markdown="1"> If set to DEFAULT (or not set at all), the value for
|
74
|
+
# `SigningAlogorithm` is used.
|
75
|
+
#
|
76
|
+
# </note>
|
71
77
|
# @return [String]
|
72
78
|
#
|
73
79
|
# @!attribute [rw] mdn_response
|
@@ -390,9 +396,18 @@ module Aws::Transfer
|
|
390
396
|
# @return [String]
|
391
397
|
#
|
392
398
|
# @!attribute [rw] access_role
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
399
|
+
# With AS2, you can send files by calling `StartFileTransfer` and
|
400
|
+
# specifying the file paths in the request parameter, `SendFilePaths`.
|
401
|
+
# We use the file’s parent directory (for example, for
|
402
|
+
# `--send-file-paths /bucket/dir/file.txt`, parent directory is
|
403
|
+
# `/bucket/dir/`) to temporarily store a processed AS2 message file,
|
404
|
+
# store the MDN when we receive them from the partner, and write a
|
405
|
+
# final JSON file containing relevant metadata of the transmission.
|
406
|
+
# So, the `AccessRole` needs to provide read and write access to the
|
407
|
+
# parent directory of the file location used in the
|
408
|
+
# `StartFileTransfer` request. Additionally, you need to provide read
|
409
|
+
# and write access to the parent directory of the files that you
|
410
|
+
# intend to send with `StartFileTransfer`.
|
396
411
|
# @return [String]
|
397
412
|
#
|
398
413
|
# @!attribute [rw] status
|
@@ -534,12 +549,11 @@ module Aws::Transfer
|
|
534
549
|
# }
|
535
550
|
#
|
536
551
|
# @!attribute [rw] as_2_id
|
537
|
-
# The `As2Id` is the *AS2-name*, as defined in the
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
# spaces.
|
552
|
+
# The `As2Id` is the *AS2-name*, as defined in the [RFC 4130][1]. For
|
553
|
+
# inbound transfers, this is the `AS2-From` header for the AS2
|
554
|
+
# messages sent from the partner. For outbound connectors, this is the
|
555
|
+
# `AS2-To` header for the AS2 messages sent to the partner using the
|
556
|
+
# `StartFileTransfer` API operation. This ID cannot include spaces.
|
543
557
|
#
|
544
558
|
#
|
545
559
|
#
|
@@ -1426,6 +1440,32 @@ module Aws::Transfer
|
|
1426
1440
|
include Aws::Structure
|
1427
1441
|
end
|
1428
1442
|
|
1443
|
+
# @note When making an API call, you may pass DeleteHostKeyRequest
|
1444
|
+
# data as a hash:
|
1445
|
+
#
|
1446
|
+
# {
|
1447
|
+
# server_id: "ServerId", # required
|
1448
|
+
# host_key_id: "HostKeyId", # required
|
1449
|
+
# }
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] server_id
|
1452
|
+
# Provide the ID of the server that contains the host key that you are
|
1453
|
+
# deleting.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] host_key_id
|
1457
|
+
# The ID of the host key that you are deleting.
|
1458
|
+
# @return [String]
|
1459
|
+
#
|
1460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteHostKeyRequest AWS API Documentation
|
1461
|
+
#
|
1462
|
+
class DeleteHostKeyRequest < Struct.new(
|
1463
|
+
:server_id,
|
1464
|
+
:host_key_id)
|
1465
|
+
SENSITIVE = []
|
1466
|
+
include Aws::Structure
|
1467
|
+
end
|
1468
|
+
|
1429
1469
|
# @note When making an API call, you may pass DeleteProfileRequest
|
1430
1470
|
# data as a hash:
|
1431
1471
|
#
|
@@ -1783,6 +1823,44 @@ module Aws::Transfer
|
|
1783
1823
|
include Aws::Structure
|
1784
1824
|
end
|
1785
1825
|
|
1826
|
+
# @note When making an API call, you may pass DescribeHostKeyRequest
|
1827
|
+
# data as a hash:
|
1828
|
+
#
|
1829
|
+
# {
|
1830
|
+
# server_id: "ServerId", # required
|
1831
|
+
# host_key_id: "HostKeyId", # required
|
1832
|
+
# }
|
1833
|
+
#
|
1834
|
+
# @!attribute [rw] server_id
|
1835
|
+
# Provide the ID of the server that contains the host key that you
|
1836
|
+
# want described.
|
1837
|
+
# @return [String]
|
1838
|
+
#
|
1839
|
+
# @!attribute [rw] host_key_id
|
1840
|
+
# Provide the ID of the host key that you want described.
|
1841
|
+
# @return [String]
|
1842
|
+
#
|
1843
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeHostKeyRequest AWS API Documentation
|
1844
|
+
#
|
1845
|
+
class DescribeHostKeyRequest < Struct.new(
|
1846
|
+
:server_id,
|
1847
|
+
:host_key_id)
|
1848
|
+
SENSITIVE = []
|
1849
|
+
include Aws::Structure
|
1850
|
+
end
|
1851
|
+
|
1852
|
+
# @!attribute [rw] host_key
|
1853
|
+
# Returns the details for the specified host key.
|
1854
|
+
# @return [Types::DescribedHostKey]
|
1855
|
+
#
|
1856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeHostKeyResponse AWS API Documentation
|
1857
|
+
#
|
1858
|
+
class DescribeHostKeyResponse < Struct.new(
|
1859
|
+
:host_key)
|
1860
|
+
SENSITIVE = []
|
1861
|
+
include Aws::Structure
|
1862
|
+
end
|
1863
|
+
|
1786
1864
|
# @note When making an API call, you may pass DescribeProfileRequest
|
1787
1865
|
# data as a hash:
|
1788
1866
|
#
|
@@ -2081,11 +2159,11 @@ module Aws::Transfer
|
|
2081
2159
|
# @return [String]
|
2082
2160
|
#
|
2083
2161
|
# @!attribute [rw] local_profile_id
|
2084
|
-
# A unique identifier for the AS2
|
2162
|
+
# A unique identifier for the AS2 local profile.
|
2085
2163
|
# @return [String]
|
2086
2164
|
#
|
2087
2165
|
# @!attribute [rw] partner_profile_id
|
2088
|
-
# A unique identifier for the partner in the agreement.
|
2166
|
+
# A unique identifier for the partner profile used in the agreement.
|
2089
2167
|
# @return [String]
|
2090
2168
|
#
|
2091
2169
|
# @!attribute [rw] base_directory
|
@@ -2094,9 +2172,18 @@ module Aws::Transfer
|
|
2094
2172
|
# @return [String]
|
2095
2173
|
#
|
2096
2174
|
# @!attribute [rw] access_role
|
2097
|
-
#
|
2098
|
-
#
|
2099
|
-
#
|
2175
|
+
# With AS2, you can send files by calling `StartFileTransfer` and
|
2176
|
+
# specifying the file paths in the request parameter, `SendFilePaths`.
|
2177
|
+
# We use the file’s parent directory (for example, for
|
2178
|
+
# `--send-file-paths /bucket/dir/file.txt`, parent directory is
|
2179
|
+
# `/bucket/dir/`) to temporarily store a processed AS2 message file,
|
2180
|
+
# store the MDN when we receive them from the partner, and write a
|
2181
|
+
# final JSON file containing relevant metadata of the transmission.
|
2182
|
+
# So, the `AccessRole` needs to provide read and write access to the
|
2183
|
+
# parent directory of the file location used in the
|
2184
|
+
# `StartFileTransfer` request. Additionally, you need to provide read
|
2185
|
+
# and write access to the parent directory of the files that you
|
2186
|
+
# intend to send with `StartFileTransfer`.
|
2100
2187
|
# @return [String]
|
2101
2188
|
#
|
2102
2189
|
# @!attribute [rw] tags
|
@@ -2327,6 +2414,62 @@ module Aws::Transfer
|
|
2327
2414
|
include Aws::Structure
|
2328
2415
|
end
|
2329
2416
|
|
2417
|
+
# The details for a server host key.
|
2418
|
+
#
|
2419
|
+
# @!attribute [rw] arn
|
2420
|
+
# The unique Amazon Resource Name (ARN) for the host key.
|
2421
|
+
# @return [String]
|
2422
|
+
#
|
2423
|
+
# @!attribute [rw] host_key_id
|
2424
|
+
# A unique identifier for the host key.
|
2425
|
+
# @return [String]
|
2426
|
+
#
|
2427
|
+
# @!attribute [rw] host_key_fingerprint
|
2428
|
+
# The public key fingerprint, which is a short sequence of bytes used
|
2429
|
+
# to identify the longer public key.
|
2430
|
+
# @return [String]
|
2431
|
+
#
|
2432
|
+
# @!attribute [rw] description
|
2433
|
+
# The text description for this host key.
|
2434
|
+
# @return [String]
|
2435
|
+
#
|
2436
|
+
# @!attribute [rw] type
|
2437
|
+
# The encryption algorithm used for the host key. The `Type` is one of
|
2438
|
+
# the following values:
|
2439
|
+
#
|
2440
|
+
# * ssh-rsa
|
2441
|
+
#
|
2442
|
+
# * ssh-ed25519
|
2443
|
+
#
|
2444
|
+
# * ecdsa-sha2-nistp256
|
2445
|
+
#
|
2446
|
+
# * ecdsa-sha2-nistp384
|
2447
|
+
#
|
2448
|
+
# * ecdsa-sha2-nistp521
|
2449
|
+
# @return [String]
|
2450
|
+
#
|
2451
|
+
# @!attribute [rw] date_imported
|
2452
|
+
# The date on which the host key was added to the server.
|
2453
|
+
# @return [Time]
|
2454
|
+
#
|
2455
|
+
# @!attribute [rw] tags
|
2456
|
+
# Key-value pairs that can be used to group and search for host keys.
|
2457
|
+
# @return [Array<Types::Tag>]
|
2458
|
+
#
|
2459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedHostKey AWS API Documentation
|
2460
|
+
#
|
2461
|
+
class DescribedHostKey < Struct.new(
|
2462
|
+
:arn,
|
2463
|
+
:host_key_id,
|
2464
|
+
:host_key_fingerprint,
|
2465
|
+
:description,
|
2466
|
+
:type,
|
2467
|
+
:date_imported,
|
2468
|
+
:tags)
|
2469
|
+
SENSITIVE = []
|
2470
|
+
include Aws::Structure
|
2471
|
+
end
|
2472
|
+
|
2330
2473
|
# The details for a local or partner AS2 profile. profile.
|
2331
2474
|
#
|
2332
2475
|
# @!attribute [rw] arn
|
@@ -2344,7 +2487,15 @@ module Aws::Transfer
|
|
2344
2487
|
# @return [String]
|
2345
2488
|
#
|
2346
2489
|
# @!attribute [rw] as_2_id
|
2347
|
-
# The
|
2490
|
+
# The `As2Id` is the *AS2-name*, as defined in the [RFC 4130][1]. For
|
2491
|
+
# inbound transfers, this is the `AS2-From` header for the AS2
|
2492
|
+
# messages sent from the partner. For outbound connectors, this is the
|
2493
|
+
# `AS2-To` header for the AS2 messages sent to the partner using the
|
2494
|
+
# `StartFileTransfer` API operation. This ID cannot include spaces.
|
2495
|
+
#
|
2496
|
+
#
|
2497
|
+
#
|
2498
|
+
# [1]: https://datatracker.ietf.org/doc/html/rfc4130
|
2348
2499
|
# @return [String]
|
2349
2500
|
#
|
2350
2501
|
# @!attribute [rw] certificate_ids
|
@@ -2437,9 +2588,27 @@ module Aws::Transfer
|
|
2437
2588
|
# @!attribute [rw] protocol_details
|
2438
2589
|
# The protocol settings that are configured for your server.
|
2439
2590
|
#
|
2440
|
-
#
|
2441
|
-
#
|
2442
|
-
#
|
2591
|
+
# * To indicate passive mode (for FTP and FTPS protocols), use the
|
2592
|
+
# `PassiveIp` parameter. Enter a single dotted-quad IPv4 address,
|
2593
|
+
# such as the external IP address of a firewall, router, or load
|
2594
|
+
# balancer.
|
2595
|
+
#
|
2596
|
+
# * To ignore the error that is generated when the client attempts to
|
2597
|
+
# use the `SETSTAT` command on a file that you are uploading to an
|
2598
|
+
# Amazon S3 bucket, use the `SetStatOption` parameter. To have the
|
2599
|
+
# Transfer Family server ignore the `SETSTAT` command and upload
|
2600
|
+
# files without needing to make any changes to your SFTP client, set
|
2601
|
+
# the value to `ENABLE_NO_OP`. If you set the `SetStatOption`
|
2602
|
+
# parameter to `ENABLE_NO_OP`, Transfer Family generates a log entry
|
2603
|
+
# to Amazon CloudWatch Logs, so that you can determine when the
|
2604
|
+
# client is making a `SETSTAT` call.
|
2605
|
+
#
|
2606
|
+
# * To determine whether your Transfer Family server resumes recent,
|
2607
|
+
# negotiated sessions through a unique session ID, use the
|
2608
|
+
# `TlsSessionResumptionMode` parameter.
|
2609
|
+
#
|
2610
|
+
# * `As2Transports` indicates the transport method for the AS2
|
2611
|
+
# messages. Currently, only HTTP is supported.
|
2443
2612
|
# @return [Types::ProtocolDetails]
|
2444
2613
|
#
|
2445
2614
|
# @!attribute [rw] domain
|
@@ -2537,6 +2706,29 @@ module Aws::Transfer
|
|
2537
2706
|
# encryption
|
2538
2707
|
#
|
2539
2708
|
# * `FTP` (File Transfer Protocol): Unencrypted file transfer
|
2709
|
+
#
|
2710
|
+
# * `AS2` (Applicability Statement 2): used for transporting
|
2711
|
+
# structured business-to-business data
|
2712
|
+
#
|
2713
|
+
# <note markdown="1"> * If you select `FTPS`, you must choose a certificate stored in
|
2714
|
+
# Certificate Manager (ACM) which is used to identify your server
|
2715
|
+
# when clients connect to it over FTPS.
|
2716
|
+
#
|
2717
|
+
# * If `Protocol` includes either `FTP` or `FTPS`, then the
|
2718
|
+
# `EndpointType` must be `VPC` and the `IdentityProviderType` must
|
2719
|
+
# be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
|
2720
|
+
#
|
2721
|
+
# * If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot
|
2722
|
+
# be associated.
|
2723
|
+
#
|
2724
|
+
# * If `Protocol` is set only to `SFTP`, the `EndpointType` can be set
|
2725
|
+
# to `PUBLIC` and the `IdentityProviderType` can be set to
|
2726
|
+
# `SERVICE_MANAGED`.
|
2727
|
+
#
|
2728
|
+
# * If `Protocol` includes `AS2`, then the `EndpointType` must be
|
2729
|
+
# `VPC`, and domain must be Amazon S3.
|
2730
|
+
#
|
2731
|
+
# </note>
|
2540
2732
|
# @return [Array<String>]
|
2541
2733
|
#
|
2542
2734
|
# @!attribute [rw] security_policy_name
|
@@ -3164,6 +3356,68 @@ module Aws::Transfer
|
|
3164
3356
|
include Aws::Structure
|
3165
3357
|
end
|
3166
3358
|
|
3359
|
+
# @note When making an API call, you may pass ImportHostKeyRequest
|
3360
|
+
# data as a hash:
|
3361
|
+
#
|
3362
|
+
# {
|
3363
|
+
# server_id: "ServerId", # required
|
3364
|
+
# host_key_body: "HostKey", # required
|
3365
|
+
# description: "HostKeyDescription",
|
3366
|
+
# tags: [
|
3367
|
+
# {
|
3368
|
+
# key: "TagKey", # required
|
3369
|
+
# value: "TagValue", # required
|
3370
|
+
# },
|
3371
|
+
# ],
|
3372
|
+
# }
|
3373
|
+
#
|
3374
|
+
# @!attribute [rw] server_id
|
3375
|
+
# Provide the ID of the server that contains the host key that you are
|
3376
|
+
# importing.
|
3377
|
+
# @return [String]
|
3378
|
+
#
|
3379
|
+
# @!attribute [rw] host_key_body
|
3380
|
+
# The public key portion of an SSH key pair.
|
3381
|
+
#
|
3382
|
+
# Transfer Family accepts RSA, ECDSA, and ED25519 keys.
|
3383
|
+
# @return [String]
|
3384
|
+
#
|
3385
|
+
# @!attribute [rw] description
|
3386
|
+
# Enter a text description to identify this host key.
|
3387
|
+
# @return [String]
|
3388
|
+
#
|
3389
|
+
# @!attribute [rw] tags
|
3390
|
+
# Key-value pairs that can be used to group and search for host keys.
|
3391
|
+
# @return [Array<Types::Tag>]
|
3392
|
+
#
|
3393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportHostKeyRequest AWS API Documentation
|
3394
|
+
#
|
3395
|
+
class ImportHostKeyRequest < Struct.new(
|
3396
|
+
:server_id,
|
3397
|
+
:host_key_body,
|
3398
|
+
:description,
|
3399
|
+
:tags)
|
3400
|
+
SENSITIVE = [:host_key_body]
|
3401
|
+
include Aws::Structure
|
3402
|
+
end
|
3403
|
+
|
3404
|
+
# @!attribute [rw] server_id
|
3405
|
+
# Returns the server ID that contains the imported key.
|
3406
|
+
# @return [String]
|
3407
|
+
#
|
3408
|
+
# @!attribute [rw] host_key_id
|
3409
|
+
# Returns the host key ID for the imported key.
|
3410
|
+
# @return [String]
|
3411
|
+
#
|
3412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportHostKeyResponse AWS API Documentation
|
3413
|
+
#
|
3414
|
+
class ImportHostKeyResponse < Struct.new(
|
3415
|
+
:server_id,
|
3416
|
+
:host_key_id)
|
3417
|
+
SENSITIVE = []
|
3418
|
+
include Aws::Structure
|
3419
|
+
end
|
3420
|
+
|
3167
3421
|
# @note When making an API call, you may pass ImportSshPublicKeyRequest
|
3168
3422
|
# data as a hash:
|
3169
3423
|
#
|
@@ -3594,6 +3848,64 @@ module Aws::Transfer
|
|
3594
3848
|
include Aws::Structure
|
3595
3849
|
end
|
3596
3850
|
|
3851
|
+
# @note When making an API call, you may pass ListHostKeysRequest
|
3852
|
+
# data as a hash:
|
3853
|
+
#
|
3854
|
+
# {
|
3855
|
+
# max_results: 1,
|
3856
|
+
# next_token: "NextToken",
|
3857
|
+
# server_id: "ServerId", # required
|
3858
|
+
# }
|
3859
|
+
#
|
3860
|
+
# @!attribute [rw] max_results
|
3861
|
+
# The maximum number of host keys to return.
|
3862
|
+
# @return [Integer]
|
3863
|
+
#
|
3864
|
+
# @!attribute [rw] next_token
|
3865
|
+
# When there are additional results that were not returned, a
|
3866
|
+
# `NextToken` parameter is returned. You can use that value for a
|
3867
|
+
# subsequent call to `ListHostKeys` to continue listing results.
|
3868
|
+
# @return [String]
|
3869
|
+
#
|
3870
|
+
# @!attribute [rw] server_id
|
3871
|
+
# Provide the ID of the server that contains the host keys that you
|
3872
|
+
# want to view.
|
3873
|
+
# @return [String]
|
3874
|
+
#
|
3875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListHostKeysRequest AWS API Documentation
|
3876
|
+
#
|
3877
|
+
class ListHostKeysRequest < Struct.new(
|
3878
|
+
:max_results,
|
3879
|
+
:next_token,
|
3880
|
+
:server_id)
|
3881
|
+
SENSITIVE = []
|
3882
|
+
include Aws::Structure
|
3883
|
+
end
|
3884
|
+
|
3885
|
+
# @!attribute [rw] next_token
|
3886
|
+
# Returns a token that you can use to call `ListHostKeys` again and
|
3887
|
+
# receive additional results, if there are any.
|
3888
|
+
# @return [String]
|
3889
|
+
#
|
3890
|
+
# @!attribute [rw] server_id
|
3891
|
+
# Returns the server ID that contains the listed host keys.
|
3892
|
+
# @return [String]
|
3893
|
+
#
|
3894
|
+
# @!attribute [rw] host_keys
|
3895
|
+
# Returns an array, where each item contains the details of a host
|
3896
|
+
# key.
|
3897
|
+
# @return [Array<Types::ListedHostKey>]
|
3898
|
+
#
|
3899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListHostKeysResponse AWS API Documentation
|
3900
|
+
#
|
3901
|
+
class ListHostKeysResponse < Struct.new(
|
3902
|
+
:next_token,
|
3903
|
+
:server_id,
|
3904
|
+
:host_keys)
|
3905
|
+
SENSITIVE = []
|
3906
|
+
include Aws::Structure
|
3907
|
+
end
|
3908
|
+
|
3597
3909
|
# @note When making an API call, you may pass ListProfilesRequest
|
3598
3910
|
# data as a hash:
|
3599
3911
|
#
|
@@ -4006,11 +4318,11 @@ module Aws::Transfer
|
|
4006
4318
|
# @return [String]
|
4007
4319
|
#
|
4008
4320
|
# @!attribute [rw] local_profile_id
|
4009
|
-
# A unique identifier for the AS2
|
4321
|
+
# A unique identifier for the AS2 local profile.
|
4010
4322
|
# @return [String]
|
4011
4323
|
#
|
4012
4324
|
# @!attribute [rw] partner_profile_id
|
4013
|
-
# A unique identifier for the partner
|
4325
|
+
# A unique identifier for the partner profile.
|
4014
4326
|
# @return [String]
|
4015
4327
|
#
|
4016
4328
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedAgreement AWS API Documentation
|
@@ -4142,6 +4454,58 @@ module Aws::Transfer
|
|
4142
4454
|
include Aws::Structure
|
4143
4455
|
end
|
4144
4456
|
|
4457
|
+
# Returns properties of the host key that is specified.
|
4458
|
+
#
|
4459
|
+
# @!attribute [rw] arn
|
4460
|
+
# Specifies the unique Amazon Resource Name (ARN) of the host key.
|
4461
|
+
# @return [String]
|
4462
|
+
#
|
4463
|
+
# @!attribute [rw] host_key_id
|
4464
|
+
# @return [String]
|
4465
|
+
#
|
4466
|
+
# @!attribute [rw] fingerprint
|
4467
|
+
# The public key fingerprint, which is a short sequence of bytes used
|
4468
|
+
# to identify the longer public key.
|
4469
|
+
# @return [String]
|
4470
|
+
#
|
4471
|
+
# @!attribute [rw] description
|
4472
|
+
# The current description for the host key. You can change it by
|
4473
|
+
# calling the `UpdateHostKey` operation and providing a new
|
4474
|
+
# description.
|
4475
|
+
# @return [String]
|
4476
|
+
#
|
4477
|
+
# @!attribute [rw] type
|
4478
|
+
# The encryption algorithm used for the host key. The `Type` is one of
|
4479
|
+
# the following values:
|
4480
|
+
#
|
4481
|
+
# * ssh-rsa
|
4482
|
+
#
|
4483
|
+
# * ssh-ed25519
|
4484
|
+
#
|
4485
|
+
# * ecdsa-sha2-nistp256
|
4486
|
+
#
|
4487
|
+
# * ecdsa-sha2-nistp384
|
4488
|
+
#
|
4489
|
+
# * ecdsa-sha2-nistp521
|
4490
|
+
# @return [String]
|
4491
|
+
#
|
4492
|
+
# @!attribute [rw] date_imported
|
4493
|
+
# The date on which the host key was added to the server.
|
4494
|
+
# @return [Time]
|
4495
|
+
#
|
4496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedHostKey AWS API Documentation
|
4497
|
+
#
|
4498
|
+
class ListedHostKey < Struct.new(
|
4499
|
+
:arn,
|
4500
|
+
:host_key_id,
|
4501
|
+
:fingerprint,
|
4502
|
+
:description,
|
4503
|
+
:type,
|
4504
|
+
:date_imported)
|
4505
|
+
SENSITIVE = []
|
4506
|
+
include Aws::Structure
|
4507
|
+
end
|
4508
|
+
|
4145
4509
|
# Returns the properties of the profile that was specified.
|
4146
4510
|
#
|
4147
4511
|
# @!attribute [rw] arn
|
@@ -4153,7 +4517,15 @@ module Aws::Transfer
|
|
4153
4517
|
# @return [String]
|
4154
4518
|
#
|
4155
4519
|
# @!attribute [rw] as_2_id
|
4156
|
-
# The
|
4520
|
+
# The `As2Id` is the *AS2-name*, as defined in the [RFC 4130][1]. For
|
4521
|
+
# inbound transfers, this is the `AS2-From` header for the AS2
|
4522
|
+
# messages sent from the partner. For outbound connectors, this is the
|
4523
|
+
# `AS2-To` header for the AS2 messages sent to the partner using the
|
4524
|
+
# `StartFileTransfer` API operation. This ID cannot include spaces.
|
4525
|
+
#
|
4526
|
+
#
|
4527
|
+
#
|
4528
|
+
# [1]: https://datatracker.ietf.org/doc/html/rfc4130
|
4157
4529
|
# @return [String]
|
4158
4530
|
#
|
4159
4531
|
# @!attribute [rw] profile_type
|
@@ -5306,11 +5678,14 @@ module Aws::Transfer
|
|
5306
5678
|
# @return [String]
|
5307
5679
|
#
|
5308
5680
|
# @!attribute [rw] local_profile_id
|
5681
|
+
# A unique identifier for the AS2 local profile.
|
5682
|
+
#
|
5309
5683
|
# To change the local profile identifier, provide a new value here.
|
5310
5684
|
# @return [String]
|
5311
5685
|
#
|
5312
5686
|
# @!attribute [rw] partner_profile_id
|
5313
|
-
#
|
5687
|
+
# A unique identifier for the partner profile. To change the partner
|
5688
|
+
# profile identifier, provide a new value here.
|
5314
5689
|
# @return [String]
|
5315
5690
|
#
|
5316
5691
|
# @!attribute [rw] base_directory
|
@@ -5320,9 +5695,18 @@ module Aws::Transfer
|
|
5320
5695
|
# @return [String]
|
5321
5696
|
#
|
5322
5697
|
# @!attribute [rw] access_role
|
5323
|
-
#
|
5324
|
-
#
|
5325
|
-
#
|
5698
|
+
# With AS2, you can send files by calling `StartFileTransfer` and
|
5699
|
+
# specifying the file paths in the request parameter, `SendFilePaths`.
|
5700
|
+
# We use the file’s parent directory (for example, for
|
5701
|
+
# `--send-file-paths /bucket/dir/file.txt`, parent directory is
|
5702
|
+
# `/bucket/dir/`) to temporarily store a processed AS2 message file,
|
5703
|
+
# store the MDN when we receive them from the partner, and write a
|
5704
|
+
# final JSON file containing relevant metadata of the transmission.
|
5705
|
+
# So, the `AccessRole` needs to provide read and write access to the
|
5706
|
+
# parent directory of the file location used in the
|
5707
|
+
# `StartFileTransfer` request. Additionally, you need to provide read
|
5708
|
+
# and write access to the parent directory of the files that you
|
5709
|
+
# intend to send with `StartFileTransfer`.
|
5326
5710
|
# @return [String]
|
5327
5711
|
#
|
5328
5712
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateAgreementRequest AWS API Documentation
|
@@ -5483,6 +5867,56 @@ module Aws::Transfer
|
|
5483
5867
|
include Aws::Structure
|
5484
5868
|
end
|
5485
5869
|
|
5870
|
+
# @note When making an API call, you may pass UpdateHostKeyRequest
|
5871
|
+
# data as a hash:
|
5872
|
+
#
|
5873
|
+
# {
|
5874
|
+
# server_id: "ServerId", # required
|
5875
|
+
# host_key_id: "HostKeyId", # required
|
5876
|
+
# description: "HostKeyDescription", # required
|
5877
|
+
# }
|
5878
|
+
#
|
5879
|
+
# @!attribute [rw] server_id
|
5880
|
+
# Provide the ID of the server that contains the host key that you are
|
5881
|
+
# updating.
|
5882
|
+
# @return [String]
|
5883
|
+
#
|
5884
|
+
# @!attribute [rw] host_key_id
|
5885
|
+
# Provide the ID of the host key that you are updating.
|
5886
|
+
# @return [String]
|
5887
|
+
#
|
5888
|
+
# @!attribute [rw] description
|
5889
|
+
# Provide an updated description for the host key.
|
5890
|
+
# @return [String]
|
5891
|
+
#
|
5892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateHostKeyRequest AWS API Documentation
|
5893
|
+
#
|
5894
|
+
class UpdateHostKeyRequest < Struct.new(
|
5895
|
+
:server_id,
|
5896
|
+
:host_key_id,
|
5897
|
+
:description)
|
5898
|
+
SENSITIVE = []
|
5899
|
+
include Aws::Structure
|
5900
|
+
end
|
5901
|
+
|
5902
|
+
# @!attribute [rw] server_id
|
5903
|
+
# Returns the server ID for the server that contains the updated host
|
5904
|
+
# key.
|
5905
|
+
# @return [String]
|
5906
|
+
#
|
5907
|
+
# @!attribute [rw] host_key_id
|
5908
|
+
# Returns the host key ID for the updated host key.
|
5909
|
+
# @return [String]
|
5910
|
+
#
|
5911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateHostKeyResponse AWS API Documentation
|
5912
|
+
#
|
5913
|
+
class UpdateHostKeyResponse < Struct.new(
|
5914
|
+
:server_id,
|
5915
|
+
:host_key_id)
|
5916
|
+
SENSITIVE = []
|
5917
|
+
include Aws::Structure
|
5918
|
+
end
|
5919
|
+
|
5486
5920
|
# @note When making an API call, you may pass UpdateProfileRequest
|
5487
5921
|
# data as a hash:
|
5488
5922
|
#
|
@@ -5744,28 +6178,34 @@ module Aws::Transfer
|
|
5744
6178
|
# file transfer protocol client can connect to your server's
|
5745
6179
|
# endpoint. The available protocols are:
|
5746
6180
|
#
|
5747
|
-
# * Secure Shell (SSH) File Transfer Protocol
|
6181
|
+
# * `SFTP` (Secure Shell (SSH) File Transfer Protocol): File transfer
|
5748
6182
|
# over SSH
|
5749
6183
|
#
|
5750
|
-
# * File Transfer Protocol Secure
|
6184
|
+
# * `FTPS` (File Transfer Protocol Secure): File transfer with TLS
|
5751
6185
|
# encryption
|
5752
6186
|
#
|
5753
|
-
# * File Transfer Protocol
|
6187
|
+
# * `FTP` (File Transfer Protocol): Unencrypted file transfer
|
5754
6188
|
#
|
5755
|
-
#
|
5756
|
-
#
|
5757
|
-
# your server when clients connect to it over FTPS.
|
6189
|
+
# * `AS2` (Applicability Statement 2): used for transporting
|
6190
|
+
# structured business-to-business data
|
5758
6191
|
#
|
5759
|
-
#
|
5760
|
-
#
|
5761
|
-
#
|
6192
|
+
# <note markdown="1"> * If you select `FTPS`, you must choose a certificate stored in
|
6193
|
+
# Certificate Manager (ACM) which is used to identify your server
|
6194
|
+
# when clients connect to it over FTPS.
|
5762
6195
|
#
|
5763
|
-
#
|
5764
|
-
#
|
6196
|
+
# * If `Protocol` includes either `FTP` or `FTPS`, then the
|
6197
|
+
# `EndpointType` must be `VPC` and the `IdentityProviderType` must
|
6198
|
+
# be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
|
6199
|
+
#
|
6200
|
+
# * If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot
|
6201
|
+
# be associated.
|
6202
|
+
#
|
6203
|
+
# * If `Protocol` is set only to `SFTP`, the `EndpointType` can be set
|
6204
|
+
# to `PUBLIC` and the `IdentityProviderType` can be set to
|
6205
|
+
# `SERVICE_MANAGED`.
|
5765
6206
|
#
|
5766
|
-
#
|
5767
|
-
#
|
5768
|
-
# `SERVICE_MANAGED`.
|
6207
|
+
# * If `Protocol` includes `AS2`, then the `EndpointType` must be
|
6208
|
+
# `VPC`, and domain must be Amazon S3.
|
5769
6209
|
#
|
5770
6210
|
# </note>
|
5771
6211
|
# @return [Array<String>]
|