@aws-sdk/client-transfer 3.154.0 → 3.157.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.
Files changed (6) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +2 -1
  3. package/dist-types/Transfer.d.ts +2 -1
  4. package/dist-types/TransferClient.d.ts +2 -1
  5. package/dist-types/models/models_0.d.ts +148 -47
  6. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.157.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.156.0...v3.157.0) (2022-08-24)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-transfer
9
+
10
+
11
+
12
+
13
+
6
14
  # [3.154.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.153.0...v3.154.0) (2022-08-19)
7
15
 
8
16
  **Note:** Version bump only for package @aws-sdk/client-transfer
package/README.md CHANGED
@@ -11,7 +11,8 @@ AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native.
11
11
 
12
12
  <p>Transfer Family is a fully managed service that enables the transfer of files over the File
13
13
  Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
14
- Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3).
14
+ Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
15
+ Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
15
16
  Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
16
17
  with existing authentication systems, and providing DNS routing with Amazon Route 53 so
17
18
  nothing changes for your customers and partners, or their applications. With your data in
package/dist-types/Transfer.d.ts CHANGED
@@ -56,7 +56,8 @@ import { TransferClient } from "./TransferClient";
56
56
  /**
57
57
  * <p>Transfer Family is a fully managed service that enables the transfer of files over the File
58
58
  * Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
59
- * Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3).
59
+ * Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
60
+ * Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
60
61
  * Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
61
62
  * with existing authentication systems, and providing DNS routing with Amazon Route 53 so
62
63
  * nothing changes for your customers and partners, or their applications. With your data in
package/dist-types/TransferClient.d.ts CHANGED
@@ -181,7 +181,8 @@ export interface TransferClientResolvedConfig extends TransferClientResolvedConf
181
181
  /**
182
182
  * <p>Transfer Family is a fully managed service that enables the transfer of files over the File
183
183
  * Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File
184
- * Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3).
184
+ * Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
185
+ * Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.
185
186
  * Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating
186
187
  * with existing authentication systems, and providing DNS routing with Amazon Route 53 so
187
188
  * nothing changes for your customers and partners, or their applications. With your data in
package/dist-types/models/models_0.d.ts CHANGED
@@ -50,15 +50,15 @@ export declare enum SigningAlg {
50
50
  */
