@aws-sdk/client-transfer 3.363.0 → 3.369.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.
@@ -43,6 +43,7 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
43
43
  * SigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE",
44
44
  * MdnSigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE" || "DEFAULT",
45
45
  * MdnResponse: "SYNC" || "NONE",
46
+ * BasicAuthSecretId: "STRING_VALUE",
46
47
  * },
47
48
  * AccessRole: "STRING_VALUE", // required
48
49
  * LoggingRole: "STRING_VALUE",
@@ -50,6 +50,7 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
50
50
  * // SigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE",
51
51
  * // MdnSigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE" || "DEFAULT",
52
52
  * // MdnResponse: "SYNC" || "NONE",
53
+ * // BasicAuthSecretId: "STRING_VALUE",
53
54
  * // },
54
55
  * // AccessRole: "STRING_VALUE",
55
56
  * // LoggingRole: "STRING_VALUE",
@@ -44,6 +44,7 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
44
44
  * SigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE",
45
45
  * MdnSigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE" || "DEFAULT",
46
46
  * MdnResponse: "SYNC" || "NONE",
47
+ * BasicAuthSecretId: "STRING_VALUE",
47
48
  * },
48
49
  * AccessRole: "STRING_VALUE",
49
50
  * LoggingRole: "STRING_VALUE",
@@ -150,6 +150,34 @@ export interface As2ConnectorConfig {
150
150
  * </ul>
151
151
  */
152
152
  MdnResponse?: MdnResponse | string;
153
+ /**
154
+ * <p>Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication,
155
+ * you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.</p>
156
+ * <p>The default value for this parameter is <code>null</code>, which indicates that Basic authentication is not enabled for the connector.</p>
157
+ * <p>If the connector should use Basic authentication, the secret needs to be in the following format:</p>
158
+ * <p>
159
+ * <code>\{
160
+ * "Username": "user-name",
161
+ * "Password": "user-password"
162
+ * \}</code>
163
+ * </p>
164
+ * <p>Replace <code>user-name</code> and <code>user-password</code> with the credentials for the actual user that is being authenticated.</p>
165
+ * <p>Note the following:</p>
166
+ * <ul>
167
+ * <li>
168
+ * <p>You are storing these credentials in Secrets Manager, <i>not passing them directly</i> into this API.</p>
169
+ * </li>
170
+ * <li>
171
+ * <p>If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication.
172
+ * However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.</p>
173
+ * </li>
174
+ * </ul>
175
+ * <p>If you have previously enabled Basic authentication for a connector, you can disable it by using the <code>UpdateConnector</code> API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:</p>
176
+ * <p>
177
+ * <code>update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'</code>
178
+ * </p>
179
+ */
180
+ BasicAuthSecretId?: string;
153
181
  }
154
182
  /**
155
183
  * @public
@@ -624,6 +652,10 @@ export interface CreateAgreementRequest {
624
652
  * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
625
653
  * access to the parent directory of the files that you intend to send with
626
654
  * <code>StartFileTransfer</code>.</p>
655
+ * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
656
+ * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
657
+ * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
658
+ * needs the <code>kms:Decrypt</code> permission for that key.</p>
627
659
  */
628
660
  AccessRole: string | undefined;
629
661
  /**
@@ -683,6 +715,10 @@ export interface CreateConnectorRequest {
683
715
  * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
684
716
  * access to the parent directory of the files that you intend to send with
685
717
  * <code>StartFileTransfer</code>.</p>
718
+ * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
719
+ * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
720
+ * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
721
+ * needs the <code>kms:Decrypt</code> permission for that key.</p>
686
722
  */
687
723
  AccessRole: string | undefined;
688
724
  /**
@@ -2155,6 +2191,10 @@ export interface DescribedAgreement {
2155
2191
  * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
2156
2192
  * access to the parent directory of the files that you intend to send with
2157
2193
  * <code>StartFileTransfer</code>.</p>
2194
+ * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
2195
+ * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
2196
+ * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
2197
+ * needs the <code>kms:Decrypt</code> permission for that key.</p>
2158
2198
  */
2159
2199
  AccessRole?: string;
