@aws-sdk/client-secrets-manager 3.36.1 → 3.37.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.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,17 @@
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.37.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.1...v3.37.0) (2021-10-15)
7
+
8
+
9
+ ### Features
10
+
11
+ * **clients:** update clients as of 10/15/2021 ([#2902](https://github.com/aws/aws-sdk-js-v3/issues/2902)) ([2730b54](https://github.com/aws/aws-sdk-js-v3/commit/2730b5424377944a5a2ad5e1ad7d3ca4135dae1c))
12
+
13
+
14
+
15
+
16
+
6
17
  ## [3.36.1](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.0...v3.36.1) (2021-10-12)
7
18
 
8
19
 
@@ -64,7 +64,7 @@ const partitionHash = {
64
64
  hostname: "secretsmanager.{region}.amazonaws.com.cn",
65
65
  },
66
66
  "aws-iso": {
67
- regions: ["us-iso-east-1"],
67
+ regions: ["us-iso-east-1", "us-iso-west-1"],
68
68
  hostname: "secretsmanager.{region}.c2s.ic.gov",
69
69
  },
70
70
  "aws-iso-b": {
@@ -62,7 +62,7 @@ var partitionHash = {
62
62
  hostname: "secretsmanager.{region}.amazonaws.com.cn",
63
63
  },
64
64
  "aws-iso": {
65
- regions: ["us-iso-east-1"],
65
+ regions: ["us-iso-east-1", "us-iso-west-1"],
66
66
  hostname: "secretsmanager.{region}.c2s.ic.gov",
67
67
  },
68
68
  "aws-iso-b": {
@@ -546,11 +546,12 @@ export declare class SecretsManager extends SecretsManagerClient {
546
546
  * creates a new version and attaches it to the secret. The version can contain a new
547
547
  * <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also
548
548
  * specify the staging labels that are initially attached to the new version.</p>
549
- * <note>
550
- * <p>The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a
551
- * secret with the <code>SecretBinary</code> field you must use the Amazon Web Services CLI or one of the
552
- * Amazon Web Services SDKs.</p>
553
- * </note>
549
+ * <p>We recommend you avoid calling <code>PutSecretValue</code> at a sustained rate of more than
550
+ * once every 10 minutes. When you update the secret value, Secrets Manager creates a new version
551
+ * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
552
+ * remove versions created less than 24 hours ago. If you call <code>PutSecretValue</code> more
553
+ * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
554
+ * the quota for secret versions.</p>
554
555
  * <ul>
555
556
  * <li>
556
557
  * <p>If this operation creates the first version for the secret then Secrets Manager
@@ -840,12 +841,17 @@ export declare class SecretsManager extends SecretsManagerClient {
840
841
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
841
842
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
842
843
  /**
843
- * <p>Modifies many of the details of the specified secret. If you include a
844
- * <code>ClientRequestToken</code> and <i>either</i>
845
- * <code>SecretString</code> or <code>SecretBinary</code> then it also creates a new version
846
- * attached to the secret.</p>
847
- * <p>To modify the rotation configuration of a secret, use <a>RotateSecret</a>
844
+ * <p>Modifies many of the details of the specified secret. </p>
845
+ * <p>To change the secret value, you can also use <a>PutSecretValue</a>.</p>
846
+ * <p>To change the rotation configuration of a secret, use <a>RotateSecret</a>
848
847
  * instead.</p>
848
+ *
849
+ * <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than
850
+ * once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret value, Secrets Manager creates a new version
851
+ * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
852
+ * remove versions created less than 24 hours ago. If you update the secret value more
853
+ * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
854
+ * the quota for secret versions.</p>
849
855
  * <note>
850
856
  * <p>The Secrets Manager console uses only the <code>SecretString</code> parameter and therefore limits
851
857
  * you to encrypting and storing only a text string. To encrypt and store binary data as part
@@ -11,11 +11,12 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
11
11
  * creates a new version and attaches it to the secret. The version can contain a new
12
12
  * <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also
13
13
  * specify the staging labels that are initially attached to the new version.</p>
14
- * <note>
15
- * <p>The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a
16
- * secret with the <code>SecretBinary</code> field you must use the Amazon Web Services CLI or one of the
17
- * Amazon Web Services SDKs.</p>
18
- * </note>
14
+ * <p>We recommend you avoid calling <code>PutSecretValue</code> at a sustained rate of more than
15
+ * once every 10 minutes. When you update the secret value, Secrets Manager creates a new version
16
+ * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
17
+ * remove versions created less than 24 hours ago. If you call <code>PutSecretValue</code> more
18
+ * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
19
+ * the quota for secret versions.</p>
19
20
  * <ul>
20
21
  * <li>
21
22
  * <p>If this operation creates the first version for the secret then Secrets Manager
@@ -7,12 +7,17 @@ export interface UpdateSecretCommandInput extends UpdateSecretRequest {
7
7
  export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Modifies many of the details of the specified secret. If you include a
11
- * <code>ClientRequestToken</code> and <i>either</i>
12
- * <code>SecretString</code> or <code>SecretBinary</code> then it also creates a new version
13
- * attached to the secret.</p>
14
- * <p>To modify the rotation configuration of a secret, use <a>RotateSecret</a>
10
+ * <p>Modifies many of the details of the specified secret. </p>
11
+ * <p>To change the secret value, you can also use <a>PutSecretValue</a>.</p>
12
+ * <p>To change the rotation configuration of a secret, use <a>RotateSecret</a>
15
13
  * instead.</p>
14
+ *
15
+ * <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than
16
+ * once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret value, Secrets Manager creates a new version
17
+ * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
18
+ * remove versions created less than 24 hours ago. If you update the secret value more
19
+ * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
20
+ * the quota for secret versions.</p>
16
21
  * <note>
17
22
  * <p>The Secrets Manager console uses only the <code>SecretString</code> parameter and therefore limits
18
23
  * you to encrypting and storing only a text string. To encrypt and store binary data as part
@@ -22,20 +22,8 @@ export interface CancelRotateSecretRequest {
22
22
  /**
23
23
  * <p>Specifies the secret to cancel a rotation request. You can specify either the Amazon
24
24
  * Resource Name (ARN) or the friendly name of the secret.</p>
25
- * <note>
26
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
27
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
28
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
29
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
30
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
31
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
32
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
33
- * results. To avoid this situation, we recommend that you don’t create secret names ending
34
- * with a hyphen followed by six characters.</p>
35
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
36
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
37
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
38
- * </note>
25
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
26
+ * than a partial ARN.</p>
39
27
  */
40
28
  SecretId: string | undefined;
41
29
  }
@@ -245,15 +233,9 @@ export interface CreateSecretRequest {
245
233
  * secret text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the
246
234
  * information as a JSON structure of key/value pairs that the Lambda rotation function knows how
247
235
  * to parse.</p>
248
- * <p>For storing multiple values, we recommend that you use a JSON text string argument and
249
- * specify key/value pairs. For information on how to format a JSON parameter for the various
250
- * command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
251
- * Parameters</a> in the <i>CLI User Guide</i>. For example:</p>
252
- * <p>
253
- * <code>{"username":"bob","password":"abc123xyz456"}</code>
254
- * </p>
255
- * <p>If your command-line tool or SDK requires quotation marks around the parameter, you should
256
- * use single quotes to avoid confusion with the double quotes required in the JSON text. </p>
236
+ * <p>For storing multiple values, we recommend that you use a JSON text
237
+ * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
238
+ * in the Amazon Web Services CLI User Guide.</p>
257
239
  */
258
240
  SecretString?: string;
259
241
  /**
@@ -487,20 +469,8 @@ export interface DeleteResourcePolicyRequest {
487
469
  /**
488
470
  * <p>Specifies the secret that you want to delete the attached resource-based policy for. You
489
471
  * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
490
- * <note>
491
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
492
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
493
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
494
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
495
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
496
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
497
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
498
- * results. To avoid this situation, we recommend that you don’t create secret names ending
499
- * with a hyphen followed by six characters.</p>
500
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
501
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
502
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
503
- * </note>
472
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
473
+ * than a partial ARN.</p>
504
474
  */
505
475
  SecretId: string | undefined;
506
476
  }
@@ -530,20 +500,8 @@ export interface DeleteSecretRequest {
530
500
  /**
531
501
  * <p>Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or
532
502
  * the friendly name of the secret.</p>
533
- * <note>
534
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
535
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
536
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
537
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
538
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
539
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
540
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
541
- * results. To avoid this situation, we recommend that you don’t create secret names ending
542
- * with a hyphen followed by six characters.</p>
543
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
544
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
545
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
546
- * </note>
503
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
504
+ * than a partial ARN.</p>
547
505
  */
548
506
  SecretId: string | undefined;
549
507
  /**
@@ -608,20 +566,8 @@ export interface DescribeSecretRequest {
608
566
  /**
609
567
  * <p>The identifier of the secret whose details you want to retrieve. You can specify either
610
568
  * the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
611
- * <note>
612
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
613
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
614
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
615
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
616
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
617
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
618
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
619
- * results. To avoid this situation, we recommend that you don’t create secret names ending
620
- * with a hyphen followed by six characters.</p>
621
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
622
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
623
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
624
- * </note>
569
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
570
+ * than a partial ARN.</p>
625
571
  */
626
572
  SecretId: string | undefined;
627
573
  }
@@ -685,7 +631,8 @@ export interface DescribeSecretResponse {
685
631
  */
686
632
  RotationLambdaARN?: string;
687
633
  /**
688
- * <p>A structure with the rotation configuration for this secret.</p>
634
+ * <p>A structure with the rotation configuration for this secret. This field is only populated
635
+ * if rotation is configured.</p>
689
636
  */
690
637
  RotationRules?: RotationRulesType;
691
638
  /**
@@ -845,20 +792,8 @@ export interface GetResourcePolicyRequest {
845
792
  /**
846
793
  * <p>Specifies the secret that you want to retrieve the attached resource-based policy for. You
847
794
  * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
848
- * <note>
849
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
850
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
851
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
852
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
853
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
854
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
855
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
856
- * results. To avoid this situation, we recommend that you don’t create secret names ending
857
- * with a hyphen followed by six characters.</p>
858
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
859
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
860
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
861
- * </note>
795
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
796
+ * than a partial ARN.</p>
862
797
  */
863
798
  SecretId: string | undefined;
864
799
  }
@@ -896,20 +831,8 @@ export interface GetSecretValueRequest {
896
831
  /**
897
832
  * <p>Specifies the secret containing the version that you want to retrieve. You can specify
898
833
  * either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
899
- * <note>
900
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
901
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
902
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
903
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
904
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
905
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
906
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
907
- * results. To avoid this situation, we recommend that you don’t create secret names ending
908
- * with a hyphen followed by six characters.</p>
909
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
910
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
911
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
912
- * </note>
834
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
835
+ * than a partial ARN.</p>
913
836
  */
914
837
  SecretId: string | undefined;
915
838
  /**
@@ -1168,20 +1091,8 @@ export interface ListSecretVersionIdsRequest {
1168
1091
  /**
1169
1092
  * <p>The identifier for the secret containing the versions you want to list. You can specify
1170
1093
  * either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1171
- * <note>
1172
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1173
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1174
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1175
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1176
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1177
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1178
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1179
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1180
- * with a hyphen followed by six characters.</p>
1181
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1182
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1183
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1184
- * </note>
1094
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1095
+ * than a partial ARN.</p>
1185
1096
  */
1186
1097
  SecretId: string | undefined;
1187
1098
  /**
@@ -1303,20 +1214,8 @@ export interface PutResourcePolicyRequest {
1303
1214
  /**
1304
1215
  * <p>Specifies the secret that you want to attach the resource-based policy. You can specify
1305
1216
  * either the ARN or the friendly name of the secret.</p>
1306
- * <note>
1307
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1308
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1309
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1310
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1311
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1312
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1313
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1314
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1315
- * with a hyphen followed by six characters.</p>
1316
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1317
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1318
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1319
- * </note>
1217
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1218
+ * than a partial ARN.</p>
1320
1219
  */
1321
1220
  SecretId: string | undefined;
1322
1221
  /**
@@ -1360,20 +1259,8 @@ export interface PutSecretValueRequest {
1360
1259
  * <p>Specifies the secret to which you want to add a new version. You can specify either the
1361
1260
  * Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already
1362
1261
  * exist.</p>
1363
- * <note>
1364
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1365
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1366
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1367
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1368
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1369
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1370
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1371
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1372
- * with a hyphen followed by six characters.</p>
1373
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1374
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1375
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1376
- * </note>
1262
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1263
+ * than a partial ARN.</p>
1377
1264
  */
1378
1265
  SecretId: string | undefined;
1379
1266
  /**
@@ -1429,16 +1316,9 @@ export interface PutSecretValueRequest {
1429
1316
  * protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console
1430
1317
  * stores the information as a JSON structure of key/value pairs that the default Lambda rotation
1431
1318
  * function knows how to parse.</p>
1432
- * <p>For storing multiple values, we recommend that you use a JSON text string argument and
1433
- * specify key/value pairs. For information on how to format a JSON parameter for the various
1434
- * command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
1435
- * Parameters</a> in the <i>CLI User Guide</i>.</p>
1436
- * <p> For example:</p>
1437
- * <p>
1438
- * <code>[{"username":"bob"},{"password":"abc123xyz456"}]</code>
1439
- * </p>
1440
- * <p>If your command-line tool or SDK requires quotation marks around the parameter, you should
1441
- * use single quotes to avoid confusion with the double quotes required in the JSON text.</p>
1319
+ * <p>For storing multiple values, we recommend that you use a JSON text
1320
+ * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1321
+ * in the Amazon Web Services CLI User Guide.</p>
1442
1322
  */
1443
1323
  SecretString?: string;
1444
1324
  /**
@@ -1559,20 +1439,8 @@ export interface RestoreSecretRequest {
1559
1439
  /**
1560
1440
  * <p>Specifies the secret that you want to restore from a previously scheduled deletion. You
1561
1441
  * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1562
- * <note>
1563
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1564
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1565
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1566
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1567
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1568
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1569
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1570
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1571
- * with a hyphen followed by six characters.</p>
1572
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1573
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1574
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1575
- * </note>
1442
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1443
+ * than a partial ARN.</p>
1576
1444
  */
1577
1445
  SecretId: string | undefined;
1578
1446
  }
@@ -1602,20 +1470,8 @@ export interface RotateSecretRequest {
1602
1470
  /**
1603
1471
  * <p>Specifies the secret that you want to rotate. You can specify either the Amazon Resource
1604
1472
  * Name (ARN) or the friendly name of the secret.</p>
1605
- * <note>
1606
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1607
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1608
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1609
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1610
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1611
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1612
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1613
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1614
- * with a hyphen followed by six characters.</p>
1615
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1616
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1617
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1618
- * </note>
1473
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1474
+ * than a partial ARN.</p>
1619
1475
  */
1620
1476
  SecretId: string | undefined;
1621
1477
  /**
@@ -1699,30 +1555,17 @@ export interface TagResourceRequest {
1699
1555
  /**
1700
1556
  * <p>The identifier for the secret that you want to attach tags to. You can specify either the
1701
1557
  * Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1702
- * <note>
1703
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1704
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1705
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1706
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1707
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1708
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1709
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1710
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1711
- * with a hyphen followed by six characters.</p>
1712
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1713
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1714
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1715
- * </note>
1558
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1559
+ * than a partial ARN.</p>
1716
1560
  */
1717
1561
  SecretId: string | undefined;
1718
1562
  /**
1719
1563
  * <p>The tags to attach to the secret. Each element in the list consists of a <code>Key</code>
1720
1564
  * and a <code>Value</code>.</p>
1721
- * <p>This parameter to the API requires a JSON text string argument. For information on how to
1722
- * format a JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for Parameters</a> in the <i>CLI User Guide</i>. For the
1723
- * CLI, you can also use the syntax: <code>--Tags Key="Key1",Value="Value1"
1724
- * Key="Key2",Value="Value2"[,…]</code>
1725
- * </p>
1565
+ * <p>This parameter to the API requires a JSON text string argument.</p>
1566
+ * <p>For storing multiple values, we recommend that you use a JSON text
1567
+ * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1568
+ * in the Amazon Web Services CLI User Guide.</p>
1726
1569
  */
1727
1570
  Tags: Tag[] | undefined;
1728
1571
  }
@@ -1736,27 +1579,17 @@ export interface UntagResourceRequest {
1736
1579
  /**
1737
1580
  * <p>The identifier for the secret that you want to remove tags from. You can specify either
1738
1581
  * the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1739
- * <note>
1740
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1741
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1742
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1743
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1744
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1745
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1746
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1747
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1748
- * with a hyphen followed by six characters.</p>
1749
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1750
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1751
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1752
- * </note>
1582
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1583
+ * than a partial ARN.</p>
1753
1584
  */
1754
1585
  SecretId: string | undefined;
1755
1586
  /**
1756
1587
  * <p>A list of tag key names to remove from the secret. You don't specify the value. Both the
1757
1588
  * key and its associated value are removed.</p>
1758
- * <p>This parameter to the API requires a JSON text string argument. For information on how to
1759
- * format a JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for Parameters</a> in the <i>CLI User Guide</i>.</p>
1589
+ * <p>This parameter to the API requires a JSON text string argument.</p>
1590
+ * <p>For storing multiple values, we recommend that you use a JSON text
1591
+ * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1592
+ * in the Amazon Web Services CLI User Guide.</p>
1760
1593
  */
1761
1594
  TagKeys: string[] | undefined;
1762
1595
  }
@@ -1771,20 +1604,8 @@ export interface UpdateSecretRequest {
1771
1604
  * <p>Specifies the secret that you want to modify or to which you want to add a new version.
1772
1605
  * You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1773
1606
  * secret.</p>
1774
- * <note>
1775
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1776
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1777
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1778
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1779
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1780
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1781
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1782
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1783
- * with a hyphen followed by six characters.</p>
1784
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1785
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1786
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1787
- * </note>
1607
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1608
+ * than a partial ARN.</p>
1788
1609
  */
1789
1610
  SecretId: string | undefined;
1790
1611
  /**
@@ -1825,8 +1646,9 @@ export interface UpdateSecretRequest {
1825
1646
  */
1826
1647
  Description?: string;
1827
1648
  /**
1828
- * <p>(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) to be
1829
- * used to encrypt the protected text in new versions of this secret.</p>
1649
+ * <p>(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager
1650
+ * uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label">Staging
1651
+ * Labels</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.</p>
1830
1652
  * <important>
1831
1653
  * <p>You can only use the account's default CMK to encrypt and decrypt if you call this
1832
1654
  * operation using credentials from the same account that owns the secret. If the secret is in
@@ -1853,21 +1675,9 @@ export interface UpdateSecretRequest {
1853
1675
  * protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console
1854
1676
  * stores the information as a JSON structure of key/value pairs that the default Lambda rotation
1855
1677
  * function knows how to parse.</p>
1856
- * <p>For storing multiple values, we recommend that you use a JSON text string argument and
1857
- * specify key/value pairs. For information on how to format a JSON parameter for the various
1858
- * command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
1859
- * Parameters</a> in the <i>CLI User Guide</i>. For example:</p>
1860
- * <p>
1861
- * <code>[{"username":"bob"},{"password":"abc123xyz456"}]</code>
1862
- * </p>
1863
- * <p>If your command-line tool or SDK requires quotation marks around the parameter, you should
1864
- * use single quotes to avoid confusion with the double quotes required in the JSON text. You can
1865
- * also 'escape' the double quote character in the embedded JSON text by prefacing each with a
1866
- * backslash. For example, the following string is surrounded by double-quotes. All of the
1867
- * embedded double quotes are escaped:</p>
1868
- * <p>
1869
- * <code>"[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]"</code>
1870
- * </p>
1678
+ * <p>For storing multiple values, we recommend that you use a JSON text
1679
+ * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1680
+ * in the Amazon Web Services CLI User Guide.</p>
1871
1681
  */
1872
1682
  SecretString?: string;
1873
1683
  }
@@ -1910,20 +1720,8 @@ export interface UpdateSecretVersionStageRequest {
1910
1720
  * <p>Specifies the secret with the version with the list of staging labels you want to modify.
1911
1721
  * You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1912
1722
  * secret.</p>
1913
- * <note>
1914
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1915
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1916
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1917
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1918
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1919
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1920
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1921
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1922
- * with a hyphen followed by six characters.</p>
1923
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1924
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1925
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1926
- * </note>
1723
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1724
+ * than a partial ARN.</p>
1927
1725
  */
1928
1726
  SecretId: string | undefined;
1929
1727
  /**
@@ -1973,20 +1771,8 @@ export interface ValidateResourcePolicyRequest {
1973
1771
  * <p> (Optional) The identifier of the secret with the resource-based policy you want to
1974
1772
  * validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1975
1773
  * secret.</p>
1976
- * <note>
1977
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1978
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1979
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1980
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1981
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1982
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1983
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1984
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1985
- * with a hyphen followed by six characters.</p>
1986
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1987
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1988
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1989
- * </note>
1774
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1775
+ * than a partial ARN.</p>
1990
1776
  */
1991
1777
  SecretId?: string;
1992
1778
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-secrets-manager",
3
3
  "description": "AWS SDK for JavaScript Secrets Manager Client for Node.js, Browser and React Native",
4
- "version": "3.36.1",
4
+ "version": "3.37.0",
5
5
  "scripts": {
6
6
  "build": "yarn build:cjs && yarn build:es && yarn build:types",
7
7
  "build:cjs": "tsc -p tsconfig.json",
@@ -21,39 +21,39 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "^1.0.0",
23
23
  "@aws-crypto/sha256-js": "^1.0.0",
24
- "@aws-sdk/client-sts": "3.36.1",
25
- "@aws-sdk/config-resolver": "3.36.0",
26
- "@aws-sdk/credential-provider-node": "3.36.1",
27
- "@aws-sdk/fetch-http-handler": "3.36.0",
28
- "@aws-sdk/hash-node": "3.36.0",
29
- "@aws-sdk/invalid-dependency": "3.36.0",
30
- "@aws-sdk/middleware-content-length": "3.36.0",
31
- "@aws-sdk/middleware-host-header": "3.36.0",
32
- "@aws-sdk/middleware-logger": "3.36.0",
33
- "@aws-sdk/middleware-retry": "3.36.0",
34
- "@aws-sdk/middleware-serde": "3.36.0",
35
- "@aws-sdk/middleware-signing": "3.36.0",
36
- "@aws-sdk/middleware-stack": "3.36.0",
37
- "@aws-sdk/middleware-user-agent": "3.36.0",
38
- "@aws-sdk/node-config-provider": "3.36.0",
39
- "@aws-sdk/node-http-handler": "3.36.0",
40
- "@aws-sdk/protocol-http": "3.36.0",
41
- "@aws-sdk/smithy-client": "3.36.0",
42
- "@aws-sdk/types": "3.36.0",
43
- "@aws-sdk/url-parser": "3.36.0",
44
- "@aws-sdk/util-base64-browser": "3.36.0",
45
- "@aws-sdk/util-base64-node": "3.36.0",
46
- "@aws-sdk/util-body-length-browser": "3.36.0",
47
- "@aws-sdk/util-body-length-node": "3.36.0",
48
- "@aws-sdk/util-user-agent-browser": "3.36.0",
49
- "@aws-sdk/util-user-agent-node": "3.36.0",
50
- "@aws-sdk/util-utf8-browser": "3.36.0",
51
- "@aws-sdk/util-utf8-node": "3.36.0",
24
+ "@aws-sdk/client-sts": "3.37.0",
25
+ "@aws-sdk/config-resolver": "3.37.0",
26
+ "@aws-sdk/credential-provider-node": "3.37.0",
27
+ "@aws-sdk/fetch-http-handler": "3.37.0",
28
+ "@aws-sdk/hash-node": "3.37.0",
29
+ "@aws-sdk/invalid-dependency": "3.37.0",
30
+ "@aws-sdk/middleware-content-length": "3.37.0",
31
+ "@aws-sdk/middleware-host-header": "3.37.0",
32
+ "@aws-sdk/middleware-logger": "3.37.0",
33
+ "@aws-sdk/middleware-retry": "3.37.0",
34
+ "@aws-sdk/middleware-serde": "3.37.0",
35
+ "@aws-sdk/middleware-signing": "3.37.0",
36
+ "@aws-sdk/middleware-stack": "3.37.0",
37
+ "@aws-sdk/middleware-user-agent": "3.37.0",
38
+ "@aws-sdk/node-config-provider": "3.37.0",
39
+ "@aws-sdk/node-http-handler": "3.37.0",
40
+ "@aws-sdk/protocol-http": "3.37.0",
41
+ "@aws-sdk/smithy-client": "3.37.0",
42
+ "@aws-sdk/types": "3.37.0",
43
+ "@aws-sdk/url-parser": "3.37.0",
44
+ "@aws-sdk/util-base64-browser": "3.37.0",
45
+ "@aws-sdk/util-base64-node": "3.37.0",
46
+ "@aws-sdk/util-body-length-browser": "3.37.0",
47
+ "@aws-sdk/util-body-length-node": "3.37.0",
48
+ "@aws-sdk/util-user-agent-browser": "3.37.0",
49
+ "@aws-sdk/util-user-agent-node": "3.37.0",
50
+ "@aws-sdk/util-utf8-browser": "3.37.0",
51
+ "@aws-sdk/util-utf8-node": "3.37.0",
52
52
  "tslib": "^2.3.0",
53
53
  "uuid": "^8.3.2"
54
54
  },
55
55
  "devDependencies": {
56
- "@aws-sdk/client-documentation-generator": "3.36.0",
56
+ "@aws-sdk/client-documentation-generator": "3.37.0",
57
57
  "@types/node": "^12.7.5",
58
58
  "@types/uuid": "^8.3.0",
59
59
  "downlevel-dts": "0.7.0",