51
51
  export interface As2ConnectorConfig {
52
52
  /**
53
- * <p>A unique identifier for the AS2 process.</p>
53
+ * <p>A unique identifier for the AS2 local profile.</p>
54
54
  */
55
55
  LocalProfileId?: string;
56
56
  /**
57
- * <p>A unique identifier for the partner for the connector.</p>
57
+ * <p>A unique identifier for the partner profile for the connector.</p>
58
58
  */
59
59
  PartnerProfileId?: string;
60
60
  /**
61
- * <p>A short description to help identify the connector.</p>
61
+ * <p>Used as the <code>Subject</code> HTTP header attribute in AS2 messages that are being sent with the connector.</p>
62
62
  */
63
63
  MessageSubject?: string;
64
64
  /**
@@ -70,11 +70,14 @@ export interface As2ConnectorConfig {
70
70
  */
71
71
  EncryptionAlgorithm?: EncryptionAlg | string;
72
72
  /**
73
- * <p>The algorithm that is used to sign the AS2 transfers for this partner profile.</p>
73
+ * <p>The algorithm that is used to sign the AS2 messages sent with the connector.</p>
74
74
  */
75
75
  SigningAlgorithm?: SigningAlg | string;
76
76
  /**
77
77
  * <p>The signing algorithm for the MDN response.</p>
78
+ * <note>
79
+ * <p>If set to DEFAULT (or not set at all), the value for <code>SigningAlogorithm</code> is used.</p>
80
+ * </note>
78
81
  */
79
82
  MdnSigningAlgorithm?: MdnSigningAlg | string;
80
83
  /**
@@ -465,8 +468,16 @@ export interface CreateAgreementRequest {
465
468
  */
466
469
  BaseDirectory: string | undefined;
467
470
  /**
468
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the
469
- * <code>HomeDirectory</code> of your users' Amazon S3 buckets.</p>
471
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
472
+ * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
473
+ * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
474
+ * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
475
+ * store the MDN when we receive them from the partner, and write a final JSON file containing
476
+ * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
477
+ * and write access to the parent directory of the file location used in the
478
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
479
+ * access to the parent directory of the files that you intend to send with
480
+ * <code>StartFileTransfer</code>.</p>
470
481
  */
471
482
  AccessRole: string | undefined;
472
483
  /**
@@ -532,8 +543,8 @@ export declare enum ProfileType {
532
543
  }
533
544
  export interface CreateProfileRequest {
534
545
  /**
535
- * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the defined in
536
- * the <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages
546
+ * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
547
+ * <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages
537
548
  * sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the
538
549
  * AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>
539
550
  */
@@ -954,7 +965,6 @@ export interface CreateServerRequest {
954
965
  /**
955
966
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
956
967
  * client can connect to your server's endpoint. The available protocols are:</p>
957
- *
958
968
  * <ul>
959
969
  * <li>
960
970
  * <p>
@@ -1633,11 +1643,11 @@ export interface DescribedAgreement {
1633
1643
  */
1634
1644
  ServerId?: string;
1635
1645
  /**
1636
- * <p>A unique identifier for the AS2 process.</p>
1646
+ * <p>A unique identifier for the AS2 local profile.</p>
1637
1647
  */
1638
1648
  LocalProfileId?: string;
1639
1649
  /**
1640
- * <p>A unique identifier for the partner in the agreement.</p>
1650
+ * <p>A unique identifier for the partner profile used in the agreement.</p>
1641
1651
  */
1642
1652
  PartnerProfileId?: string;
1643
1653
  /**
@@ -1646,8 +1656,16 @@ export interface DescribedAgreement {
1646
1656
  */
1647
1657
  BaseDirectory?: string;
1648
1658
  /**
1649
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the
1650
- * <code>HomeDirectory</code> of your users' Amazon S3 buckets.</p>
1659
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
1660
+ * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
1661
+ * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
1662
+ * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
1663
+ * store the MDN when we receive them from the partner, and write a final JSON file containing
1664
+ * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
1665
+ * and write access to the parent directory of the file location used in the
1666
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
1667
+ * access to the parent directory of the files that you intend to send with
1668
+ * <code>StartFileTransfer</code>.</p>
1651
1669
  */
1652
1670
  AccessRole?: string;
1653
1671
  /**
@@ -2055,7 +2073,10 @@ export interface DescribedProfile {
2055
2073
  */
2056
2074
  ProfileType?: ProfileType | string;
2057
2075
  /**
2058
- * <p>The unique identifier for the AS2 process.</p>
2076
+ * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
2077
+ * <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages
2078
+ * sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the
2079
+ * AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>
2059
2080
  */
2060
2081
  As2Id?: string;
2061
2082
  /**
@@ -2126,13 +2147,31 @@ export interface DescribedServer {
2126
2147
  */
2127
2148
  Certificate?: string;
2128
2149
  /**
2129
- * <p>
2130
- * The protocol settings that are configured for your server.
2131
- * </p>
2132
- * <p>
2133
- * Use the <code>PassiveIp</code> parameter to indicate passive mode.
2134
- * Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.
2135
- * </p>
2150
+ * <p>The protocol settings that are configured for your server.</p>
2151
+ * <ul>
2152
+ * <li>
2153
+ * <p>
2154
+ * To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter.
2155
+ * Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
2156
+ * </p>
2157
+ * </li>
2158
+ * <li>
2159
+ * <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are
2160
+ * uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the
2161
+ * <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to
2162
+ * <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family
2163
+ * generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code>
2164
+ * call.</p>
2165
+ * </li>
2166
+ * <li>
2167
+ * <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
2168
+ * <code>TlsSessionResumptionMode</code> parameter.</p>
2169
+ * </li>
2170
+ * <li>
2171
+ * <p>
2172
+ * <code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p>
2173
+ * </li>
2174
+ * </ul>
2136
2175
  */
2137
2176
  ProtocolDetails?: ProtocolDetails;
2138
2177
  /**
@@ -2207,7 +2246,6 @@ export interface DescribedServer {
2207
2246
  /**
2208
2247
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
2209
2248
  * client can connect to your server's endpoint. The available protocols are:</p>
2210
- *
2211
2249
  * <ul>
2212
2250
  * <li>
2213
2251
  * <p>
@@ -2223,7 +2261,39 @@ export interface DescribedServer {
2223
2261
  * <p>
2224
2262
  * <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>
2225
2263
  * </li>
2264
+ * <li>
2265
+ * <p>
2266
+ * <code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p>
2267
+ * </li>
2226
2268
  * </ul>
2269
+ *
2270
+ * <note>
2271
+ * <ul>
2272
+ * <li>
2273
+ * <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM)
2274
+ * which is used to identify your server when clients connect to it over
2275
+ * FTPS.</p>
2276
+ * </li>
2277
+ * <li>
2278
+ * <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the
2279
+ * <code>EndpointType</code> must be <code>VPC</code> and the
2280
+ * <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>
2281
+ * </li>
2282
+ * <li>
2283
+ * <p>If <code>Protocol</code> includes <code>FTP</code>, then
2284
+ * <code>AddressAllocationIds</code> cannot be associated.</p>
2285
+ * </li>
2286
+ * <li>
2287
+ * <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>
2288
+ * can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to
2289
+ * <code>SERVICE_MANAGED</code>.</p>
2290
+ * </li>
2291
+ * <li>
2292
+ * <p>If <code>Protocol</code> includes <code>AS2</code>, then the
2293
+ * <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p>
2294
+ * </li>
2295
+ * </ul>
2296
+ * </note>
2227
2297
  */
2228
2298
  Protocols?: (Protocol | string)[];
2229
2299
  /**
@@ -2686,11 +2756,11 @@ export interface ListedAgreement {
2686
2756
  */
2687
2757
  ServerId?: string;
2688
2758
  /**
2689
- * <p>A unique identifier for the AS2 process.</p>
2759
+ * <p>A unique identifier for the AS2 local profile.</p>
2690
2760
  */
2691
2761
  LocalProfileId?: string;
2692
2762
  /**
2693
- * <p>A unique identifier for the partner process.</p>
2763
+ * <p>A unique identifier for the partner profile.</p>
2694
2764
  */
2695
2765
  PartnerProfileId?: string;
2696
2766
  }
@@ -2847,7 +2917,10 @@ export interface ListedProfile {
2847
2917
  */
2848
2918
  ProfileId?: string;
2849
2919
  /**
2850
- * <p>The unique identifier for the AS2 process.</p>
2920
+ * <p>The <code>As2Id</code> is the <i>AS2-name</i>, as defined in the
2921
+ * <a href="https://datatracker.ietf.org/doc/html/rfc4130">RFC 4130</a>. For inbound transfers, this is the <code>AS2-From</code> header for the AS2 messages
2922
+ * sent from the partner. For outbound connectors, this is the <code>AS2-To</code> header for the
2923
+ * AS2 messages sent to the partner using the <code>StartFileTransfer</code> API operation. This ID cannot include spaces.</p>
2851
2924
  */
2852
2925
  As2Id?: string;
2853
2926
  /**
@@ -3484,12 +3557,14 @@ export interface UpdateAgreementRequest {
3484
3557
  */
3485
3558
  Status?: AgreementStatusType | string;
3486
3559
  /**
3487
- * <p>To change the local profile identifier, provide a new value
3560
+ * <p>A unique identifier for the AS2 local profile.</p>
3561
+ * <p>To change the local profile identifier, provide a new value
3488
3562
  * here.</p>
3489
3563
  */
3490
3564
  LocalProfileId?: string;
3491
3565
  /**
3492
- * <p>To change the partner profile identifier, provide a new value here.</p>
3566
+ * <p>A unique identifier for the partner profile.
3567
+ * To change the partner profile identifier, provide a new value here.</p>
3493
3568
  */
3494
3569
  PartnerProfileId?: string;
3495
3570
  /**
@@ -3500,8 +3575,16 @@ export interface UpdateAgreementRequest {
3500
3575
  */
3501
3576
  BaseDirectory?: string;
3502
3577
  /**
3503
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the
3504
- * <code>HomeDirectory</code> of your users' Amazon S3 buckets.</p>
3578
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
3579
+ * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
3580
+ * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
3581
+ * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
3582
+ * store the MDN when we receive them from the partner, and write a final JSON file containing
3583
+ * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
3584
+ * and write access to the parent directory of the file location used in the
3585
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
3586
+ * access to the parent directory of the files that you intend to send with
3587
+ * <code>StartFileTransfer</code>.</p>
3505
3588
  */
3506
3589
  AccessRole?: string;
3507
3590
  }
@@ -3752,35 +3835,53 @@ export interface UpdateServerRequest {
3752
3835
  /**
3753
3836
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
3754
3837
  * client can connect to your server's endpoint. The available protocols are:</p>
3755
- *
3756
3838
  * <ul>
3757
3839
  * <li>
3758
- * <p>Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH</p>
3840
+ * <p>
3841
+ * <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over
3842
+ * SSH</p>
3759
3843
  * </li>
3760
3844
  * <li>
3761
- * <p>File Transfer Protocol Secure (FTPS): File transfer with TLS encryption</p>
3845
+ * <p>
3846
+ * <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS
3847
+ * encryption</p>
3762
3848
  * </li>
3763
3849
  * <li>
3764
- * <p>File Transfer Protocol (FTP): Unencrypted file transfer</p>
3850
+ * <p>
3851
+ * <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>
3852
+ * </li>
3853
+ * <li>
3854
+ * <p>
3855
+ * <code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p>
3765
3856
  * </li>
3766
3857
  * </ul>
3767
3858
  *
3768
3859
  * <note>
3769
- * <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web ServicesCertificate
3770
- * Manager (ACM) which will be used to identify your server when clients connect to it over
3771
- * FTPS.</p>
3772
- *
3773
- *
3774
- * <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the
3775
- * <code>EndpointType</code> must be <code>VPC</code> and the
3776
- * <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>
3777
- *
3778
- * <p>If <code>Protocol</code> includes <code>FTP</code>, then
3860
+ * <ul>
3861
+ * <li>
3862
+ * <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM)
3863
+ * which is used to identify your server when clients connect to it over
3864
+ * FTPS.</p>
3865
+ * </li>
3866
+ * <li>
3867
+ * <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the
3868
+ * <code>EndpointType</code> must be <code>VPC</code> and the
3869
+ * <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>
3870
+ * </li>
3871
+ * <li>
3872
+ * <p>If <code>Protocol</code> includes <code>FTP</code>, then
3779
3873
  * <code>AddressAllocationIds</code> cannot be associated.</p>
3780
- *
3781
- * <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>
3782
- * can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to
3783
- * <code>SERVICE_MANAGED</code>.</p>
3874
+ * </li>
3875
+ * <li>
3876
+ * <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>
3877
+ * can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to
3878
+ * <code>SERVICE_MANAGED</code>.</p>
3879
+ * </li>
3880
+ * <li>
3881
+ * <p>If <code>Protocol</code> includes <code>AS2</code>, then the
3882
+ * <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p>
3883
+ * </li>
3884
+ * </ul>
3784
3885
  * </note>
3785
3886
  */
3786
3887
  Protocols?: (Protocol | string)[];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-transfer",
3
3
  "description": "AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native",
4
- "version": "3.154.0",
4
+ "version": "3.157.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",