2160
2200
  /**
@@ -2297,6 +2337,10 @@ export interface DescribedConnector {
2297
2337
  * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
2298
2338
  * access to the parent directory of the files that you intend to send with
2299
2339
  * <code>StartFileTransfer</code>.</p>
2340
+ * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
2341
+ * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
2342
+ * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
2343
+ * needs the <code>kms:Decrypt</code> permission for that key.</p>
2300
2344
  */
2301
2345
  AccessRole?: string;
2302
2346
  /**
@@ -4519,6 +4563,10 @@ export interface UpdateAgreementRequest {
4519
4563
  * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
4520
4564
  * access to the parent directory of the files that you intend to send with
4521
4565
  * <code>StartFileTransfer</code>.</p>
4566
+ * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
4567
+ * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
4568
+ * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
4569
+ * needs the <code>kms:Decrypt</code> permission for that key.</p>
4522
4570
  */
4523
4571
  AccessRole?: string;
4524
4572
  }
@@ -4588,6 +4636,10 @@ export interface UpdateConnectorRequest {
4588
4636
  * <code>StartFileTransfer</code> request. Additionally, you need to provide read and write
4589
4637
  * access to the parent directory of the files that you intend to send with
4590
4638
  * <code>StartFileTransfer</code>.</p>
4639
+ * <p>If you are using Basic authentication for your AS2 connector, the access role requires the
4640
+ * <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using
4641
+ * a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
4642
+ * needs the <code>kms:Decrypt</code> permission for that key.</p>
4591
4643
  */
4592
4644
  AccessRole?: string;
4593
4645
  /**
@@ -58,6 +58,7 @@ export interface As2ConnectorConfig {
58
58
  SigningAlgorithm?: SigningAlg | string;
59
59
  MdnSigningAlgorithm?: MdnSigningAlg | string;
60
60
  MdnResponse?: MdnResponse | string;
61
+ BasicAuthSecretId?: string;
61
62
  }
62
63
  export declare const As2Transport: {
63
64
  readonly HTTP: "HTTP";
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.363.0",
4
+ "version": "3.369.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,17 +21,17 @@
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.363.0",
25
- "@aws-sdk/credential-provider-node": "3.363.0",
26
- "@aws-sdk/middleware-host-header": "3.363.0",
27
- "@aws-sdk/middleware-logger": "3.363.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.363.0",
29
- "@aws-sdk/middleware-signing": "3.363.0",
30
- "@aws-sdk/middleware-user-agent": "3.363.0",
31
- "@aws-sdk/types": "3.357.0",
32
- "@aws-sdk/util-endpoints": "3.357.0",
33
- "@aws-sdk/util-user-agent-browser": "3.363.0",
34
- "@aws-sdk/util-user-agent-node": "3.363.0",
24
+ "@aws-sdk/client-sts": "3.369.0",
25
+ "@aws-sdk/credential-provider-node": "3.369.0",
26
+ "@aws-sdk/middleware-host-header": "3.369.0",
27
+ "@aws-sdk/middleware-logger": "3.369.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.369.0",
29
+ "@aws-sdk/middleware-signing": "3.369.0",
30
+ "@aws-sdk/middleware-user-agent": "3.369.0",
31
+ "@aws-sdk/types": "3.369.0",
32
+ "@aws-sdk/util-endpoints": "3.369.0",
33
+ "@aws-sdk/util-user-agent-browser": "3.369.0",
34
+ "@aws-sdk/util-user-agent-node": "3.369.0",
35
35
  "@smithy/config-resolver": "^1.0.1",
36
36
  "@smithy/fetch-http-handler": "^1.0.1",
37
37
  "@smithy/hash-node": "^1.0.1",
@@ -45,7 +45,7 @@
45
45
  "@smithy/node-http-handler": "^1.0.2",
46
46
  "@smithy/protocol-http": "^1.0.1",
47
47
  "@smithy/smithy-client": "^1.0.3",
48
- "@smithy/types": "^1.0.0",
48
+ "@smithy/types": "^1.1.0",
49
49
  "@smithy/url-parser": "^1.0.1",
50
50
  "@smithy/util-base64": "^1.0.1",
51
51
  "@smithy/util-body-length-browser": "^1.0.1",