@aws-sdk/client-secrets-manager 3.74.0 → 3.78.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 (30) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist-cjs/pagination/ListSecretVersionIdsPaginator.js +2 -1
  3. package/dist-cjs/pagination/ListSecretsPaginator.js +2 -1
  4. package/dist-es/pagination/ListSecretVersionIdsPaginator.js +3 -2
  5. package/dist-es/pagination/ListSecretsPaginator.js +3 -2
  6. package/dist-types/SecretsManager.d.ts +48 -34
  7. package/dist-types/commands/CancelRotateSecretCommand.d.ts +1 -1
  8. package/dist-types/commands/CreateSecretCommand.d.ts +10 -4
  9. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +1 -1
  10. package/dist-types/commands/DeleteSecretCommand.d.ts +1 -1
  11. package/dist-types/commands/DescribeSecretCommand.d.ts +1 -1
  12. package/dist-types/commands/GetRandomPasswordCommand.d.ts +1 -1
  13. package/dist-types/commands/GetResourcePolicyCommand.d.ts +1 -1
  14. package/dist-types/commands/GetSecretValueCommand.d.ts +1 -1
  15. package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +1 -1
  16. package/dist-types/commands/ListSecretsCommand.d.ts +1 -1
  17. package/dist-types/commands/PutResourcePolicyCommand.d.ts +1 -1
  18. package/dist-types/commands/PutSecretValueCommand.d.ts +1 -1
  19. package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +1 -1
  20. package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +1 -1
  21. package/dist-types/commands/RestoreSecretCommand.d.ts +1 -1
  22. package/dist-types/commands/RotateSecretCommand.d.ts +18 -10
  23. package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +1 -1
  24. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  25. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  26. package/dist-types/commands/UpdateSecretCommand.d.ts +1 -1
  27. package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +1 -1
  28. package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +1 -1
  29. package/dist-types/models/models_0.d.ts +15 -15
  30. package/package.json +25 -25
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.78.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.77.0...v3.78.0) (2022-04-26)
7
+
8
+
9
+ ### Features
10
+
11
+ * **types:** add pagination stopOnSameToken option ([#3524](https://github.com/aws/aws-sdk-js-v3/issues/3524)) ([9bf73e8](https://github.com/aws/aws-sdk-js-v3/commit/9bf73e81b8d9be9f12c72cbefbe26c502d1873c6))
12
+
13
+
14
+
15
+
16
+
17
+ # [3.76.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.75.0...v3.76.0) (2022-04-22)
18
+
19
+ **Note:** Version bump only for package @aws-sdk/client-secrets-manager
20
+
21
+
22
+
23
+
24
+
25
+ # [3.75.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.74.0...v3.75.0) (2022-04-21)
26
+
27
+ **Note:** Version bump only for package @aws-sdk/client-secrets-manager
28
+
29
+
30
+
31
+
32
+
6
33
  # [3.74.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.73.0...v3.74.0) (2022-04-20)
7
34
 
8
35
  **Note:** Version bump only for package @aws-sdk/client-secrets-manager
package/dist-cjs/pagination/ListSecretVersionIdsPaginator.js CHANGED
@@ -27,8 +27,9 @@ async function* paginateListSecretVersionIds(config, input, ...additionalArgumen
27
27
  throw new Error("Invalid client, expected SecretsManager | SecretsManagerClient");
28
28
  }
29
29
  yield page;
30
+ const prevToken = token;
30
31
  token = page.NextToken;
31
- hasNext = !!token;
32
+ hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken));
32
33
  }
33
34
  return undefined;
34
35
  }
package/dist-cjs/pagination/ListSecretsPaginator.js CHANGED
@@ -27,8 +27,9 @@ async function* paginateListSecrets(config, input, ...additionalArguments) {
27
27
  throw new Error("Invalid client, expected SecretsManager | SecretsManagerClient");
28
28
  }
29
29
  yield page;
30
+ const prevToken = token;
30
31
  token = page.NextToken;
31
- hasNext = !!token;
32
+ hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken));
32
33
  }
33
34
  return undefined;
34
35
  }
package/dist-es/pagination/ListSecretVersionIdsPaginator.js CHANGED
@@ -36,7 +36,7 @@ export function paginateListSecretVersionIds(config, input) {
36
36
  additionalArguments[_i - 2] = arguments[_i];
37
37
  }
