@aws-sdk/client-secrets-manager 3.82.0 → 3.89.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +2 -0
  3. package/dist-types/SecretsManager.d.ts +25 -16
  4. package/dist-types/commands/CancelRotateSecretCommand.d.ts +9 -8
  5. package/dist-types/commands/DeleteSecretCommand.d.ts +12 -3
  6. package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +3 -3
  7. package/dist-types/commands/ListSecretsCommand.d.ts +1 -2
  8. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -3,6 +3,33 @@
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.89.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.88.0...v3.89.0) (2022-05-11)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-secrets-manager
9
+
10
+
11
+
12
+
13
+
14
+ # [3.87.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.86.0...v3.87.0) (2022-05-09)
15
+
16
+ **Note:** Version bump only for package @aws-sdk/client-secrets-manager
17
+
18
+
19
+
20
+
21
+
22
+ # [3.85.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.84.0...v3.85.0) (2022-05-05)
23
+
24
+
25
+ ### Features
26
+
27
+ * **codegen:** add codegen indicator comment to all generated files ([#3592](https://github.com/aws/aws-sdk-js-v3/issues/3592)) ([567a530](https://github.com/aws/aws-sdk-js-v3/commit/567a5304232fcc1f9db3fd3df545054de8336b4b))
28
+
29
+
30
+
31
+
32
+
6
33
  # [3.82.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.81.0...v3.82.0) (2022-05-02)
7
34
 
8
35
  **Note:** Version bump only for package @aws-sdk/client-secrets-manager
package/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ <!-- generated file, do not edit directly -->
2
+
1
3
  # @aws-sdk/client-secrets-manager
2
4
 
3
5
  [![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-secrets-manager/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-secrets-manager)
package/dist-types/SecretsManager.d.ts CHANGED
@@ -71,15 +71,16 @@ export declare class SecretsManager extends SecretsManagerClient {
71
71
  /**
72
72
  * <p>Turns off automatic rotation, and if a rotation is currently in
73
73
  * progress, cancels the rotation.</p>
74
+ * <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
75
+ * labels in an unexpected state. You might
76
+ * need to remove the staging label <code>AWSPENDING</code> from the partially created version.
77
+ * You also need to determine whether to roll back to the previous version of the secret
78
+ * by moving the staging label <code>AWSCURRENT</code> to the version that has <code>AWSPENDING</code>.
79
+ * To determine
80
+ * which version has a specific staging label, call <a>ListSecretVersionIds</a>. Then use
81
+ * <a>UpdateSecretVersionStage</a> to change staging labels.
82
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
74
83
  * <p>To turn on automatic rotation again, call <a>RotateSecret</a>.</p>
75
- * <note>
76
- * <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
77
- * labels in an unexpected state. Depending on the step of the rotation in progress, you might
78
- * need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified
79
- * by the <code>VersionId</code> response value. We recommend you also evaluate the partially rotated
80
- * new version to see if it should be deleted. You can delete a version by removing all staging labels
81
- * from it.</p>
82
- * </note>
83
84
  * <p>
84
85
  * <b>Required permissions: </b>
85
86
  * <code>secretsmanager:CancelRotateSecret</code>.
@@ -146,14 +147,23 @@ export declare class SecretsManager extends SecretsManagerClient {
146
147
  * The default recovery window is 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
147
148
  * the secret that specifies the end of the recovery window. At the end of the recovery window,
148
149
  * Secrets Manager deletes the secret permanently.</p>
149
- * <p>For information about deleting a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html">https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html</a>. </p>
150
+ * <p>You can't delete a primary secret that is replicated to other Regions. You must first delete the
151
+ * replicas using <a>RemoveRegionsFromReplication</a>, and then delete the primary secret.
152
+ * When you delete a replica, it is deleted immediately.</p>
153
+ * <p>You can't directly delete a version of a secret. Instead, you remove all staging labels
154
+ * from the version using <a>UpdateSecretVersionStage</a>. This marks the version as deprecated,
155
+ * and then Secrets Manager can automatically delete the version in the background.</p>
156
+ * <p>To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm
157
+ * to alert you to any attempts to access a secret during the recovery window. For more information,
158
+ * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html">
159
+ * Monitor secrets scheduled for deletion</a>.</p>
150
160
  * <p>Secrets Manager performs the permanent secret deletion at the end of the waiting period as a
151
161
  * background task with low priority. There is no guarantee of a specific time after the
152
162
  * recovery window for the permanent delete to occur.</p>
153
163
  * <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to
154
164
  * remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>
155
- * <p>In a secret scheduled for deletion, you cannot access the encrypted secret value.
156
- * To access that information, first cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p>
165
+ * <p>When a secret is scheduled for deletion, you cannot retrieve the secret value.
166
+ * You must first cancel the deletion with <a>RestoreSecret</a> and then you can retrieve the secret.</p>
157
167
  * <p>
158
168
  * <b>Required permissions: </b>
159
169
  * <code>secretsmanager:DeleteSecret</code>.
@@ -232,8 +242,7 @@ export declare class SecretsManager extends SecretsManagerClient {
232
242
  * <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p>
233
243
  * <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>,
234
244
  * call <a>GetSecretValue</a>.</p>
235
- * <p>For information about finding secrets in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Enhanced search capabilities
236
- * for secrets in Secrets Manager</a>.</p>
245
+ * <p>For information about finding secrets in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in Secrets Manager</a>.</p>
237
246
  * <p>
238
247
  * <b>Required permissions: </b>
239
248
  * <code>secretsmanager:ListSecrets</code>.
@@ -245,10 +254,10 @@ export declare class SecretsManager extends SecretsManagerClient {
245
254
  listSecrets(args: ListSecretsCommandInput, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
246
255
  listSecrets(args: ListSecretsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
247
256
  /**
248
- * <p>Lists the versions for a secret. </p>
257
+ * <p>Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions
258
+ * of a secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">
259
+ * Secrets Manager concepts: Versions</a>.</p>
249
260
  * <p>To list the secrets in the account, use <a>ListSecrets</a>.</p>
250
- * <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>,
251
- * call <a>GetSecretValue</a>.</p>
252
261
  * <p>
253
262
  * <b>Required permissions: </b>
254
263
  * <code>secretsmanager:ListSecretVersionIds</code>.
package/dist-types/commands/CancelRotateSecretCommand.d.ts CHANGED
@@ -9,15 +9,16 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
9
9
  /**
10
10
  * <p>Turns off automatic rotation, and if a rotation is currently in
11
11
  * progress, cancels the rotation.</p>
12
+ * <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
13
+ * labels in an unexpected state. You might
14
+ * need to remove the staging label <code>AWSPENDING</code> from the partially created version.
15
+ * You also need to determine whether to roll back to the previous version of the secret
16
+ * by moving the staging label <code>AWSCURRENT</code> to the version that has <code>AWSPENDING</code>.
17
+ * To determine
18
+ * which version has a specific staging label, call <a>ListSecretVersionIds</a>. Then use
19
+ * <a>UpdateSecretVersionStage</a> to change staging labels.
20
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
12
21
  * <p>To turn on automatic rotation again, call <a>RotateSecret</a>.</p>
13
- * <note>
14
- * <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
15
- * labels in an unexpected state. Depending on the step of the rotation in progress, you might
16
- * need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified
17
- * by the <code>VersionId</code> response value. We recommend you also evaluate the partially rotated
18
- * new version to see if it should be deleted. You can delete a version by removing all staging labels
19
- * from it.</p>
20
- * </note>
21
22
  * <p>
22
23
  * <b>Required permissions: </b>
23
24
  * <code>secretsmanager:CancelRotateSecret</code>.
package/dist-types/commands/DeleteSecretCommand.d.ts CHANGED
@@ -12,14 +12,23 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
12
12
  * The default recovery window is 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
13
13
  * the secret that specifies the end of the recovery window. At the end of the recovery window,
14
14
  * Secrets Manager deletes the secret permanently.</p>
15
- * <p>For information about deleting a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html">https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html</a>. </p>
15
+ * <p>You can't delete a primary secret that is replicated to other Regions. You must first delete the
16
+ * replicas using <a>RemoveRegionsFromReplication</a>, and then delete the primary secret.
17
+ * When you delete a replica, it is deleted immediately.</p>
18
+ * <p>You can't directly delete a version of a secret. Instead, you remove all staging labels
19
+ * from the version using <a>UpdateSecretVersionStage</a>. This marks the version as deprecated,
20
+ * and then Secrets Manager can automatically delete the version in the background.</p>
21
+ * <p>To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm
22
+ * to alert you to any attempts to access a secret during the recovery window. For more information,
23
+ * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html">
24
+ * Monitor secrets scheduled for deletion</a>.</p>
16
25
  * <p>Secrets Manager performs the permanent secret deletion at the end of the waiting period as a
17
26
  * background task with low priority. There is no guarantee of a specific time after the
18
27
  * recovery window for the permanent delete to occur.</p>
19
28
  * <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to
20
29
  * remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>
21
- * <p>In a secret scheduled for deletion, you cannot access the encrypted secret value.
22
- * To access that information, first cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p>
30
+ * <p>When a secret is scheduled for deletion, you cannot retrieve the secret value.
31
+ * You must first cancel the deletion with <a>RestoreSecret</a> and then you can retrieve the secret.</p>
23
32
  * <p>
24
33
  * <b>Required permissions: </b>
25
34
  * <code>secretsmanager:DeleteSecret</code>.
package/dist-types/commands/ListSecretVersionIdsCommand.d.ts CHANGED
@@ -7,10 +7,10 @@ export interface ListSecretVersionIdsCommandInput extends ListSecretVersionIdsRe
7
7
  export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the versions for a secret. </p>
10
+ * <p>Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions
11
+ * of a secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">
12
+ * Secrets Manager concepts: Versions</a>.</p>
11
13
  * <p>To list the secrets in the account, use <a>ListSecrets</a>.</p>
12
- * <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>,
13
- * call <a>GetSecretValue</a>.</p>
14
14
  * <p>
15
15
  * <b>Required permissions: </b>
16
16
  * <code>secretsmanager:ListSecretVersionIds</code>.
package/dist-types/commands/ListSecretsCommand.d.ts CHANGED
@@ -12,8 +12,7 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
12
12
  * <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p>
13
13
  * <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>,
14
14
  * call <a>GetSecretValue</a>.</p>
15
- * <p>For information about finding secrets in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Enhanced search capabilities
16
- * for secrets in Secrets Manager</a>.</p>
15
+ * <p>For information about finding secrets in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in Secrets Manager</a>.</p>
17
16
  * <p>
18
17
  * <b>Required permissions: </b>
19
18
  * <code>secretsmanager:ListSecrets</code>.
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.82.0",
4
+ "version": "3.89.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",
@@ -18,9 +18,9 @@
18
18
  "dependencies": {
19
19
  "@aws-crypto/sha256-browser": "2.0.0",
20
20
  "@aws-crypto/sha256-js": "2.0.0",
21
- "@aws-sdk/client-sts": "3.82.0",
21
+ "@aws-sdk/client-sts": "3.87.0",
22
22
  "@aws-sdk/config-resolver": "3.80.0",
23
- "@aws-sdk/credential-provider-node": "3.82.0",
23
+ "@aws-sdk/credential-provider-node": "3.87.0",
24
24
  "@aws-sdk/fetch-http-handler": "3.78.0",
25
25
  "@aws-sdk/hash-node": "3.78.0",
26
26
  "@aws-sdk/invalid-dependency": "3.78.0",
@@ -35,15 +35,15 @@
35
35
  "@aws-sdk/node-config-provider": "3.80.0",
36
36
  "@aws-sdk/node-http-handler": "3.82.0",
37
37
  "@aws-sdk/protocol-http": "3.78.0",
38
- "@aws-sdk/smithy-client": "3.78.0",
38
+ "@aws-sdk/smithy-client": "3.85.0",
39
39
  "@aws-sdk/types": "3.78.0",
40
40
  "@aws-sdk/url-parser": "3.78.0",
41
41
  "@aws-sdk/util-base64-browser": "3.58.0",
42
42
  "@aws-sdk/util-base64-node": "3.55.0",
43
43
  "@aws-sdk/util-body-length-browser": "3.55.0",
44
44
  "@aws-sdk/util-body-length-node": "3.55.0",
45
- "@aws-sdk/util-defaults-mode-browser": "3.78.0",
46
- "@aws-sdk/util-defaults-mode-node": "3.81.0",
45
+ "@aws-sdk/util-defaults-mode-browser": "3.85.0",
46
+ "@aws-sdk/util-defaults-mode-node": "3.85.0",
47
47
  "@aws-sdk/util-user-agent-browser": "3.78.0",
48
48
  "@aws-sdk/util-user-agent-node": "3.80.0",
49
49
  "@aws-sdk/util-utf8-browser": "3.55.0",