@aws-sdk/client-transfer 3.387.0 → 3.389.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.
@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ruleSet = void 0;
4
4
  const q = "required", r = "fn", s = "argv", t = "ref";
5
5
  const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
6
- const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://transfer-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://transfer-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://transfer.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://transfer.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
6
+ const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://transfer-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://transfer-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://transfer.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://transfer.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
7
7
  exports.ruleSet = _data;
@@ -1,4 +1,4 @@
1
1
  const q = "required", r = "fn", s = "argv", t = "ref";
2
2
  const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
3
- const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://transfer-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://transfer-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://transfer.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://transfer.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
3
+ const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://transfer-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://transfer-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://transfer.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://transfer.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
4
4
  export const ruleSet = _data;
@@ -23,9 +23,9 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Creates the connector, which captures the parameters for an outbound connection for the
27
- * AS2 or SFTP protocol. The connector is required for sending files to an externally hosted AS2 or SFTP server.
28
- * For more details about AS2 connectors, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector">Create AS2 connectors</a>.</p>
26
+ * <p>Creates the connector, which captures the parameters for a connection for the
27
+ * AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.
28
+ * For more details about connectors, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector">Create AS2 connectors</a> and <a href="https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html">Create SFTP connectors</a>.</p>
29
29
  * <note>
30
30
  * <p>You must specify exactly one configuration object: either for AS2 (<code>As2Config</code>) or SFTP (<code>SftpConfig</code>).</p>
31
31
  * </note>
@@ -35,8 +35,8 @@ export interface StartFileTransferCommandOutput extends StartFileTransferRespons
35
35
  * you also specify the following items:</p>
36
36
  * <ul>
37
37
  * <li>
38
- * <p>If you are transferring file from a partner's SFTP server to a Transfer Family
39
- * server, you specify one or more <code>RetreiveFilePaths</code> to identify the files
38
+ * <p>If you are transferring file from a partner's SFTP server to Amazon Web Services
39
+ * storage, you specify one or more <code>RetreiveFilePaths</code> to identify the files
40
40
  * you want to transfer, and a <code>LocalDirectoryPath</code> to specify the destination
41
41
  * folder.</p>
42
42
  * </li>
