@aws-sdk/client-secrets-manager 3.241.0 → 3.250.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/README.md CHANGED
@@ -18,6 +18,8 @@ service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/user
18
18
  <b>API Version</b>
19
19
  </p>
20
20
  <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
21
+ <p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
22
+ endpoints</a>.</p>
21
23
  <p>
22
24
  <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
23
25
  </p>
@@ -31,6 +31,8 @@ import { SecretsManagerClient } from "./SecretsManagerClient";
31
31
  * <b>API Version</b>
32
32
  * </p>
33
33
  * <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
34
+ * <p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
35
+ * endpoints</a>.</p>
34
36
  * <p>
35
37
  * <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
36
38
  * </p>
@@ -80,6 +82,9 @@ export declare class SecretsManager extends SecretsManagerClient {
80
82
  * includes the connection information to access a database or other service, which Secrets Manager
81
83
  * doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
82
84
  * important information needed to manage the secret.</p>
85
+ * <p>For secrets that use <i>managed rotation</i>, you need to create the secret through the managing service. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.
86
+ *
87
+ * </p>
83
88
  * <p>For information about creating a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html">Create a secret</a>.</p>
84
89
  * <p>To create a secret, you can provide the secret value to be encrypted in either the
85
90
  * <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both.
@@ -353,31 +358,13 @@ export declare class SecretsManager extends SecretsManagerClient {
353
358
  restoreSecret(args: RestoreSecretCommandInput, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
354
359
  restoreSecret(args: RestoreSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
355
360
  /**
356
- * <p>Configures and starts the asynchronous process of rotating the secret. For more information about rotation,
357
- * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>.</p>
358
- * <p>If you include the
359
- * configuration parameters, the operation sets the values for the secret and then immediately
360
- * starts a rotation. If you don't include the configuration parameters, the operation starts a
361
- * rotation with the values already stored in the secret. </p>
362
- * <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must
363
- * make sure the secret value is in the
364
- * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html"> JSON structure
365
- * of a database secret</a>. In particular, if you want to use the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users"> alternating users strategy</a>, your secret must contain the ARN of a superuser
366
- * secret.</p>
367
- * <p>To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule
368
- * for the rotation. The Lambda rotation function creates a new
369
- * version of the secret and creates or updates the credentials on the database or service to
370
- * match. After testing the new credentials, the function marks the new secret version with the staging
371
- * label <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more
372
- * information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
373
- * <p>You can create the Lambda rotation function based on the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html">rotation function templates</a> that Secrets Manager provides. Choose
374
- * a template that matches your <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html">Rotation strategy</a>.</p>
361
+ * <p>Configures and starts the asynchronous process of rotating the secret. For information about rotation,
362
+ * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a> in the <i>Secrets Manager User Guide</i>. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. </p>
375
363
  * <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
376
364
  * to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any
377
365
  * version. If the <code>AWSPENDING</code> staging label is present but not attached to the same
378
366
  * version as <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code>
379
- * assumes that a previous rotation request is still in progress and returns an error.</p>
380
- * <p>When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
367
+ * assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
381
368
  * <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
382
369
  * <p>
383
370
  * <b>Required permissions: </b>
@@ -475,6 +462,7 @@ export declare class SecretsManager extends SecretsManagerClient {
475
462
  /**
476
463
  * <p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>
477
464
  * <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>
465
+ * <p>To change a secret so that it is managed by another service, you need to recreate the secret in that service. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.</p>
478
466
  * <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than
479
467
  * once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret value, Secrets Manager creates a new version
480
468
  * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
@@ -153,6 +153,8 @@ export interface SecretsManagerClientResolvedConfig extends SecretsManagerClient
153
153
  * <b>API Version</b>
154
154
  * </p>
155
155
  * <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
156
+ * <p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
157
+ * endpoints</a>.</p>
156
158
  * <p>
157
159
  * <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
158
160
  * </p>
@@ -14,6 +14,9 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
14
14
  * includes the connection information to access a database or other service, which Secrets Manager
15
15
  * doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
16
16
  * important information needed to manage the secret.</p>
17
+ * <p>For secrets that use <i>managed rotation</i>, you need to create the secret through the managing service. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.
18
+ *
19
+ * </p>
17
20
  * <p>For information about creating a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html">Create a secret</a>.</p>
18
21
  * <p>To create a secret, you can provide the secret value to be encrypted in either the
19
22
  * <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both.
@@ -8,31 +8,13 @@ export interface RotateSecretCommandInput extends RotateSecretRequest {
8
8
  export interface RotateSecretCommandOutput extends RotateSecretResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Configures and starts the asynchronous process of rotating the secret. For more information about rotation,
12
- * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>.</p>
13
- * <p>If you include the
14
- * configuration parameters, the operation sets the values for the secret and then immediately
15
- * starts a rotation. If you don't include the configuration parameters, the operation starts a
16
- * rotation with the values already stored in the secret. </p>
17
- * <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must
18
- * make sure the secret value is in the
19
- * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html"> JSON structure
20
- * of a database secret</a>. In particular, if you want to use the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users"> alternating users strategy</a>, your secret must contain the ARN of a superuser
21
- * secret.</p>
22
- * <p>To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule
23
- * for the rotation. The Lambda rotation function creates a new
24
- * version of the secret and creates or updates the credentials on the database or service to
25
- * match. After testing the new credentials, the function marks the new secret version with the staging
26
- * label <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more
27
- * information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
28
- * <p>You can create the Lambda rotation function based on the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html">rotation function templates</a> that Secrets Manager provides. Choose
29
- * a template that matches your <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html">Rotation strategy</a>.</p>
11
+ * <p>Configures and starts the asynchronous process of rotating the secret. For information about rotation,
12
+ * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a> in the <i>Secrets Manager User Guide</i>. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. </p>
30
13
  * <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
31
14
  * to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any
32
15
  * version. If the <code>AWSPENDING</code> staging label is present but not attached to the same
33
16
  * version as <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code>
34
- * assumes that a previous rotation request is still in progress and returns an error.</p>
35
- * <p>When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
17
+ * assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
36
18
  * <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
37
19
  * <p>
38
20
  * <b>Required permissions: </b>
@@ -10,6 +10,7 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
10
10
  /**
11
11
  * <p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>
12
12
  * <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>
13
+ * <p>To change a secret so that it is managed by another service, you need to recreate the secret in that service. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.</p>
13
14
  * <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than
14
15
  * once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret value, Secrets Manager creates a new version
15
16
  * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
@@ -470,9 +470,11 @@ export interface DescribeSecretRequest {
470
470
  */
471
471
  export interface RotationRulesType {
472
472
  /**
473
- * <p>The number of days between automatic scheduled rotations of the secret. You can use this
473
+ * <p>The number of days between rotations of the secret. You can use this
474
474
  * value to check that your secret meets your compliance guidelines for how often secrets must
475
- * be rotated.</p>
475
+ * be rotated. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation
476
+ * date based on the previous rotation. Manually updating the secret value by calling
477
+ * <code>PutSecretValue</code> or <code>UpdateSecret</code> is considered a valid rotation.</p>
476
478
  * <p>In <code>DescribeSecret</code> and <code>ListSecrets</code>, this value is calculated from
477
479
  * the rotation schedule after every successful rotation. In <code>RotateSecret</code>, you can
478
480
  * set the rotation schedule in <code>RotationRules</code> with <code>AutomaticallyAfterDays</code>
@@ -571,6 +573,9 @@ export interface DescribeSecretResponse {
571
573
  * value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use <a>RestoreSecret</a>.</p>
572
574
  */
573
575
  DeletedDate?: Date;
576
+ /**
577
+ * <p>The next date and time that Secrets Manager will rotate the secret, rounded to the nearest hour. If the secret isn't configured for rotation, Secrets Manager returns null.</p>
578
+ */
574
579
  NextRotationDate?: Date;
575
580
  /**
576
581
  * <p>The list of tags attached to the secret. To add tags to a
@@ -674,6 +679,10 @@ export interface Filter {
674
679
  * </li>
675
680
  * <li>
676
681
  * <p>
682
+ * <b>owning-service</b>: Prefix match, case-sensitive.</p>
683
+ * </li>
684
+ * <li>
685
+ * <p>
677
686
  * <b>all</b>: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.</p>
678
687
  * </li>
679
688
  * </ul>
@@ -841,6 +850,9 @@ export declare enum SortOrderType {
841
850
  desc = "desc"
842
851
  }
843
852
  export interface ListSecretsRequest {
853
+ /**
854
+ * <p>Specifies whether to include secrets scheduled for deletion.</p>
855
+ */
844
856
  IncludePlannedDeletion?: boolean;
845
857
  /**
846
858
  * <p>The number of results to include in the response.</p>
@@ -926,6 +938,9 @@ export interface SecretListEntry {
926
938
  * </a> operation.</p>
927
939
  */
928
940
  DeletedDate?: Date;
941
+ /**
942
+ * <p>The next date and time that Secrets Manager will attempt to rotate the secret, rounded to the nearest hour. This value is null if the secret is not set up for rotation.</p>
943
+ */
929
944
  NextRotationDate?: Date;
930
945
  /**
931
946
  * <p>The list of user-defined tags associated with the secret. To add tags to a
@@ -1264,7 +1279,8 @@ export interface RotateSecretRequest {
1264
1279
  */
1265
1280
  ClientRequestToken?: string;
1266
1281
  /**
1267
- * <p>The ARN of the Lambda rotation function that can rotate the secret.</p>
1282
+ * <p>For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function. </p>
1283
+ * <p>For secrets that use <i>managed rotation</i>, omit this field. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html">Managed rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
1268
1284
  */
1269
1285
  RotationLambdaARN?: string;
1270
1286
  /**
@@ -1274,7 +1290,7 @@ export interface RotateSecretRequest {
1274
1290
  /**
1275
1291
  * <p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
1276
1292
  * The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>
1277
- * <p>If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
1293
+ * <p>For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
1278
1294
  * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">
1279
1295
  * <code>testSecret</code>
1280
1296
  * step</a> of the Lambda rotation function. The test creates an <code>AWSPENDING</code> version of the secret and then removes it.</p>
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.241.0",
4
+ "version": "3.250.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",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "2.0.0",
22
22
  "@aws-crypto/sha256-js": "2.0.0",
23
- "@aws-sdk/client-sts": "3.241.0",
23
+ "@aws-sdk/client-sts": "3.245.0",
24
24
  "@aws-sdk/config-resolver": "3.234.0",
25
- "@aws-sdk/credential-provider-node": "3.241.0",
25
+ "@aws-sdk/credential-provider-node": "3.245.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.226.0",
27
27
  "@aws-sdk/hash-node": "3.226.0",
28
28
  "@aws-sdk/invalid-dependency": "3.226.0",
@@ -47,7 +47,7 @@
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
48
  "@aws-sdk/util-defaults-mode-browser": "3.234.0",
49
49
  "@aws-sdk/util-defaults-mode-node": "3.234.0",
50
- "@aws-sdk/util-endpoints": "3.241.0",
50
+ "@aws-sdk/util-endpoints": "3.245.0",
51
51
  "@aws-sdk/util-retry": "3.229.0",
52
52
  "@aws-sdk/util-user-agent-browser": "3.226.0",
53
53
  "@aws-sdk/util-user-agent-node": "3.226.0",