38
38
  return __asyncGenerator(this, arguments, function paginateListSecretVersionIds_1() {
39
- var token, hasNext, page;
39
+ var token, hasNext, page, prevToken;
40
40
  return __generator(this, function (_a) {
41
41
  switch (_a.label) {
42
42
  case 0:
@@ -63,8 +63,9 @@ export function paginateListSecretVersionIds(config, input) {
63
63
  case 7: return [4, _a.sent()];
64
64
  case 8:
65
65
  _a.sent();
66
+ prevToken = token;
66
67
  token = page.NextToken;
67
- hasNext = !!token;
68
+ hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken));
68
69
  return [3, 1];
69
70
  case 9: return [4, __await(undefined)];
70
71
  case 10: return [2, _a.sent()];
package/dist-es/pagination/ListSecretsPaginator.js CHANGED
@@ -36,7 +36,7 @@ export function paginateListSecrets(config, input) {
36
36
  additionalArguments[_i - 2] = arguments[_i];
37
37
  }
38
38
  return __asyncGenerator(this, arguments, function paginateListSecrets_1() {
39
- var token, hasNext, page;
39
+ var token, hasNext, page, prevToken;
40
40
  return __generator(this, function (_a) {
41
41
  switch (_a.label) {
42
42
  case 0:
@@ -63,8 +63,9 @@ export function paginateListSecrets(config, input) {
63
63
  case 7: return [4, _a.sent()];
64
64
  case 8:
65
65
  _a.sent();
66
+ prevToken = token;
66
67
  token = page.NextToken;
67
- hasNext = !!token;
68
+ hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken));
68
69
  return [3, 1];
69
70
  case 9: return [4, __await(undefined)];
70
71
  case 10: return [2, _a.sent()];
package/dist-types/SecretsManager.d.ts CHANGED
@@ -83,7 +83,7 @@ export declare class SecretsManager extends SecretsManagerClient {
83
83
  * <p>
84
84
  * <b>Required permissions: </b>
85
85
  * <code>secretsmanager:CancelRotateSecret</code>.
86
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
86
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
87
87
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
88
88
  * and access control in Secrets Manager</a>. </p>
89
89
  */
@@ -91,8 +91,9 @@ export declare class SecretsManager extends SecretsManagerClient {
91
91
  cancelRotateSecret(args: CancelRotateSecretCommandInput, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void): void;
92
92
  cancelRotateSecret(args: CancelRotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void): void;
93
93
  /**
94
- * <p>Creates a new secret. A <i>secret</i> is a set of credentials, such as a
95
- * user name and password, that you store in an encrypted form in Secrets Manager. The secret also
94
+ * <p>Creates a new secret. A <i>secret</i> can be a password, a set of
95
+ * credentials such as a user name and password, an OAuth token, or other secret information
96
+ * that you store in an encrypted form in Secrets Manager. The secret also
96
97
  * includes the connection information to access a database or other service, which Secrets Manager
97
98
  * doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
98
99
  * important information needed to manage the secret.</p>
@@ -102,6 +103,9 @@ export declare class SecretsManager extends SecretsManagerClient {
102
103
  * If you include <code>SecretString</code> or <code>SecretBinary</code>
103
104
  * then Secrets Manager creates an initial secret version and automatically attaches the staging
104
105
  * label <code>AWSCURRENT</code> to it.</p>
106
+ * <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,
107
+ * you must make sure the JSON you store in the <code>SecretString</code> matches the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html">JSON structure of
108
+ * a database secret</a>.</p>
105
109
  * <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
106
110
  * <code>aws/secretsmanager</code>. If this key
107
111
  * doesn't already exist in your account, then Secrets Manager creates it for you automatically. All
@@ -113,10 +117,12 @@ export declare class SecretsManager extends SecretsManagerClient {
113
117
  * and use a customer managed KMS key. </p>
114
118
  * <p>
115
119
  * <b>Required permissions: </b>
116
- * <code>secretsmanager:CreateSecret</code>.
117
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
120
+ * <code>secretsmanager:CreateSecret</code>. If you
121
+ * include tags in the secret, you also need <code>secretsmanager:TagResource</code>.
122
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
118
123
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
119
124
  * and access control in Secrets Manager</a>. </p>
125
+ * <p>To encrypt the secret with a KMS key other than <code>aws/secretsmanager</code>, you need <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permission to the key. </p>
120
126
  */
121
127
  createSecret(args: CreateSecretCommandInput, options?: __HttpHandlerOptions): Promise<CreateSecretCommandOutput>;
122
128
  createSecret(args: CreateSecretCommandInput, cb: (err: any, data?: CreateSecretCommandOutput) => void): void;
@@ -127,7 +133,7 @@ export declare class SecretsManager extends SecretsManagerClient {
127
133
  * <p>
128
134
  * <b>Required permissions: </b>
129
135
  * <code>secretsmanager:DeleteResourcePolicy</code>.
130
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
136
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
131
137
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
132
138
  * and access control in Secrets Manager</a>. </p>
133
139
  */
@@ -151,7 +157,7 @@ export declare class SecretsManager extends SecretsManagerClient {
151
157
  * <p>
152
158
  * <b>Required permissions: </b>
153
159
  * <code>secretsmanager:DeleteSecret</code>.
154
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
160
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
155
161
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
156
162
  * and access control in Secrets Manager</a>. </p>
157
163
  */
@@ -164,7 +170,7 @@ export declare class SecretsManager extends SecretsManagerClient {
164
170
  * <p>
165
171
  * <b>Required permissions: </b>
166
172
  * <code>secretsmanager:DescribeSecret</code>.
167
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
173
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
168
174
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
169
175
  * and access control in Secrets Manager</a>. </p>
170
176
  */
@@ -178,7 +184,7 @@ export declare class SecretsManager extends SecretsManagerClient {
178
184
  * <p>
179
185
  * <b>Required permissions: </b>
180
186
  * <code>secretsmanager:GetRandomPassword</code>.
181
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
187
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
182
188
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
183
189
  * and access control in Secrets Manager</a>. </p>
184
190
  */
@@ -193,7 +199,7 @@ export declare class SecretsManager extends SecretsManagerClient {
193
199
  * <p>
194
200
  * <b>Required permissions: </b>
195
201
  * <code>secretsmanager:GetResourcePolicy</code>.
196
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
202
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
197
203
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
198
204
  * and access control in Secrets Manager</a>. </p>
199
205
  */
@@ -213,7 +219,7 @@ export declare class SecretsManager extends SecretsManagerClient {
213
219
  * <code>secretsmanager:GetSecretValue</code>.
214
220
  * If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key
215
221
  * <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code> permissions for that key.
216
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
222
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
217
223
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
218
224
  * and access control in Secrets Manager</a>. </p>
219
225
  */
@@ -231,7 +237,7 @@ export declare class SecretsManager extends SecretsManagerClient {
231
237
  * <p>
232
238
  * <b>Required permissions: </b>
233
239
  * <code>secretsmanager:ListSecrets</code>.
234
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
240
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
235
241
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
236
242
  * and access control in Secrets Manager</a>. </p>
237
243
  */
@@ -246,7 +252,7 @@ export declare class SecretsManager extends SecretsManagerClient {
246
252
  * <p>
247
253
  * <b>Required permissions: </b>
248
254
  * <code>secretsmanager:ListSecretVersionIds</code>.
249
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
255
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
250
256
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
251
257
  * and access control in Secrets Manager</a>. </p>
252
258
  */
@@ -262,7 +268,7 @@ export declare class SecretsManager extends SecretsManagerClient {
262
268
  * <p>
263
269
  * <b>Required permissions: </b>
264
270
  * <code>secretsmanager:PutResourcePolicy</code>.
265
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
271
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
266
272
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
267
273
  * and access control in Secrets Manager</a>. </p>
268
274
  */
@@ -294,7 +300,7 @@ export declare class SecretsManager extends SecretsManagerClient {
294
300
  * <p>
295
301
  * <b>Required permissions: </b>
296
302
  * <code>secretsmanager:PutSecretValue</code>.
297
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
303
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
298
304
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
299
305
  * and access control in Secrets Manager</a>. </p>
300
306
  */
@@ -306,7 +312,7 @@ export declare class SecretsManager extends SecretsManagerClient {
306
312
  * <p>
307
313
  * <b>Required permissions: </b>
308
314
  * <code>secretsmanager:RemoveRegionsFromReplication</code>.
309
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
315
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
310
316
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
311
317
  * and access control in Secrets Manager</a>. </p>
312
318
  */
@@ -318,7 +324,7 @@ export declare class SecretsManager extends SecretsManagerClient {
318
324
  * <p>
319
325
  * <b>Required permissions: </b>
320
326
  * <code>secretsmanager:ReplicateSecretToRegions</code>.
321
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
327
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
322
328
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
323
329
  * and access control in Secrets Manager</a>. </p>
324
330
  */
@@ -331,7 +337,7 @@ export declare class SecretsManager extends SecretsManagerClient {
331
337
  * <p>
332
338
  * <b>Required permissions: </b>
333
339
  * <code>secretsmanager:RestoreSecret</code>.
334
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
340
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
335
341
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
336
342
  * and access control in Secrets Manager</a>. </p>
337
343
  */
@@ -339,27 +345,35 @@ export declare class SecretsManager extends SecretsManagerClient {
339
345
  restoreSecret(args: RestoreSecretCommandInput, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
340
346
  restoreSecret(args: RestoreSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
341
347
  /**
342
- * <p>Configures and starts the asynchronous process of rotating the secret.</p>
348
+ * <p>Configures and starts the asynchronous process of rotating the secret. For more information about rotation,
349
+ * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>.</p>
343
350
  * <p>If you include the
344
351
  * configuration parameters, the operation sets the values for the secret and then immediately
345
352
  * starts a rotation. If you don't include the configuration parameters, the operation starts a
346
- * rotation with the values already stored in the secret. For more information about rotation,
347
- * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>.</p>
348
- * <p>To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule
353
+ * rotation with the values already stored in the secret. </p>
354
+ * <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must
355
+ * make sure the secret value is in the
356
+ * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html"> JSON structure
357
+ * 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
358
+ * secret.</p>
359
+ *
360
+ * <p>To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule
349
361
  * for the rotation. The Lambda rotation function creates a new
350
362
  * version of the secret and creates or updates the credentials on the database or service to
351
363
  * match. After testing the new credentials, the function marks the new secret version with the staging
352
364
  * label <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more
353
365
  * information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
354
- * <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached to the same
355
- * version as the <code>AWSCURRENT</code> version, or it might not be attached to any version.</p>
356
- * <p>If the <code>AWSPENDING</code> staging label is present but not attached to the same version as
357
- * <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code> assumes that a previous
358
- * rotation request is still in progress and returns an error.</p>
366
+ * <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
367
+ * a template that matches your <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html">Rotation strategy</a>.</p>
368
+ * <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
369
+ * to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any
370
+ * version. If the <code>AWSPENDING</code> staging label is present but not attached to the same
371
+ * version as <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code>
372
+ * assumes that a previous rotation request is still in progress and returns an error.</p>
359
373
  * <p>
360
374
  * <b>Required permissions: </b>
361
375
  * <code>secretsmanager:RotateSecret</code>.
362
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
376
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
363
377
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
364
378
  * and access control in Secrets Manager</a>. You also need <code>lambda:InvokeFunction</code> permissions on the rotation function.
365
379
  * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html">
@@ -374,7 +388,7 @@ export declare class SecretsManager extends SecretsManagerClient {
374
388
  * <p>
375
389
  * <b>Required permissions: </b>
376
390
  * <code>secretsmanager:StopReplicationToReplica</code>.
377
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
391
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
378
392
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
379
393
  * and access control in Secrets Manager</a>. </p>
380
394
  */
@@ -420,7 +434,7 @@ export declare class SecretsManager extends SecretsManagerClient {
420
434
  * <p>
421
435
  * <b>Required permissions: </b>
422
436
  * <code>secretsmanager:TagResource</code>.
423
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
437
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
424
438
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
425
439
  * and access control in Secrets Manager</a>. </p>
426
440
  */
@@ -440,7 +454,7 @@ export declare class SecretsManager extends SecretsManagerClient {
440
454
  * <p>
441
455
  * <b>Required permissions: </b>
442
456
  * <code>secretsmanager:UntagResource</code>.
443
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
457
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
444
458
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
445
459
  * and access control in Secrets Manager</a>. </p>
446
460
  */
@@ -474,7 +488,7 @@ export declare class SecretsManager extends SecretsManagerClient {
474
488
  * <p>
475
489
  * <b>Required permissions: </b>
476
490
  * <code>secretsmanager:UpdateSecret</code>.
477
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
491
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
478
492
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
479
493
  * and access control in Secrets Manager</a>.
480
494
  * If you use a customer managed key, you must also have <code>kms:GenerateDataKey</code> and
@@ -503,7 +517,7 @@ export declare class SecretsManager extends SecretsManagerClient {
503
517
  * <p>
504
518
  * <b>Required permissions: </b>
505
519
  * <code>secretsmanager:UpdateSecretVersionStage</code>.
506
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
520
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
507
521
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
508
522
  * and access control in Secrets Manager</a>. </p>
509
523
  */
@@ -529,7 +543,7 @@ export declare class SecretsManager extends SecretsManagerClient {
529
543
  * <p>
530
544
  * <b>Required permissions: </b>
531
545
  * <code>secretsmanager:ValidateResourcePolicy</code>.
532
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
546
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
533
547
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
534
548
  * and access control in Secrets Manager</a>. </p>
535
549
  */
package/dist-types/commands/CancelRotateSecretCommand.d.ts CHANGED
@@ -21,7 +21,7 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
21
21
  * <p>
22
22
  * <b>Required permissions: </b>
23
23
  * <code>secretsmanager:CancelRotateSecret</code>.
24
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
24
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
25
25
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
26
26
  * and access control in Secrets Manager</a>. </p>
27
27
  * @example
package/dist-types/commands/CreateSecretCommand.d.ts CHANGED
@@ -7,8 +7,9 @@ export interface CreateSecretCommandInput extends CreateSecretRequest {
7
7
  export interface CreateSecretCommandOutput extends CreateSecretResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a new secret. A <i>secret</i> is a set of credentials, such as a
11
- * user name and password, that you store in an encrypted form in Secrets Manager. The secret also
10
+ * <p>Creates a new secret. A <i>secret</i> can be a password, a set of
11
+ * credentials such as a user name and password, an OAuth token, or other secret information
12
+ * that you store in an encrypted form in Secrets Manager. The secret also
12
13
  * includes the connection information to access a database or other service, which Secrets Manager
13
14
  * doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
14
15
  * important information needed to manage the secret.</p>
@@ -18,6 +19,9 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
18
19
  * If you include <code>SecretString</code> or <code>SecretBinary</code>
19
20
  * then Secrets Manager creates an initial secret version and automatically attaches the staging
20
21
  * label <code>AWSCURRENT</code> to it.</p>
22
+ * <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,
23
+ * you must make sure the JSON you store in the <code>SecretString</code> matches the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html">JSON structure of
24
+ * a database secret</a>.</p>
21
25
  * <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
22
26
  * <code>aws/secretsmanager</code>. If this key
23
27
  * doesn't already exist in your account, then Secrets Manager creates it for you automatically. All
@@ -29,10 +33,12 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
29
33
  * and use a customer managed KMS key. </p>
30
34
  * <p>
31
35
  * <b>Required permissions: </b>
32
- * <code>secretsmanager:CreateSecret</code>.
33
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
36
+ * <code>secretsmanager:CreateSecret</code>. If you
37
+ * include tags in the secret, you also need <code>secretsmanager:TagResource</code>.
38
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
34
39
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
35
40
  * and access control in Secrets Manager</a>. </p>
41
+ * <p>To encrypt the secret with a KMS key other than <code>aws/secretsmanager</code>, you need <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permission to the key. </p>
36
42
  * @example
37
43
  * Use a bare-bones client and the command you need to make an API call.
38
44
  * ```javascript
package/dist-types/commands/DeleteResourcePolicyCommand.d.ts CHANGED
@@ -12,7 +12,7 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
12
12
  * <p>
13
13
  * <b>Required permissions: </b>
14
14
  * <code>secretsmanager:DeleteResourcePolicy</code>.
15
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
15
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
16
16
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
17
17
  * and access control in Secrets Manager</a>. </p>
18
18
  * @example
package/dist-types/commands/DeleteSecretCommand.d.ts CHANGED
@@ -23,7 +23,7 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
23
23
  * <p>
24
24
  * <b>Required permissions: </b>
25
25
  * <code>secretsmanager:DeleteSecret</code>.
26
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
26
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
27
27
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
28
28
  * and access control in Secrets Manager</a>. </p>
29
29
  * @example
package/dist-types/commands/DescribeSecretCommand.d.ts CHANGED
@@ -12,7 +12,7 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
12
12
  * <p>
13
13
  * <b>Required permissions: </b>
14
14
  * <code>secretsmanager:DescribeSecret</code>.
15
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
15
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
16
16
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
17
17
  * and access control in Secrets Manager</a>. </p>
18
18
  * @example
package/dist-types/commands/GetRandomPasswordCommand.d.ts CHANGED
@@ -13,7 +13,7 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
13
13
  * <p>
14
14
  * <b>Required permissions: </b>
15
15
  * <code>secretsmanager:GetRandomPassword</code>.
16
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
16
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
17
17
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
18
18
  * and access control in Secrets Manager</a>. </p>
19
19
  * @example
package/dist-types/commands/GetResourcePolicyCommand.d.ts CHANGED
@@ -14,7 +14,7 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
14
14
  * <p>
15
15
  * <b>Required permissions: </b>
16
16
  * <code>secretsmanager:GetResourcePolicy</code>.
17
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
17
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
18
18
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
19
19
  * and access control in Secrets Manager</a>. </p>
20
20
  * @example
package/dist-types/commands/GetSecretValueCommand.d.ts CHANGED
@@ -19,7 +19,7 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
19
19
  * <code>secretsmanager:GetSecretValue</code>.
20
20
  * If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key
21
21
  * <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code> permissions for that key.
22
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
22
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
23
23
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
24
24
  * and access control in Secrets Manager</a>. </p>
25
25
  * @example
package/dist-types/commands/ListSecretVersionIdsCommand.d.ts CHANGED
@@ -14,7 +14,7 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
14
14
  * <p>
15
15
  * <b>Required permissions: </b>
16
16
  * <code>secretsmanager:ListSecretVersionIds</code>.
17
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
17
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
18
18
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
19
19
  * and access control in Secrets Manager</a>. </p>
20
20
  * @example
package/dist-types/commands/ListSecretsCommand.d.ts CHANGED
@@ -17,7 +17,7 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
17
17
  * <p>
18
18
  * <b>Required permissions: </b>
19
19
  * <code>secretsmanager:ListSecrets</code>.
20
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
20
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
21
21
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
22
22
  * and access control in Secrets Manager</a>. </p>
23
23
  * @example
package/dist-types/commands/PutResourcePolicyCommand.d.ts CHANGED
@@ -15,7 +15,7 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
15
15
  * <p>
16
16
  * <b>Required permissions: </b>
17
17
  * <code>secretsmanager:PutResourcePolicy</code>.
18
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
18
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
19
19
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
20
20
  * and access control in Secrets Manager</a>. </p>
21
21
  * @example
package/dist-types/commands/PutSecretValueCommand.d.ts CHANGED
@@ -31,7 +31,7 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
31
31
  * <p>
32
32
  * <b>Required permissions: </b>
33
33
  * <code>secretsmanager:PutSecretValue</code>.
34
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
34
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
35
35
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
36
36
  * and access control in Secrets Manager</a>. </p>
37
37
  * @example
package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts CHANGED
@@ -11,7 +11,7 @@ export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegions
11
11
  * <p>
12
12
  * <b>Required permissions: </b>
13
13
  * <code>secretsmanager:RemoveRegionsFromReplication</code>.
14
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
14
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
15
15
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
16
16
  * and access control in Secrets Manager</a>. </p>
17
17
  * @example
package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts CHANGED
@@ -11,7 +11,7 @@ export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretTo
11
11
  * <p>
12
12
  * <b>Required permissions: </b>
13
13
  * <code>secretsmanager:ReplicateSecretToRegions</code>.
14
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
14
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
15
15
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
16
16
  * and access control in Secrets Manager</a>. </p>
17
17
  * @example
package/dist-types/commands/RestoreSecretCommand.d.ts CHANGED
@@ -12,7 +12,7 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
12
12
  * <p>
13
13
  * <b>Required permissions: </b>
14
14
  * <code>secretsmanager:RestoreSecret</code>.
15
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
15
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
16
16
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
17
17
  * and access control in Secrets Manager</a>. </p>
18
18
  * @example
package/dist-types/commands/RotateSecretCommand.d.ts CHANGED
@@ -7,27 +7,35 @@ export interface RotateSecretCommandInput extends RotateSecretRequest {
7
7
  export interface RotateSecretCommandOutput extends RotateSecretResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Configures and starts the asynchronous process of rotating the secret.</p>
10
+ * <p>Configures and starts the asynchronous process of rotating the secret. For more information about rotation,
11
+ * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>.</p>
11
12
  * <p>If you include the
12
13
  * configuration parameters, the operation sets the values for the secret and then immediately
13
14
  * starts a rotation. If you don't include the configuration parameters, the operation starts a
14
- * rotation with the values already stored in the secret. For more information about rotation,
15
- * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>.</p>
16
- * <p>To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule
15
+ * rotation with the values already stored in the secret. </p>
16
+ * <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must
17
+ * make sure the secret value is in the
18
+ * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html"> JSON structure
19
+ * 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
20
+ * secret.</p>
21
+ *
22
+ * <p>To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule
17
23
  * for the rotation. The Lambda rotation function creates a new
18
24
  * version of the secret and creates or updates the credentials on the database or service to
19
25
  * match. After testing the new credentials, the function marks the new secret version with the staging
20
26
  * label <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more
21
27
  * information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
22
- * <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached to the same
23
- * version as the <code>AWSCURRENT</code> version, or it might not be attached to any version.</p>
24
- * <p>If the <code>AWSPENDING</code> staging label is present but not attached to the same version as
25
- * <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code> assumes that a previous
26
- * rotation request is still in progress and returns an error.</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>
30
+ * <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
31
+ * to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any
32
+ * version. If the <code>AWSPENDING</code> staging label is present but not attached to the same
33
+ * 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>
27
35
  * <p>
28
36
  * <b>Required permissions: </b>
29
37
  * <code>secretsmanager:RotateSecret</code>.
30
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
38
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
31
39
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
32
40
  * and access control in Secrets Manager</a>. You also need <code>lambda:InvokeFunction</code> permissions on the rotation function.
33
41
  * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html">
package/dist-types/commands/StopReplicationToReplicaCommand.d.ts CHANGED
@@ -12,7 +12,7 @@ export interface StopReplicationToReplicaCommandOutput extends StopReplicationTo
12
12
  * <p>
13
13
  * <b>Required permissions: </b>
14
14
  * <code>secretsmanager:StopReplicationToReplica</code>.
15
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
15
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
16
16
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
17
17
  * and access control in Secrets Manager</a>. </p>
18
18
  * @example
package/dist-types/commands/TagResourceCommand.d.ts CHANGED
@@ -45,7 +45,7 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
45
45
  * <p>
46
46
  * <b>Required permissions: </b>
47
47
  * <code>secretsmanager:TagResource</code>.
48
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
48
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
49
49
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
50
50
  * and access control in Secrets Manager</a>. </p>
51
51
  * @example
package/dist-types/commands/UntagResourceCommand.d.ts CHANGED
@@ -19,7 +19,7 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
19
19
  * <p>
20
20
  * <b>Required permissions: </b>
21
21
  * <code>secretsmanager:UntagResource</code>.
22
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
22
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
23
23
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
24
24
  * and access control in Secrets Manager</a>. </p>
25
25
  * @example
package/dist-types/commands/UpdateSecretCommand.d.ts CHANGED
@@ -33,7 +33,7 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
33
33
  * <p>
34
34
  * <b>Required permissions: </b>
35
35
  * <code>secretsmanager:UpdateSecret</code>.
36
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
36
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
37
37
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
38
38
  * and access control in Secrets Manager</a>.
39
39
  * If you use a customer managed key, you must also have <code>kms:GenerateDataKey</code> and
package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts CHANGED
@@ -25,7 +25,7 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
25
25
  * <p>
26
26
  * <b>Required permissions: </b>
27
27
  * <code>secretsmanager:UpdateSecretVersionStage</code>.
28
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
28
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
29
29
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
30
30
  * and access control in Secrets Manager</a>. </p>
31
31
  * @example
package/dist-types/commands/ValidateResourcePolicyCommand.d.ts CHANGED
@@ -25,7 +25,7 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
25
25
  * <p>
26
26
  * <b>Required permissions: </b>
27
27
  * <code>secretsmanager:ValidateResourcePolicy</code>.
28
- * For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions">
28
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
29
29
  * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
30
30
  * and access control in Secrets Manager</a>. </p>
31
31
  * @example
package/dist-types/models/models_0.d.ts CHANGED
@@ -23,7 +23,7 @@ export interface CancelRotateSecretRequest {
23
23
  /**
24
24
  * <p>The ARN or name of the secret.</p>
25
25
  * <p>For an ARN, we recommend that you specify a complete ARN rather
26
- * than a partial ARN.</p>
26
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
27
27
  */
28
28
  SecretId: string | undefined;
29
29
  }
@@ -435,7 +435,7 @@ export interface DeleteResourcePolicyRequest {
435
435
  /**
436
436
  * <p>The ARN or name of the secret to delete the attached resource-based policy for.</p>
437
437
  * <p>For an ARN, we recommend that you specify a complete ARN rather
438
- * than a partial ARN.</p>
438
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
439
439
  */
440
440
  SecretId: string | undefined;
441
441
  }
@@ -465,7 +465,7 @@ export interface DeleteSecretRequest {
465
465
  /**
466
466
  * <p>The ARN or name of the secret to delete.</p>
467
467
  * <p>For an ARN, we recommend that you specify a complete ARN rather
468
- * than a partial ARN.</p>
468
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
469
469
  */
470
470
  SecretId: string | undefined;
471
471
  /**
@@ -523,7 +523,7 @@ export interface DescribeSecretRequest {
523
523
  /**
524
524
  * <p>The ARN or name of the secret. </p>
525
525
  * <p>For an ARN, we recommend that you specify a complete ARN rather
526
- * than a partial ARN.</p>
526
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
527
527
  */
528
528
  SecretId: string | undefined;
529
529
  }
@@ -822,7 +822,7 @@ export interface GetResourcePolicyRequest {
822
822
  /**
823
823
  * <p>The ARN or name of the secret to retrieve the attached resource-based policy for.</p>
824
824
  * <p>For an ARN, we recommend that you specify a complete ARN rather
825
- * than a partial ARN.</p>
825
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
826
826
  */
827
827
  SecretId: string | undefined;
828
828
  }
@@ -858,7 +858,7 @@ export interface GetSecretValueRequest {
858
858
  /**
859
859
  * <p>The ARN or name of the secret to retrieve.</p>
860
860
  * <p>For an ARN, we recommend that you specify a complete ARN rather
861
- * than a partial ARN.</p>
861
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
862
862
  */
863
863
  SecretId: string | undefined;
864
864
  /**
@@ -1106,7 +1106,7 @@ export interface ListSecretVersionIdsRequest {
1106
1106
  /**
1107
1107
  * <p>The ARN or name of the secret whose versions you want to list.</p>
1108
1108
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1109
- * than a partial ARN.</p>
1109
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1110
1110
  */
1111
1111
  SecretId: string | undefined;
1112
1112
  /**
@@ -1210,7 +1210,7 @@ export interface PutResourcePolicyRequest {
1210
1210
  /**
1211
1211
  * <p>The ARN or name of the secret to attach the resource-based policy.</p>
1212
1212
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1213
- * than a partial ARN.</p>
1213
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1214
1214
  */
1215
1215
  SecretId: string | undefined;
1216
1216
  /**
@@ -1250,7 +1250,7 @@ export interface PutSecretValueRequest {
1250
1250
  /**
1251
1251
  * <p>The ARN or name of the secret to add a new version to.</p>
1252
1252
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1253
- * than a partial ARN.</p>
1253
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1254
1254
  * <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
1255
1255
  */
1256
1256
  SecretId: string | undefined;
@@ -1420,7 +1420,7 @@ export interface RestoreSecretRequest {
1420
1420
  /**
1421
1421
  * <p>The ARN or name of the secret to restore.</p>
1422
1422
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1423
- * than a partial ARN.</p>
1423
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1424
1424
  */
1425
1425
  SecretId: string | undefined;
1426
1426
  }
@@ -1450,7 +1450,7 @@ export interface RotateSecretRequest {
1450
1450
  /**
1451
1451
  * <p>The ARN or name of the secret to rotate.</p>
1452
1452
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1453
- * than a partial ARN.</p>
1453
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1454
1454
  */
1455
1455
  SecretId: string | undefined;
1456
1456
  /**
@@ -1543,7 +1543,7 @@ export interface TagResourceRequest {
1543
1543
  * <p>The identifier for the secret to attach tags to. You can specify either the
1544
1544
  * Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1545
1545
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1546
- * than a partial ARN.</p>
1546
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1547
1547
  */
1548
1548
  SecretId: string | undefined;
1549
1549
  /**
@@ -1566,7 +1566,7 @@ export interface UntagResourceRequest {
1566
1566
  /**
1567
1567
  * <p>The ARN or name of the secret.</p>
1568
1568
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1569
- * than a partial ARN.</p>
1569
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1570
1570
  */
1571
1571
  SecretId: string | undefined;
1572
1572
  /**
@@ -1589,7 +1589,7 @@ export interface UpdateSecretRequest {
1589
1589
  /**
1590
1590
  * <p>The ARN or name of the secret.</p>
1591
1591
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1592
- * than a partial ARN.</p>
1592
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1593
1593
  */
1594
1594
  SecretId: string | undefined;
1595
1595
  /**
@@ -1674,7 +1674,7 @@ export interface UpdateSecretVersionStageRequest {
1674
1674
  /**
1675
1675
  * <p>The ARN or the name of the secret with the version and staging labelsto modify.</p>
1676
1676
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1677
- * than a partial ARN.</p>
1677
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1678
1678
  */
1679
1679
  SecretId: string | undefined;
1680
1680
  /**
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.74.0",
4
+ "version": "3.78.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,34 +18,34 @@
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.74.0",
22
- "@aws-sdk/config-resolver": "3.58.0",
23
- "@aws-sdk/credential-provider-node": "3.74.0",
24
- "@aws-sdk/fetch-http-handler": "3.58.0",
25
- "@aws-sdk/hash-node": "3.55.0",
26
- "@aws-sdk/invalid-dependency": "3.55.0",
27
- "@aws-sdk/middleware-content-length": "3.58.0",
28
- "@aws-sdk/middleware-host-header": "3.58.0",
29
- "@aws-sdk/middleware-logger": "3.55.0",
30
- "@aws-sdk/middleware-retry": "3.58.0",
31
- "@aws-sdk/middleware-serde": "3.55.0",
32
- "@aws-sdk/middleware-signing": "3.58.0",
33
- "@aws-sdk/middleware-stack": "3.55.0",
34
- "@aws-sdk/middleware-user-agent": "3.58.0",
35
- "@aws-sdk/node-config-provider": "3.58.0",
36
- "@aws-sdk/node-http-handler": "3.74.0",
37
- "@aws-sdk/protocol-http": "3.58.0",
38
- "@aws-sdk/smithy-client": "3.72.0",
39
- "@aws-sdk/types": "3.55.0",
40
- "@aws-sdk/url-parser": "3.55.0",
21
+ "@aws-sdk/client-sts": "3.78.0",
22
+ "@aws-sdk/config-resolver": "3.78.0",
23
+ "@aws-sdk/credential-provider-node": "3.78.0",
24
+ "@aws-sdk/fetch-http-handler": "3.78.0",
25
+ "@aws-sdk/hash-node": "3.78.0",
26
+ "@aws-sdk/invalid-dependency": "3.78.0",
27
+ "@aws-sdk/middleware-content-length": "3.78.0",
28
+ "@aws-sdk/middleware-host-header": "3.78.0",
29
+ "@aws-sdk/middleware-logger": "3.78.0",
30
+ "@aws-sdk/middleware-retry": "3.78.0",
31
+ "@aws-sdk/middleware-serde": "3.78.0",
32
+ "@aws-sdk/middleware-signing": "3.78.0",
33
+ "@aws-sdk/middleware-stack": "3.78.0",
34
+ "@aws-sdk/middleware-user-agent": "3.78.0",
35
+ "@aws-sdk/node-config-provider": "3.78.0",
36
+ "@aws-sdk/node-http-handler": "3.78.0",
37
+ "@aws-sdk/protocol-http": "3.78.0",
38
+ "@aws-sdk/smithy-client": "3.78.0",
39
+ "@aws-sdk/types": "3.78.0",
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.72.0",
46
- "@aws-sdk/util-defaults-mode-node": "3.72.0",
47
- "@aws-sdk/util-user-agent-browser": "3.58.0",
48
- "@aws-sdk/util-user-agent-node": "3.58.0",
45
+ "@aws-sdk/util-defaults-mode-browser": "3.78.0",
46
+ "@aws-sdk/util-defaults-mode-node": "3.78.0",
47
+ "@aws-sdk/util-user-agent-browser": "3.78.0",
48
+ "@aws-sdk/util-user-agent-node": "3.78.0",
49
49
  "@aws-sdk/util-utf8-browser": "3.55.0",
50
50
  "@aws-sdk/util-utf8-node": "3.55.0",
51
51
  "tslib": "^2.3.1",