@@ -684,20 +684,33 @@ export interface CreateAgreementRequest {
684
684
  BaseDirectory: string | undefined;
685
685
  /**
686
686
  * @public
687
- * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
687
+ * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
688
+ * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
689
+ * <p>
690
+ * <b>For AS2 connectors</b>
691
+ * </p>
692
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
688
693
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
689
694
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
690
695
  * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
691
696
  * store the MDN when we receive them from the partner, and write a final JSON file containing
692
697
  * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
693
698
  * and write access to the parent directory of the file location used in the
694
- * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
699
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
695
700
  * access to the parent directory of the files that you intend to send with
696
- * <code>StartFileTransfer</code>.</p>
701
+ * <code>StartFileTransfer</code>.</p>
697
702
  * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
698
703
  * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
699
704
  * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
700
705
  * needs the <code>kms:Decrypt</code> permission for that key.</p>
706
+ * <p>
707
+ * <b>For SFTP connectors</b>
708
+ * </p>
709
+ * <p>Make sure that the access role provides
710
+ * read and write access to the parent directory of the file location
711
+ * that's used in the <code>StartFileTransfer</code> request.
712
+ * Additionally, make sure that the role provides
713
+ * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
701
714
  */
702
715
  AccessRole: string | undefined;
703
716
  /**
@@ -784,20 +797,33 @@ export interface CreateConnectorRequest {
784
797
  As2Config?: As2ConnectorConfig;
785
798
  /**
786
799
  * @public
787
- * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
800
+ * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
801
+ * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
802
+ * <p>
803
+ * <b>For AS2 connectors</b>
804
+ * </p>
805
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
788
806
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
789
807
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
790
808
  * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
791
809
  * store the MDN when we receive them from the partner, and write a final JSON file containing
792
810
  * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
793
811
  * and write access to the parent directory of the file location used in the
794
- * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
812
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
795
813
  * access to the parent directory of the files that you intend to send with
796
- * <code>StartFileTransfer</code>.</p>
814
+ * <code>StartFileTransfer</code>.</p>
797
815
  * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
798
816
  * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
799
817
  * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
800
818
  * needs the <code>kms:Decrypt</code> permission for that key.</p>
819
+ * <p>
820
+ * <b>For SFTP connectors</b>
821
+ * </p>
822
+ * <p>Make sure that the access role provides
823
+ * read and write access to the parent directory of the file location
824
+ * that's used in the <code>StartFileTransfer</code> request.
825
+ * Additionally, make sure that the role provides
826
+ * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
801
827
  */
802
828
  AccessRole: string | undefined;
803
829
  /**
@@ -2385,20 +2411,33 @@ export interface DescribedAgreement {
2385
2411
  BaseDirectory?: string;
2386
2412
  /**
2387
2413
  * @public
2388
- * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
2414
+ * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
2415
+ * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
2416
+ * <p>
2417
+ * <b>For AS2 connectors</b>
2418
+ * </p>
2419
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
2389
2420
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
2390
2421
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
2391
2422
  * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
2392
2423
  * store the MDN when we receive them from the partner, and write a final JSON file containing
2393
2424
  * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
2394
2425
  * and write access to the parent directory of the file location used in the
2395
- * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
2426
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
2396
2427
  * access to the parent directory of the files that you intend to send with
2397
- * <code>StartFileTransfer</code>.</p>
2428
+ * <code>StartFileTransfer</code>.</p>
2398
2429
  * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
2399
2430
  * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
2400
2431
  * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
2401
2432
  * needs the <code>kms:Decrypt</code> permission for that key.</p>
2433
+ * <p>
2434
+ * <b>For SFTP connectors</b>
2435
+ * </p>
2436
+ * <p>Make sure that the access role provides
2437
+ * read and write access to the parent directory of the file location
2438
+ * that's used in the <code>StartFileTransfer</code> request.
2439
+ * Additionally, make sure that the role provides
2440
+ * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
2402
2441
  */
2403
2442
  AccessRole?: string;
2404
2443
  /**
@@ -2555,20 +2594,33 @@ export interface DescribedConnector {
2555
2594
  As2Config?: As2ConnectorConfig;
2556
2595
  /**
2557
2596
  * @public
2558
- * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
2597
+ * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
2598
+ * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
2599
+ * <p>
2600
+ * <b>For AS2 connectors</b>
2601
+ * </p>
2602
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
2559
2603
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
2560
2604
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
2561
2605
  * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
2562
2606
  * store the MDN when we receive them from the partner, and write a final JSON file containing
2563
2607
  * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
2564
2608
  * and write access to the parent directory of the file location used in the
2565
- * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
2609
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
2566
2610
  * access to the parent directory of the files that you intend to send with
2567
- * <code>StartFileTransfer</code>.</p>
2611
+ * <code>StartFileTransfer</code>.</p>
2568
2612
  * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
2569
2613
  * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
2570
2614
  * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
2571
2615
  * needs the <code>kms:Decrypt</code> permission for that key.</p>
2616
+ * <p>
2617
+ * <b>For SFTP connectors</b>
2618
+ * </p>
2619
+ * <p>Make sure that the access role provides
2620
+ * read and write access to the parent directory of the file location
2621
+ * that's used in the <code>StartFileTransfer</code> request.
2622
+ * Additionally, make sure that the role provides
2623
+ * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
2572
2624
  */
2573
2625
  AccessRole?: string;
2574
2626
  /**
@@ -4762,10 +4814,16 @@ export interface StartFileTransferRequest {
4762
4814
  ConnectorId: string | undefined;
4763
4815
  /**
4764
4816
  * @public
4765
- * <p>One or more source paths for the Transfer Family server. Each string represents a source file path for one outbound file transfer. For example,
4766
- * <code>
4817
+ * <p>One or more source paths for the Transfer Family server. Each string represents a source
4818
+ * file path for one outbound file transfer. For example,
4819
+ * <code>
4767
4820
  * <i>DOC-EXAMPLE-BUCKET</i>/<i>myfile.txt</i>
4768
4821
  * </code>.</p>
4822
+ * <note>
4823
+ * <p>Replace <code>
4824
+ * <i>DOC-EXAMPLE-BUCKET</i>
4825
+ * </code>with one of your actual buckets.</p>
4826
+ * </note>
4769
4827
  */
4770
4828
  SendFilePaths?: string[];
4771
4829
  /**
@@ -5139,20 +5197,33 @@ export interface UpdateAgreementRequest {
5139
5197
  BaseDirectory?: string;
5140
5198
  /**
5141
5199
  * @public
5142
- * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
5200
+ * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
5201
+ * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
5202
+ * <p>
5203
+ * <b>For AS2 connectors</b>
5204
+ * </p>
5205
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
5143
5206
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
5144
5207
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
5145
5208
  * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
5146
5209
  * store the MDN when we receive them from the partner, and write a final JSON file containing
5147
5210
  * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
5148
5211
  * and write access to the parent directory of the file location used in the
5149
- * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
5212
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
5150
5213
  * access to the parent directory of the files that you intend to send with
5151
- * <code>StartFileTransfer</code>.</p>
5214
+ * <code>StartFileTransfer</code>.</p>
5152
5215
  * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
5153
5216
  * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
5154
5217
  * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
5155
5218
  * needs the <code>kms:Decrypt</code> permission for that key.</p>
5219
+ * <p>
5220
+ * <b>For SFTP connectors</b>
5221
+ * </p>
5222
+ * <p>Make sure that the access role provides
5223
+ * read and write access to the parent directory of the file location
5224
+ * that's used in the <code>StartFileTransfer</code> request.
5225
+ * Additionally, make sure that the role provides
5226
+ * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
5156
5227
  */
5157
5228
  AccessRole?: string;
5158
5229
  }
@@ -5222,20 +5293,33 @@ export interface UpdateConnectorRequest {
5222
5293
  As2Config?: As2ConnectorConfig;
5223
5294
  /**
5224
5295
  * @public
5225
- * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
5296
+ * <p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
5297
+ * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p>
5298
+ * <p>
5299
+ * <b>For AS2 connectors</b>
5300
+ * </p>
5301
+ * <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the
5226
5302
  * file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent
5227
5303
  * directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent
5228
5304
  * directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file,
5229
5305
  * store the MDN when we receive them from the partner, and write a final JSON file containing
5230
5306
  * relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read
5231
5307
  * and write access to the parent directory of the file location used in the
5232
- * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
5308
+ * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
5233
5309
  * access to the parent directory of the files that you intend to send with
5234
- * <code>StartFileTransfer</code>.</p>
5310
+ * <code>StartFileTransfer</code>.</p>
5235
5311
  * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
5236
5312
  * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
5237
5313
  * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
5238
5314
  * needs the <code>kms:Decrypt</code> permission for that key.</p>
5315
+ * <p>
5316
+ * <b>For SFTP connectors</b>
5317
+ * </p>
5318
+ * <p>Make sure that the access role provides
5319
+ * read and write access to the parent directory of the file location
5320
+ * that's used in the <code>StartFileTransfer</code> request.
5321
+ * Additionally, make sure that the role provides
5322
+ * <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>
5239
5323
  */
5240
5324
  AccessRole?: string;
5241
5325
  /**
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.387.0",
4
+ "version": "3.389.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",
@@ -21,8 +21,8 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.387.0",
25
- "@aws-sdk/credential-provider-node": "3.387.0",
24
+ "@aws-sdk/client-sts": "3.388.0",
25
+ "@aws-sdk/credential-provider-node": "3.388.0",
26
26
  "@aws-sdk/middleware-host-header": "3.387.0",
27
27
  "@aws-sdk/middleware-logger": "3.387.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.387.0",