@aws-sdk/client-secrets-manager 3.40.0 → 3.45.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 +38 -0
  2. package/README.md +1 -1
  3. package/dist-cjs/endpoints.js +9 -0
  4. package/dist-es/endpoints.js +9 -0
  5. package/dist-types/SecretsManager.d.ts +142 -727
  6. package/dist-types/SecretsManagerClient.d.ts +1 -1
  7. package/dist-types/commands/CancelRotateSecretCommand.d.ts +8 -50
  8. package/dist-types/commands/CreateSecretCommand.d.ts +20 -88
  9. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +3 -25
  10. package/dist-types/commands/DeleteSecretCommand.d.ts +10 -43
  11. package/dist-types/commands/DescribeSecretCommand.d.ts +3 -29
  12. package/dist-types/commands/GetRandomPasswordCommand.d.ts +2 -12
  13. package/dist-types/commands/GetResourcePolicyCommand.d.ts +5 -28
  14. package/dist-types/commands/GetSecretValueCommand.d.ts +5 -26
  15. package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +7 -26
  16. package/dist-types/commands/ListSecretsCommand.d.ts +8 -27
  17. package/dist-types/commands/PutResourcePolicyCommand.d.ts +5 -32
  18. package/dist-types/commands/PutSecretValueCommand.d.ts +16 -84
  19. package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +2 -2
  20. package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +2 -3
  21. package/dist-types/commands/RestoreSecretCommand.d.ts +2 -19
  22. package/dist-types/commands/RotateSecretCommand.d.ts +18 -61
  23. package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +3 -2
  24. package/dist-types/commands/TagResourceCommand.d.ts +9 -30
  25. package/dist-types/commands/UntagResourceCommand.d.ts +2 -22
  26. package/dist-types/commands/UpdateSecretCommand.d.ts +20 -84
  27. package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +7 -29
  28. package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +6 -26
  29. package/dist-types/models/models_0.d.ts +400 -479
  30. package/package.json +6 -6
@@ -1,14 +1,14 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
2
  /**
3
- * <p>(Optional) Custom type consisting of a <code>Region</code> (required) and the <code>KmsKeyId</code> which can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>.</p>
3
+ * <p>A custom type that specifies a <code>Region</code> and the <code>KmsKeyId</code> for a replica secret.</p>
4
4
  */
5
5
  export interface ReplicaRegionType {
6
6
  /**
7
- * <p>Describes a single instance of Region objects.</p>
7
+ * <p>A Region code. For a list of Region codes, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints">Name and code of Regions</a>.</p>
8
8
  */
9
9
  Region?: string;
10
10
  /**
11
- * <p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>
11
+ * <p>The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses <code>aws/secretsmanager</code>.</p>
12
12
  */
13
13
  KmsKeyId?: string;
14
14
  }
@@ -20,8 +20,7 @@ export declare namespace ReplicaRegionType {
20
20
  }
21
21
  export interface CancelRotateSecretRequest {
22
22
  /**
23
- * <p>Specifies the secret to cancel a rotation request. You can specify either the Amazon
24
- * Resource Name (ARN) or the friendly name of the secret.</p>
23
+ * <p>The ARN or name of the secret.</p>
25
24
  * <p>For an ARN, we recommend that you specify a complete ARN rather
26
25
  * than a partial ARN.</p>
27
26
  */
@@ -35,19 +34,19 @@ export declare namespace CancelRotateSecretRequest {
35
34
  }
36
35
  export interface CancelRotateSecretResponse {
37
36
  /**
38
- * <p>The ARN of the secret for which rotation was canceled.</p>
37
+ * <p>The ARN of the secret.</p>
39
38
  */
40
39
  ARN?: string;
41
40
  /**
42
- * <p>The friendly name of the secret for which rotation was canceled.</p>
41
+ * <p>The name of the secret.</p>
43
42
  */
44
43
  Name?: string;
45
44
  /**
46
45
  * <p>The unique identifier of the version of the secret created during the rotation. This
47
- * version might not be complete, and should be evaluated for possible deletion. At the very
48
- * least, you should remove the <code>VersionStage</code> value <code>AWSPENDING</code> to enable this
49
- * version to be deleted. Failing to clean up a cancelled rotation can block you from
50
- * successfully starting future rotations.</p>
46
+ * version might not be complete, and should be evaluated for possible deletion. We recommend
47
+ * that you remove the <code>VersionStage</code> value <code>AWSPENDING</code> from this version so that
48
+ * Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from
49
+ * starting future rotations.</p>
51
50
  */
52
51
  VersionId?: string;
53
52
  }
@@ -72,7 +71,7 @@ export declare namespace InternalServiceError {
72
71
  const filterSensitiveLog: (obj: InternalServiceError) => any;
73
72
  }
74
73
  /**
75
- * <p>You provided an invalid value for a parameter.</p>
74
+ * <p>The parameter name is invalid value.</p>
76
75
  */
77
76
  export interface InvalidParameterException extends __SmithyException, $MetadataBearer {
78
77
  name: "InvalidParameterException";
@@ -86,12 +85,12 @@ export declare namespace InvalidParameterException {
86
85
  const filterSensitiveLog: (obj: InvalidParameterException) => any;
87
86
  }
88
87
  /**
89
- * <p>You provided a parameter value that is not valid for the current state of the
88
+ * <p>A parameter value is not valid for the current state of the
90
89
  * resource.</p>
91
90
  * <p>Possible causes:</p>
92
91
  * <ul>
93
92
  * <li>
94
- * <p>You tried to perform the operation on a secret that's currently marked deleted.</p>
93
+ * <p>The secret is scheduled for deletion.</p>
95
94
  * </li>
96
95
  * <li>
97
96
  * <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
@@ -111,7 +110,7 @@ export declare namespace InvalidRequestException {
111
110
  const filterSensitiveLog: (obj: InvalidRequestException) => any;
112
111
  }
113
112
  /**
114
- * <p>We can't find the resource that you asked for.</p>
113
+ * <p>Secrets Manager can't find the resource that you asked for.</p>
115
114
  */
116
115
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
117
116
  name: "ResourceNotFoundException";
@@ -145,26 +144,25 @@ export declare namespace Tag {
145
144
  }
146
145
  export interface CreateSecretRequest {
147
146
  /**
148
- * <p>Specifies the friendly name of the new secret.</p>
149
- * <p>The secret name must be ASCII letters, digits, or the following characters :
147
+ * <p>The name of the new secret.</p>
148
+ * <p>The secret name can contain ASCII letters, numbers, and the following characters:
150
149
  * /_+=.@-</p>
151
- * <note>
152
- * <p>Do not end your secret name with a hyphen followed by six characters. If you do so, you
150
+ *
151
+ * <p>Do not end your secret name with a hyphen followed by six characters. If you do so, you
153
152
  * risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager
154
- * automatically adds a hyphen and six random characters at the end of the ARN.</p>
155
- * </note>
153
+ * automatically adds a hyphen and six random characters after the secret name at the end of the ARN.</p>
156
154
  */
157
155
  Name: string | undefined;
158
156
  /**
159
- * <p>(Optional) If you include <code>SecretString</code> or <code>SecretBinary</code>, then an
160
- * initial version is created as part of the secret, and this parameter specifies a unique
157
+ * <p>If you include <code>SecretString</code> or <code>SecretBinary</code>, then
158
+ * Secrets Manager creates an initial version for the secret, and this parameter specifies the unique
161
159
  * identifier for the new version. </p>
162
160
  * <note>
163
- * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
161
+ * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can
164
162
  * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it
165
163
  * as the value for this parameter in the request. If you don't use the SDK and instead
166
164
  * generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
167
- * <code>ClientRequestToken</code> yourself for the new version and include the value in the
165
+ * <code>ClientRequestToken</code> yourself for the new version and include the value in the
168
166
  * request.</p>
169
167
  * </note>
170
168
  * <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental
@@ -183,7 +181,7 @@ export interface CreateSecretRequest {
183
181
  * </li>
184
182
  * <li>
185
183
  * <p>If a version with this value already exists and that version's
186
- * <code>SecretString</code> and <code>SecretBinary</code> values are different from those
184
+ * <code>SecretString</code> and <code>SecretBinary</code> values are different from those
187
185
  * in the request, then the request fails because you cannot modify an existing version.
188
186
  * Instead, use <a>PutSecretValue</a> to create a new version.</p>
189
187
  * </li>
@@ -192,89 +190,68 @@ export interface CreateSecretRequest {
192
190
  */
193
191
  ClientRequestToken?: string;
194
192
  /**
195
- * <p>(Optional) Specifies a user-provided description of the secret.</p>
193
+ * <p>The description of the secret.</p>
196
194
  */
197
195
  Description?: string;
198
196
  /**
199
- * <p>(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to
200
- * be used to encrypt the <code>SecretString</code> or <code>SecretBinary</code> values in the
201
- * versions stored in this secret.</p>
202
- * <p>You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to
203
- * reference a CMK in a different account, you can use only the key ARN or the alias ARN.</p>
204
- * <p>If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's
205
- * default CMK (the one named <code>aws/secretsmanager</code>). If a Amazon Web Services KMS CMK with that name doesn't yet
206
- * exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a
207
- * version's <code>SecretString</code> or <code>SecretBinary</code> fields.</p>
208
- * <important>
209
- * <p>You can use the account default CMK to encrypt and decrypt only if you call this
210
- * operation using credentials from the same account that owns the secret. If the secret
211
- * resides in a different account, then you must create a custom CMK and specify the ARN in
212
- * this field. </p>
213
- * </important>
197
+ * <p>The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
198
+ * encrypt the secret value in the secret.</p>
199
+ * <p>To use a KMS key in a different account, use the key ARN or the alias ARN.</p>
200
+ * <p>If you don't specify this value, then Secrets Manager uses the key <code>aws/secretsmanager</code>.
201
+ * If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it
202
+ * encrypts the secret value.</p>
203
+ * <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then
204
+ * you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must create
205
+ * and use a customer managed KMS key. </p>
214
206
  */
215
207
  KmsKeyId?: string;
216
208
  /**
217
- * <p>(Optional) Specifies binary data that you want to encrypt and store in the new version of
218
- * the secret. To use this parameter in the command-line tools, we recommend that you store your
219
- * binary data in a file and then use the appropriate technique for your tool to pass the
209
+ * <p>The binary data to encrypt and store in the new version of
210
+ * the secret. We recommend that you store your binary data in a file and then pass the
220
211
  * contents of the file as a parameter.</p>
221
212
  * <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not
222
- * both. They cannot both be empty.</p>
223
- * <p>This parameter is not available using the Secrets Manager console. It can be accessed only by
224
- * using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.</p>
213
+ * both.</p>
214
+ * <p>This parameter is not available in the Secrets Manager console.</p>
225
215
  */
226
216
  SecretBinary?: Uint8Array;
227
217
  /**
228
- * <p>(Optional) Specifies text data that you want to encrypt and store in this new version of
229
- * the secret.</p>
218
+ * <p>The text data to encrypt and store in this new version of
219
+ * the secret. We recommend you use a JSON structure of key/value pairs for your secret value.</p>
230
220
  * <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not
231
- * both. They cannot both be empty.</p>
221
+ * both.</p>
232
222
  * <p>If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected
233
223
  * secret text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the
234
- * information as a JSON structure of key/value pairs that the Lambda rotation function knows how
235
- * to parse.</p>
236
- * <p>For storing multiple values, we recommend that you use a JSON text
237
- * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
238
- * in the Amazon Web Services CLI User Guide.</p>
224
+ * information as a JSON structure of key/value pairs that a Lambda rotation function can parse.</p>
239
225
  */
240
226
  SecretString?: string;
241
227
  /**
242
- * <p>(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag
243
- * is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list
244
- * of tags. To remove tags, you must use <a>UntagResource</a>.</p>
245
- * <important>
246
- * <ul>
247
- * <li>
248
- * <p>Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag
249
- * from one with key "abc".</p>
250
- * </li>
251
- * <li>
252
- * <p>If you check tags in IAM policy <code>Condition</code> elements as part of your
253
- * security strategy, then adding or removing a tag can change permissions. If the
254
- * successful completion of this operation would result in you losing your permissions for
255
- * this secret, then this operation is blocked and returns an <code>Access Denied</code>
256
- * error.</p>
257
- * </li>
258
- * </ul>
259
- * </important>
260
- * <p>This parameter requires a JSON text string argument. For information on how to format a
261
- * JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
262
- * Parameters</a> in the <i>CLI User Guide</i>. For example:</p>
228
+ * <p>A list of tags to attach to the secret. Each tag
229
+ * is a key and value pair of strings in a JSON text string, for example:</p>
263
230
  * <p>
264
231
  * <code>[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]</code>
265
232
  * </p>
266
- * <p>If your command-line tool or SDK requires quotation marks around the parameter, you should
267
- * use single quotes to avoid confusion with the double quotes required in the JSON text. </p>
268
- * <p>The following basic restrictions apply to tags:</p>
233
+ * <p>Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag
234
+ * from one with key "abc".</p>
235
+ * <p>If you check tags in permissions policies as part of your
236
+ * security strategy, then adding or removing a tag can change permissions. If the
237
+ * completion of this operation would result in you losing your permissions for
238
+ * this secret, then Secrets Manager blocks the operation and returns an <code>Access Denied</code>
239
+ * error. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac">Control
240
+ * access to secrets using tags</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2">Limit access to identities with tags that match secrets' tags</a>.</p>
241
+ * <p>For information about how to format a
242
+ * JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
243
+ * Parameters</a>. If your command-line tool or SDK requires quotation marks around the parameter, you should
244
+ * use single quotes to avoid confusion with the double quotes required in the JSON text.</p>
245
+ * <p>The following restrictions apply to tags:</p>
269
246
  * <ul>
270
247
  * <li>
271
- * <p>Maximum number of tags per secret50</p>
248
+ * <p>Maximum number of tags per secret: 50</p>
272
249
  * </li>
273
250
  * <li>
274
- * <p>Maximum key length127 Unicode characters in UTF-8</p>
251
+ * <p>Maximum key length: 127 Unicode characters in UTF-8</p>
275
252
  * </li>
276
253
  * <li>
277
- * <p>Maximum value length255 Unicode characters in UTF-8</p>
254
+ * <p>Maximum value length: 255 Unicode characters in UTF-8</p>
278
255
  * </li>
279
256
  * <li>
280
257
  * <p>Tag keys and values are case sensitive.</p>
@@ -286,7 +263,7 @@ export interface CreateSecretRequest {
286
263
  * </li>
287
264
  * <li>
288
265
  * <p>If you use your tagging schema across multiple services and resources,
289
- * remember other services might have restrictions on allowed characters. Generally
266
+ * other services might have restrictions on allowed characters. Generally
290
267
  * allowed characters: letters, spaces, and numbers representable in UTF-8, plus the
291
268
  * following special characters: + - = . _ : / @.</p>
292
269
  * </li>
@@ -294,13 +271,12 @@ export interface CreateSecretRequest {
294
271
  */
295
272
  Tags?: Tag[];
296
273
  /**
297
- * <p>(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in
298
- * the parameter.</p>
274
+ * <p>A list of Regions and KMS keys to replicate secrets.</p>
299
275
  */
300
276
  AddReplicaRegions?: ReplicaRegionType[];
301
277
  /**
302
- * <p>(Optional) If set, the replication overwrites a secret with the same name in the
303
- * destination region.</p>
278
+ * <p>Specifies whether to overwrite a secret with the same name in the
279
+ * destination Region.</p>
304
280
  */
305
281
  ForceOverwriteReplicaSecret?: boolean;
306
282
  }
@@ -333,7 +309,7 @@ export interface ReplicationStatusType {
333
309
  Status?: StatusType | string;
334
310
  /**
335
311
  * <p>Status message such as "<i>Secret with this name already exists in this
336
- * region</i>".</p>
312
+ * region</i>".</p>
337
313
  */
338
314
  StatusMessage?: string;
339
315
  /**
@@ -349,26 +325,36 @@ export declare namespace ReplicationStatusType {
349
325
  }
350
326
  export interface CreateSecretResponse {
351
327
  /**
352
- * <p>The Amazon Resource Name (ARN) of the secret that you just created.</p>
353
- * <note>
354
- * <p>Secrets Manager automatically adds several random characters to the name at the end of the ARN when
355
- * you initially create a secret. This affects only the ARN and not the actual friendly name.
356
- * This ensures that if you create a new secret with the same name as an old secret that you
357
- * previously deleted, then users with access to the old secret <i>don't</i>
358
- * automatically get access to the new secret because the ARNs are different.</p>
359
- * </note>
328
+ * <p>The ARN of the new secret. The ARN includes the name of the secret followed by six random
329
+ * characters. This ensures that if you create a new secret with the same name as a deleted secret,
330
+ * then users with access to the old secret don't get access to the new secret because the ARNs
331
+ * are different.</p>
360
332
  */
361
333
  ARN?: string;
362
334
  /**
363
- * <p>The friendly name of the secret that you just created.</p>
335
+ * <p>The name of the new secret.</p>
364
336
  */
365
337
  Name?: string;
366
338
  /**
367
- * <p>The unique identifier associated with the version of the secret you just created.</p>
339
+ * <p>The unique identifier associated with the version of the new secret.</p>
368
340
  */
369
341
  VersionId?: string;
370
342
  /**
371
- * <p>Describes a list of replication status objects as <code>InProgress</code>, <code>Failed</code> or <code>InSync</code>.</p>
343
+ * <p>A list of the replicas of this secret and their status:</p>
344
+ * <ul>
345
+ * <li>
346
+ * <p>
347
+ * <code>Failed</code>, which indicates that the replica was not created.</p>
348
+ * </li>
349
+ * <li>
350
+ * <p>
351
+ * <code>InProgress</code>, which indicates that Secrets Manager is in the process of creating the replica.</p>
352
+ * </li>
353
+ * <li>
354
+ * <p>
355
+ * <code>InSync</code>, which indicates that the replica was created.</p>
356
+ * </li>
357
+ * </ul>
372
358
  */
373
359
  ReplicationStatus?: ReplicationStatusType[];
374
360
  }
@@ -380,9 +366,8 @@ export declare namespace CreateSecretResponse {
380
366
  }
381
367
  /**
382
368
  * <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
383
- * customer master key (CMK) is available, enabled, and not in an invalid state. For more
384
- * information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a
385
- * Customer Master Key</a>.</p>
369
+ * KMS key is available, enabled, and not in an invalid state. For more
370
+ * information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a>.</p>
386
371
  */
387
372
  export interface EncryptionFailure extends __SmithyException, $MetadataBearer {
388
373
  name: "EncryptionFailure";
@@ -396,7 +381,7 @@ export declare namespace EncryptionFailure {
396
381
  const filterSensitiveLog: (obj: EncryptionFailure) => any;
397
382
  }
398
383
  /**
399
- * <p>The request failed because it would exceed one of the Secrets Manager internal limits.</p>
384
+ * <p>The request failed because it would exceed one of the Secrets Manager quotas.</p>
400
385
  */
401
386
  export interface LimitExceededException extends __SmithyException, $MetadataBearer {
402
387
  name: "LimitExceededException";
@@ -410,7 +395,7 @@ export declare namespace LimitExceededException {
410
395
  const filterSensitiveLog: (obj: LimitExceededException) => any;
411
396
  }
412
397
  /**
413
- * <p>You provided a resource-based policy with syntax errors.</p>
398
+ * <p>The resource policy has syntax errors.</p>
414
399
  */
415
400
  export interface MalformedPolicyDocumentException extends __SmithyException, $MetadataBearer {
416
401
  name: "MalformedPolicyDocumentException";
@@ -467,8 +452,7 @@ export declare namespace DecryptionFailure {
467
452
  }
468
453
  export interface DeleteResourcePolicyRequest {
469
454
  /**
470
- * <p>Specifies the secret that you want to delete the attached resource-based policy for. You
471
- * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
455
+ * <p>The ARN or name of the secret to delete the attached resource-based policy for.</p>
472
456
  * <p>For an ARN, we recommend that you specify a complete ARN rather
473
457
  * than a partial ARN.</p>
474
458
  */
@@ -486,7 +470,7 @@ export interface DeleteResourcePolicyResponse {
486
470
  */
487
471
  ARN?: string;
488
472
  /**
489
- * <p>The friendly name of the secret that the resource-based policy was deleted for.</p>
473
+ * <p>The name of the secret that the resource-based policy was deleted for.</p>
490
474
  */
491
475
  Name?: string;
492
476
  }
@@ -498,39 +482,31 @@ export declare namespace DeleteResourcePolicyResponse {
498
482
  }
499
483
  export interface DeleteSecretRequest {
500
484
  /**
501
- * <p>Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or
502
- * the friendly name of the secret.</p>
485
+ * <p>The ARN or name of the secret to delete.</p>
503
486
  * <p>For an ARN, we recommend that you specify a complete ARN rather
504
487
  * than a partial ARN.</p>
505
488
  */
506
489
  SecretId: string | undefined;
507
490
  /**
508
- * <p>(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the
509
- * secret. You can't use both this parameter and the <code>ForceDeleteWithoutRecovery</code>
510
- * parameter in the same API call.</p>
511
- * <p>This value can range from 7 to 30 days with a default value of 30.</p>
491
+ * <p>The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the
492
+ * secret. You can't use both this parameter and <code>ForceDeleteWithoutRecovery</code>
493
+ * in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.</p>
512
494
  */
513
495
  RecoveryWindowInDays?: number;
514
496
  /**
515
- * <p>(Optional) Specifies that the secret is to be deleted without any recovery window. You
516
- * can't use both this parameter and the <code>RecoveryWindowInDays</code> parameter in the same
517
- * API call.</p>
518
- * <p>An asynchronous background process performs the actual deletion, so there can be a short
519
- * delay before the operation completes. If you write code to delete and then immediately
520
- * recreate a secret with the same name, ensure that your code includes appropriate back off and
521
- * retry logic.</p>
497
+ * <p>Specifies whether to delete the secret without any recovery window. You
498
+ * can't use both this parameter and <code>RecoveryWindowInDays</code> in the same
499
+ * call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.</p>
500
+ * <p>Secrets Manager performs the actual deletion with an asynchronous background process, so there might
501
+ * be a short delay before the secret is permanently deleted. If you delete a secret and then
502
+ * immediately create a secret with the same name, use appropriate back off and retry logic.</p>
522
503
  * <important>
523
504
  * <p>Use this parameter with caution. This parameter causes the operation to skip the normal
524
- * waiting period before the permanent deletion that Amazon Web Services would normally impose with the
505
+ * recovery window before the permanent deletion that Secrets Manager would normally impose with the
525
506
  * <code>RecoveryWindowInDays</code> parameter. If you delete a secret with the
526
507
  * <code>ForceDeleteWithouRecovery</code> parameter, then you have no opportunity to recover
527
508
  * the secret. You lose the secret permanently.</p>
528
509
  * </important>
529
- * <important>
530
- * <p>If you use this parameter and include a previously deleted or nonexistent secret, the
531
- * operation does not return the error <code>ResourceNotFoundException</code> in order to
532
- * correctly handle retries.</p>
533
- * </important>
534
510
  */
535
511
  ForceDeleteWithoutRecovery?: boolean;
536
512
  }
@@ -542,17 +518,17 @@ export declare namespace DeleteSecretRequest {
542
518
  }
543
519
  export interface DeleteSecretResponse {
544
520
  /**
545
- * <p>The ARN of the secret that is now scheduled for deletion.</p>
521
+ * <p>The ARN of the secret.</p>
546
522
  */
547
523
  ARN?: string;
548
524
  /**
549
- * <p>The friendly name of the secret currently scheduled for deletion.</p>
525
+ * <p>The name of the secret.</p>
550
526
  */
551
527
  Name?: string;
552
528
  /**
553
- * <p>The date and time after which this secret can be deleted by Secrets Manager and can no longer be
554
- * restored. This value is the date and time of the delete request plus the number of days
555
- * specified in <code>RecoveryWindowInDays</code>.</p>
529
+ * <p>The date and time after which this secret Secrets Manager can permanently delete this secret,
530
+ * and it can no longer be restored. This value is the date and time of the delete request
531
+ * plus the number of days in <code>RecoveryWindowInDays</code>.</p>
556
532
  */
557
533
  DeletionDate?: Date;
558
534
  }
@@ -564,8 +540,7 @@ export declare namespace DeleteSecretResponse {
564
540
  }
565
541
  export interface DescribeSecretRequest {
566
542
  /**
567
- * <p>The identifier of the secret whose details you want to retrieve. You can specify either
568
- * the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
543
+ * <p>The ARN or name of the secret. </p>
569
544
  * <p>For an ARN, we recommend that you specify a complete ARN rather
570
545
  * than a partial ARN.</p>
571
546
  */
@@ -584,10 +559,10 @@ export interface RotationRulesType {
584
559
  /**
585
560
  * <p>Specifies the number of days between automatic scheduled rotations of the secret.</p>
586
561
  * <p>Secrets Manager schedules the next rotation when the previous
587
- * one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the
588
- * actual date of the last rotation. The service chooses the hour within that 24-hour date window
589
- * randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour
590
- * and influenced by a variety of factors that help distribute load.</p>
562
+ * one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the
563
+ * actual date of the last rotation. The service chooses the hour within that 24-hour date window
564
+ * randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour
565
+ * and influenced by a variety of factors that help distribute load.</p>
591
566
  */
592
567
  AutomaticallyAfterDays?: number;
593
568
  }
@@ -603,42 +578,38 @@ export interface DescribeSecretResponse {
603
578
  */
604
579
  ARN?: string;
605
580
  /**
606
- * <p>The user-provided friendly name of the secret.</p>
581
+ * <p>The name of the secret.</p>
607
582
  */
608
583
  Name?: string;
609
584
  /**
610
- * <p>The user-provided description of the secret.</p>
585
+ * <p>The description of the secret.</p>
611
586
  */
612
587
  Description?: string;
613
588
  /**
614
- * <p>The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the
615
- * <code>SecretString</code> or <code>SecretBinary</code> fields in each version of the secret.
616
- * If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the
617
- * default Amazon Web Services KMS CMK (the one named <code>awssecretsmanager</code>) for this account.</p>
589
+ * <p>The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with
590
+ * the Amazon Web Services managed key <code>aws/secretsmanager</code>, this field is omitted.</p>
618
591
  */
619
592
  KmsKeyId?: string;
620
593
  /**
621
- * <p>Specifies whether automatic rotation is enabled for this secret.</p>
622
- * <p>To enable rotation, use <a>RotateSecret</a> with
623
- * <code>AutomaticallyRotateAfterDays</code> set to a value greater than 0. To disable
594
+ * <p>Specifies whether automatic rotation is turned on for this secret.</p>
595
+ * <p>To turn on rotation, use <a>RotateSecret</a>. To turn off
624
596
  * rotation, use <a>CancelRotateSecret</a>.</p>
625
597
  */
626
598
  RotationEnabled?: boolean;
627
599
  /**
628
- * <p>The ARN of a Lambda function that's invoked by Secrets Manager to rotate the
629
- * secret either automatically per the schedule or manually by a call to
630
- * <code>RotateSecret</code>.</p>
600
+ * <p>The ARN of the Lambda function that Secrets Manager invokes to rotate the
601
+ * secret. </p>
631
602
  */
632
603
  RotationLambdaARN?: string;
633
604
  /**
634
- * <p>A structure with the rotation configuration for this secret. This field is only populated
635
- * if rotation is configured.</p>
605
+ * <p>The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but
606
+ * it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had
607
+ * rotation turned on, this field is omitted.</p>
636
608
  */
637
609
  RotationRules?: RotationRulesType;
638
610
  /**
639
- * <p>The last date and time that the rotation process for this secret was invoked.</p>
640
- * <p>The most recent date and time that the Secrets Manager rotation process successfully
641
- * completed. If the secret doesn't rotate, Secrets Manager returns a null value.</p>
611
+ * <p>The last date and time that Secrets Manager rotated the secret.
612
+ * If the secret isn't configured for rotation, Secrets Manager returns null.</p>
642
613
  */
643
614
  LastRotatedDate?: Date;
644
615
  /**
@@ -646,49 +617,81 @@ export interface DescribeSecretResponse {
646
617
  */
647
618
  LastChangedDate?: Date;
648
619
  /**
649
- * <p>The last date that this secret was accessed. This value is truncated to midnight of the
650
- * date and therefore shows only the date, not the time.</p>
620
+ * <p>The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.</p>
651
621
  */
652
622
  LastAccessedDate?: Date;
653
623
  /**
654
- * <p>This value exists if the secret is scheduled for deletion. Some time after the specified
655
- * date and time, Secrets Manager deletes the secret and all of its versions.</p>
624
+ * <p>The date the secret is scheduled for deletion. If it is not scheduled for deletion, this
625
+ * field is omitted. When you delete a secret, Secrets Manager requires a
626
+ * recovery window of at least 7 days before deleting the secret. Some time after the deleted date,
627
+ * Secrets Manager deletes the secret, including all of its versions.</p>
656
628
  * <p>If a secret is scheduled for deletion, then its details, including the encrypted secret
657
- * information, is not accessible. To cancel a scheduled deletion and restore access, use <a>RestoreSecret</a>.</p>
629
+ * value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use <a>RestoreSecret</a>.</p>
658
630
  */
659
631
  DeletedDate?: Date;
660
632
  /**
661
- * <p>The list of user-defined tags that are associated with the secret. To add tags to a
633
+ * <p>The list of tags attached to the secret. To add tags to a
662
634
  * secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>
663
635
  */
664
636
  Tags?: Tag[];
665
637
  /**
666
- * <p>A list of all of the currently assigned <code>VersionStage</code> staging labels and the
667
- * <code>VersionId</code> that each is attached to. Staging labels are used to keep track of
668
- * the different versions during the rotation process.</p>
669
- * <note>
670
- * <p>A version that does not have any staging labels attached is considered deprecated and
671
- * subject to deletion. Such versions are not included in this list.</p>
672
- * </note>
638
+ * <p>A list of the versions of the secret that have staging labels attached.
639
+ * Versions that don't have staging labels are considered deprecated and Secrets Manager
640
+ * can delete them.</p>
641
+ * <p>Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three
642
+ * staging labels for rotation are: </p>
643
+ * <ul>
644
+ * <li>
645
+ * <p>
646
+ * <code>AWSCURRENT</code>, which indicates the current version of the secret.</p>
647
+ * </li>
648
+ * <li>
649
+ * <p>
650
+ * <code>AWSPENDING</code>, which indicates the version of the secret that contains new
651
+ * secret information that will become the next current version when rotation finishes.</p>
652
+ * <p>During
653
+ * rotation, Secrets Manager creates an <code>AWSPENDING</code> version ID before creating the new secret version.
654
+ * To check if a secret version exists, call <a>GetSecretValue</a>.</p>
655
+ * </li>
656
+ * <li>
657
+ * <p>
658
+ * <code>AWSPREVIOUS</code>, which indicates the previous current version of the secret.
659
+ * You can use this as the <i>last known good</i> version.</p>
660
+ * </li>
661
+ * </ul>
662
+ * <p>For more information about rotation and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
673
663
  */
674
664
  VersionIdsToStages?: {
675
665
  [key: string]: string[];
676
666
  };
677
667
  /**
678
- * <p>Returns the name of the service that created this secret.</p>
668
+ * <p>The name of the service that created this secret.</p>
679
669
  */
680
670
  OwningService?: string;
681
671
  /**
682
- * <p>The date you created the secret.</p>
672
+ * <p>The date the secret was created.</p>
683
673
  */
684
674
  CreatedDate?: Date;
685
675
  /**
686
- * <p>Specifies the primary region for secret replication. </p>
676
+ * <p>The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in <code>ReplicationStatus</code>. </p>
687
677
  */
688
678
  PrimaryRegion?: string;
689
679
  /**
690
- * <p>Describes a list of replication status objects as <code>InProgress</code>, <code>Failed</code> or <code>InSync</code>.<code>P</code>
691
- * </p>
680
+ * <p>A list of the replicas of this secret and their status: </p>
681
+ * <ul>
682
+ * <li>
683
+ * <p>
684
+ * <code>Failed</code>, which indicates that the replica was not created.</p>
685
+ * </li>
686
+ * <li>
687
+ * <p>
688
+ * <code>InProgress</code>, which indicates that Secrets Manager is in the process of creating the replica.</p>
689
+ * </li>
690
+ * <li>
691
+ * <p>
692
+ * <code>InSync</code>, which indicates that the replica was created.</p>
693
+ * </li>
694
+ * </ul>
692
695
  */
693
696
  ReplicationStatus?: ReplicationStatusType[];
694
697
  }
@@ -700,15 +703,41 @@ export declare namespace DescribeSecretResponse {
700
703
  }
701
704
  export declare type FilterNameStringType = "all" | "description" | "name" | "primary-region" | "tag-key" | "tag-value";
702
705
  /**
703
- * <p>Allows you to add filters when you use the search function in Secrets Manager.</p>
706
+ * <p>Allows you to add filters when you use the search function in Secrets Manager. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in Secrets Manager</a>.</p>
704
707
  */
705
708
  export interface Filter {
706
709
  /**
707
- * <p>Filters your list of secrets by a specific key.</p>
710
+ * <p>The following are keys you can use:</p>
711
+ * <ul>
712
+ * <li>
713
+ * <p>
714
+ * <b>description</b>: Prefix match, not case-sensitive.</p>
715
+ * </li>
716
+ * <li>
717
+ * <p>
718
+ * <b>name</b>: Prefix match, case-sensitive.</p>
719
+ * </li>
720
+ * <li>
721
+ * <p>
722
+ * <b>tag-key</b>: Prefix match, case-sensitive.</p>
723
+ * </li>
724
+ * <li>
725
+ * <p>
726
+ * <b>tag-value</b>: Prefix match, case-sensitive.</p>
727
+ * </li>
728
+ * <li>
729
+ * <p>
730
+ * <b>primary-region</b>: Prefix match, case-sensitive.</p>
731
+ * </li>
732
+ * <li>
733
+ * <p>
734
+ * <b>all</b>: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.</p>
735
+ * </li>
736
+ * </ul>
708
737
  */
709
738
  Key?: FilterNameStringType | string;
710
739
  /**
711
- * <p>Filters your list of secrets by a specific value.</p>
740
+ * <p>The keyword to filter for.</p>
712
741
  * <p>You can prefix your search value with an exclamation mark (<code>!</code>) in order to perform negation filters. </p>
713
742
  */
714
743
  Values?: string[];
@@ -721,52 +750,43 @@ export declare namespace Filter {
721
750
  }
722
751
  export interface GetRandomPasswordRequest {
723
752
  /**
724
- * <p>The desired length of the generated password. The default value if you do not include this
725
- * parameter is 32 characters.</p>
753
+ * <p>The length of the password. If you don't include this parameter, the
754
+ * default length is 32 characters.</p>
726
755
  */
727
756
  PasswordLength?: number;
728
757
  /**
729
- * <p>A string that includes characters that should not be included in the generated password.
730
- * The default is that all characters from the included sets can be used.</p>
758
+ * <p>A string of the characters that you don't want in the password.</p>
731
759
  */
732
760
  ExcludeCharacters?: string;
733
761
  /**
734
- * <p>Specifies that the generated password should not include digits. The default if you do not
735
- * include this switch parameter is that digits can be included.</p>
762
+ * <p>Specifies whether to exclude numbers from the password. If you don't
763
+ * include this switch, the password can contain numbers.</p>
736
764
  */
737
765
  ExcludeNumbers?: boolean;
738
766
  /**
739
- * <p>Specifies that the generated password should not include punctuation characters. The
740
- * default if you do not include this switch parameter is that punctuation characters can be
741
- * included.</p>
742
- * <p>The following are the punctuation characters that <i>can</i> be included in
743
- * the generated password if you don't explicitly exclude them with
744
- * <code>ExcludeCharacters</code> or <code>ExcludePunctuation</code>:</p>
745
- * <p>
746
- * <code>! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | }
747
- * ~</code>
748
- * </p>
767
+ * <p>Specifies whether to exclude the following punctuation characters from the password:
768
+ * <code>! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~</code>.
769
+ * If you don't include this switch, the password can contain punctuation.</p>
749
770
  */
750
771
  ExcludePunctuation?: boolean;
751
772
  /**
752
- * <p>Specifies that the generated password should not include uppercase letters. The default if
753
- * you do not include this switch parameter is that uppercase letters can be included.</p>
773
+ * <p>Specifies whether to exclude uppercase letters from the password. If you
774
+ * don't include this switch, the password can contain uppercase letters.</p>
754
775
  */
755
776
  ExcludeUppercase?: boolean;
756
777
  /**
757
- * <p>Specifies that the generated password should not include lowercase letters. The default if
758
- * you do not include this switch parameter is that lowercase letters can be included.</p>
778
+ * <p>Specifies whether to exclude lowercase letters from the password. If
779
+ * you don't include this switch, the password can contain lowercase letters.</p>
759
780
  */
760
781
  ExcludeLowercase?: boolean;
761
782
  /**
762
- * <p>Specifies that the generated password can include the space character. The default if you
763
- * do not include this switch parameter is that the space character is not included.</p>
783
+ * <p>Specifies whether to include the space character. If you
784
+ * include this switch, the password can contain space characters.</p>
764
785
  */
765
786
  IncludeSpace?: boolean;
766
787
  /**
767
- * <p>A boolean value that specifies whether the generated password must include at least one of
768
- * every allowed character type. The default value is <code>True</code> and the operation
769
- * requires at least one of every character type.</p>
788
+ * <p>Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
789
+ * If you don't include this switch, the password contains at least one of every character type.</p>
770
790
  */
771
791
  RequireEachIncludedType?: boolean;
772
792
  }
@@ -778,7 +798,7 @@ export declare namespace GetRandomPasswordRequest {
778
798
  }
779
799
  export interface GetRandomPasswordResponse {
780
800
  /**
781
- * <p>A string with the generated password.</p>
801
+ * <p>A string with the password.</p>
782
802
  */
783
803
  RandomPassword?: string;
784
804
  }
@@ -790,8 +810,7 @@ export declare namespace GetRandomPasswordResponse {
790
810
  }
791
811
  export interface GetResourcePolicyRequest {
792
812
  /**
793
- * <p>Specifies the secret that you want to retrieve the attached resource-based policy for. You
794
- * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
813
+ * <p>The ARN or name of the secret to retrieve the attached resource-based policy for.</p>
795
814
  * <p>For an ARN, we recommend that you specify a complete ARN rather
796
815
  * than a partial ARN.</p>
797
816
  */
@@ -809,15 +828,13 @@ export interface GetResourcePolicyResponse {
809
828
  */
810
829
  ARN?: string;
811
830
  /**
812
- * <p>The friendly name of the secret that the resource-based policy was retrieved for.</p>
831
+ * <p>The name of the secret that the resource-based policy was retrieved for.</p>
813
832
  */
814
833
  Name?: string;
815
834
  /**
816
- * <p>A JSON-formatted string that describes the permissions that are associated with the
817
- * attached secret. These permissions are combined with any permissions that are associated with
818
- * the user or role that attempts to access this secret. The combined permissions specify who can
819
- * access the secret and what actions they can perform. For more information, see <a href="http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and Access Control for
820
- * Amazon Web Services Secrets Manager</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.</p>
835
+ * <p>A JSON-formatted string that contains the permissions policy
836
+ * attached to the secret. For more information about permissions policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control for
837
+ * Secrets Manager</a>.</p>
821
838
  */
822
839
  ResourcePolicy?: string;
823
840
  }
@@ -829,30 +846,26 @@ export declare namespace GetResourcePolicyResponse {
829
846
  }
830
847
  export interface GetSecretValueRequest {
831
848
  /**
832
- * <p>Specifies the secret containing the version that you want to retrieve. You can specify
833
- * either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
849
+ * <p>The ARN or name of the secret to retrieve.</p>
834
850
  * <p>For an ARN, we recommend that you specify a complete ARN rather
835
851
  * than a partial ARN.</p>
836
852
  */
837
853
  SecretId: string | undefined;
838
854
  /**
839
- * <p>Specifies the unique identifier of the version of the secret that you want to retrieve. If
840
- * you specify both this parameter and <code>VersionStage</code>, the two parameters must refer
855
+ * <p>The unique identifier of the version of the secret to retrieve. If
856
+ * you include both this parameter and <code>VersionStage</code>, the two parameters must refer
841
857
  * to the same secret version. If you don't specify either a <code>VersionStage</code> or
842
- * <code>VersionId</code> then the default is to perform the operation on the version with the
843
- * <code>VersionStage</code> value of <code>AWSCURRENT</code>.</p>
858
+ * <code>VersionId</code>, then Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
844
859
  * <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value with
845
860
  * 32 hexadecimal digits.</p>
846
861
  */
847
862
  VersionId?: string;
848
863
  /**
849
- * <p>Specifies the secret version that you want to retrieve by the staging label attached to
850
- * the version.</p>
851
- * <p>Staging labels are used to keep track of different versions during the rotation process.
852
- * If you specify both this parameter and <code>VersionId</code>, the two parameters must refer
853
- * to the same secret version . If you don't specify either a <code>VersionStage</code> or
854
- * <code>VersionId</code>, then the default is to perform the operation on the version with the
855
- * <code>VersionStage</code> value of <code>AWSCURRENT</code>.</p>
864
+ * <p>The staging label of the version of the secret to retrieve. </p>
865
+ * <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process.
866
+ * If you include both this parameter and <code>VersionId</code>, the two parameters must refer
867
+ * to the same secret version. If you don't specify either a <code>VersionStage</code> or
868
+ * <code>VersionId</code>, Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
856
869
  */
857
870
  VersionStage?: string;
858
871
  }
@@ -876,27 +889,20 @@ export interface GetSecretValueResponse {
876
889
  */
877
890
  VersionId?: string;
878
891
  /**
879
- * <p>The decrypted part of the protected secret information that was originally provided as
892
+ * <p>The decrypted secret value, if the secret value was originally provided as
880
893
  * binary data in the form of a byte array. The response parameter represents the binary data as
881
894
  * a <a href="https://tools.ietf.org/html/rfc4648#section-4">base64-encoded</a>
882
895
  * string.</p>
883
- * <p>This parameter is not used if the secret is created by the Secrets Manager console.</p>
884
- * <p>If you store custom information in this field of the secret, then you must code your
885
- * Lambda rotation function to parse and interpret whatever you store in the
886
- * <code>SecretString</code> or <code>SecretBinary</code> fields.</p>
896
+ * <p>If the secret was created by using the Secrets Manager console, or if the secret value was
897
+ * originally provided as a string, then this field is omitted. The secret value appears in
898
+ * <code>SecretString</code> instead.</p>
887
899
  */
888
900
  SecretBinary?: Uint8Array;
889
901
  /**
890
- * <p>The decrypted part of the protected secret information that was originally provided as a
891
- * string.</p>
892
- * <p>If you create this secret by using the Secrets Manager console then only the
893
- * <code>SecretString</code> parameter contains data. Secrets Manager stores the information as a
894
- * JSON structure of key/value pairs that the Lambda rotation function knows how to parse.</p>
895
- * <p>If you store custom information in the secret by using the <a>CreateSecret</a>,
896
- * <a>UpdateSecret</a>, or <a>PutSecretValue</a> API operations instead
897
- * of the Secrets Manager console, or by using the <b>Other secret type</b> in
898
- * the console, then you must code your Lambda rotation function to parse and interpret those
899
- * values.</p>
902
+ * <p>The decrypted secret value, if the secret value was originally provided as a string or
903
+ * through the Secrets Manager console.</p>
904
+ * <p>If this secret was created by using the console, then Secrets Manager stores the information as a
905
+ * JSON structure of key/value pairs. </p>
900
906
  */
901
907
  SecretString?: string;
902
908
  /**
@@ -905,7 +911,9 @@ export interface GetSecretValueResponse {
905
911
  */
906
912
  VersionStages?: string[];
907
913
  /**
908
- * <p>The date and time that this version of the secret was created.</p>
914
+ * <p>The date and time that this version of the secret was created. If you don't specify
915
+ * which version in <code>VersionId</code> or <code>VersionStage</code>, then Secrets Manager uses the
916
+ * <code>AWSCURRENT</code> version.</p>
909
917
  */
910
918
  CreatedDate?: Date;
911
919
  }
@@ -916,7 +924,7 @@ export declare namespace GetSecretValueResponse {
916
924
  const filterSensitiveLog: (obj: GetSecretValueResponse) => any;
917
925
  }
918
926
  /**
919
- * <p>You provided an invalid <code>NextToken</code> value.</p>
927
+ * <p>The <code>NextToken</code> value is invalid.</p>
920
928
  */
921
929
  export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
922
930
  name: "InvalidNextTokenException";
@@ -935,25 +943,20 @@ export declare enum SortOrderType {
935
943
  }
936
944
  export interface ListSecretsRequest {
937
945
  /**
938
- * <p>(Optional) Limits the number of results you want to include in
939
- * the response. If you don't include this parameter, it defaults to a value that's
940
- * specific to the operation. If additional items exist beyond the maximum you specify, the
941
- * <code>NextToken</code> response element is present and has a value (isn't null). Include
942
- * that value as the <code>NextToken</code> request parameter in the next call to the operation to
943
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
944
- * even when there are more results available. You should check <code>NextToken</code> after every
945
- * operation to ensure that you receive all of the results.</p>
946
+ * <p>The number of results to include in the response.</p>
947
+ * <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
948
+ * To get the next results, call <code>ListSecrets</code> again with the value from
949
+ * <code>NextToken</code>.</p>
946
950
  */
947
951
  MaxResults?: number;
948
952
  /**
949
- * <p>(Optional) Use this parameter in a request if you receive a
950
- * <code>NextToken</code> response in a previous request indicating there's more
951
- * output available. In a subsequent call, set it to the value of the previous call
952
- * <code>NextToken</code> response to indicate where the output should continue from.</p>
953
+ * <p>A token that indicates where the output should continue from, if a
954
+ * previous call did not show all results. To get the next results, call <code>ListSecrets</code> again
955
+ * with this value.</p>
953
956
  */
954
957
  NextToken?: string;
955
958
  /**
956
- * <p>Lists the secret request filters.</p>
959
+ * <p>The filters to apply to the list of secrets.</p>
957
960
  */
958
961
  Filters?: Filter[];
959
962
  /**
@@ -975,15 +978,13 @@ export declare namespace ListSecretsRequest {
975
978
  export interface SecretListEntry {
976
979
  /**
977
980
  * <p>The Amazon Resource Name (ARN) of the secret.</p>
978
- * <p>For more information about ARNs in Secrets Manager, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources">Policy Resources</a> in the
979
- * <i>Amazon Web Services Secrets Manager User Guide</i>.</p>
980
981
  */
981
982
  ARN?: string;
982
983
  /**
983
984
  * <p>The friendly name of the secret. You can use forward slashes in the name to represent a
984
985
  * path hierarchy. For example, <code>/prod/databases/dbserver1</code> could represent the secret
985
986
  * for a server named <code>dbserver1</code> in the folder <code>databases</code> in the folder
986
- * <code>prod</code>. </p>
987
+ * <code>prod</code>. </p>
987
988
  */
988
989
  Name?: string;
989
990
  /**
@@ -991,10 +992,8 @@ export interface SecretListEntry {
991
992
  */
992
993
  Description?: string;
993
994
  /**
994
- * <p>The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the
995
- * <code>SecretString</code> and <code>SecretBinary</code> fields in each version of the
996
- * secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with
997
- * the default KMS CMK, the key named <code>awssecretsmanager</code>, for this account.</p>
995
+ * <p>The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with
996
+ * the Amazon Web Services managed key <code>aws/secretsmanager</code>, this field is omitted.</p>
998
997
  */
999
998
  KmsKeyId?: string;
1000
999
  /**
@@ -1071,13 +1070,11 @@ export interface ListSecretsResponse {
1071
1070
  */
1072
1071
  SecretList?: SecretListEntry[];
1073
1072
  /**
1074
- * <p>If present in the response, this value indicates that
1075
- * there's more output available than included in the current response. This can
1076
- * occur even when the response includes no values at all, such as when you ask for a filtered view
1077
- * of a very long list. Use this value in the <code>NextToken</code> request parameter in a
1078
- * subsequent call to the operation to continue processing and get the next part of the output. You
1079
- * should repeat this until the <code>NextToken</code> response element comes back empty (as
1080
- * <code>null</code>).</p>
1073
+ * <p>Secrets Manager includes this value if
1074
+ * there's more output available than what is included in the current response. This can
1075
+ * occur even when the response includes no values at all, such as when you ask for a filtered view
1076
+ * of a long list. To get the next results, call <code>ListSecrets</code> again
1077
+ * with this value.</p>
1081
1078
  */
1082
1079
  NextToken?: string;
1083
1080
  }
@@ -1089,34 +1086,27 @@ export declare namespace ListSecretsResponse {
1089
1086
  }
1090
1087
  export interface ListSecretVersionIdsRequest {
1091
1088
  /**
1092
- * <p>The identifier for the secret containing the versions you want to list. You can specify
1093
- * either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1089
+ * <p>The ARN or name of the secret whose versions you want to list.</p>
1094
1090
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1095
1091
  * than a partial ARN.</p>
1096
1092
  */
1097
1093
  SecretId: string | undefined;
1098
1094
  /**
1099
- * <p>(Optional) Limits the number of results you want to include in
1100
- * the response. If you don't include this parameter, it defaults to a value that's
1101
- * specific to the operation. If additional items exist beyond the maximum you specify, the
1102
- * <code>NextToken</code> response element is present and has a value (isn't null). Include
1103
- * that value as the <code>NextToken</code> request parameter in the next call to the operation to
1104
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
1105
- * even when there are more results available. You should check <code>NextToken</code> after every
1106
- * operation to ensure that you receive all of the results.</p>
1095
+ * <p>The number of results to include in the response.</p>
1096
+ * <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
1097
+ * To get the next results, call <code>ListSecretVersionIds</code> again with the value from <code>NextToken</code>. </p>
1107
1098
  */
1108
1099
  MaxResults?: number;
1109
1100
  /**
1110
- * <p>(Optional) Use this parameter in a request if you receive a
1111
- * <code>NextToken</code> response in a previous request indicating there's more
1112
- * output available. In a subsequent call, set it to the value of the previous call
1113
- * <code>NextToken</code> response to indicate where the output should continue from.</p>
1101
+ * <p>A token that indicates where the output should continue from, if a previous call
1102
+ * did not show all results. To get the next results, call <code>ListSecretVersionIds</code> again with
1103
+ * this value.</p>
1114
1104
  */
1115
1105
  NextToken?: string;
1116
1106
  /**
1117
- * <p>(Optional) Specifies that you want the results to include versions that do not have any
1118
- * staging labels attached to them. Such versions are considered deprecated and are subject to
1119
- * deletion by Secrets Manager as needed.</p>
1107
+ * <p>Specifies whether to include versions of secrets that don't have any
1108
+ * staging labels attached to them. Versions without staging labels are considered deprecated and are subject to
1109
+ * deletion by Secrets Manager.</p>
1120
1110
  */
1121
1111
  IncludeDeprecated?: boolean;
1122
1112
  }
@@ -1161,32 +1151,22 @@ export declare namespace SecretVersionsListEntry {
1161
1151
  }
1162
1152
  export interface ListSecretVersionIdsResponse {
1163
1153
  /**
1164
- * <p>The list of the currently available versions of the specified secret.</p>
1154
+ * <p>A list of the versions of the secret.</p>
1165
1155
  */
1166
1156
  Versions?: SecretVersionsListEntry[];
1167
1157
  /**
1168
- * <p>If present in the response, this value indicates that
1169
- * there's more output available than included in the current response. This can
1170
- * occur even when the response includes no values at all, such as when you ask for a filtered view
1171
- * of a very long list. Use this value in the <code>NextToken</code> request parameter in a
1172
- * subsequent call to the operation to continue processing and get the next part of the output. You
1173
- * should repeat this until the <code>NextToken</code> response element comes back empty (as
1174
- * <code>null</code>).</p>
1158
+ * <p>Secrets Manager includes this value if there's more output available than what is included
1159
+ * in the current response. This can occur even when the response includes no values at all,
1160
+ * such as when you ask for a filtered view of a long list. To get the next results,
1161
+ * call <code>ListSecretVersionIds</code> again with this value. </p>
1175
1162
  */
1176
1163
  NextToken?: string;
1177
1164
  /**
1178
- * <p>The Amazon Resource Name (ARN) for the secret.</p>
1179
- * <note>
1180
- * <p>Secrets Manager automatically adds several random characters to the name at the end of the ARN when
1181
- * you initially create a secret. This affects only the ARN and not the actual friendly name.
1182
- * This ensures that if you create a new secret with the same name as an old secret that you
1183
- * previously deleted, then users with access to the old secret <i>don't</i>
1184
- * automatically get access to the new secret because the ARNs are different.</p>
1185
- * </note>
1165
+ * <p>The ARN of the secret.</p>
1186
1166
  */
1187
1167
  ARN?: string;
1188
1168
  /**
1189
- * <p>The friendly name of the secret.</p>
1169
+ * <p>The name of the secret.</p>
1190
1170
  */
1191
1171
  Name?: string;
1192
1172
  }
@@ -1197,7 +1177,7 @@ export declare namespace ListSecretVersionIdsResponse {
1197
1177
  const filterSensitiveLog: (obj: ListSecretVersionIdsResponse) => any;
1198
1178
  }
1199
1179
  /**
1200
- * <p>The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.</p>
1180
+ * <p>The <code>BlockPublicPolicy</code> parameter is set to true, and the resource policy did not prevent broad access to the secret.</p>
1201
1181
  */
1202
1182
  export interface PublicPolicyException extends __SmithyException, $MetadataBearer {
1203
1183
  name: "PublicPolicyException";
@@ -1212,23 +1192,19 @@ export declare namespace PublicPolicyException {
1212
1192
  }
1213
1193
  export interface PutResourcePolicyRequest {
1214
1194
  /**
1215
- * <p>Specifies the secret that you want to attach the resource-based policy. You can specify
1216
- * either the ARN or the friendly name of the secret.</p>
1195
+ * <p>The ARN or name of the secret to attach the resource-based policy.</p>
1217
1196
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1218
1197
  * than a partial ARN.</p>
1219
1198
  */
1220
1199
  SecretId: string | undefined;
1221
1200
  /**
1222
- * <p>A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services
1223
- * resource-based policy. The policy in the string identifies who can access or manage this
1224
- * secret and its versions. For information on how to format a JSON parameter for the various
1225
- * command line tool environments, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using
1226
- * JSON for Parameters</a> in the <i>CLI User Guide</i>.</p>
1201
+ * <p>A JSON-formatted string for an Amazon Web Services
1202
+ * resource-based policy. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions
1203
+ * policy examples</a>.</p>
1227
1204
  */
1228
1205
  ResourcePolicy: string | undefined;
1229
1206
  /**
1230
- * <p>(Optional) If you set the parameter, <code>BlockPublicPolicy</code> to true, then you
1231
- * block resource-based policies that allow broad access to the secret.</p>
1207
+ * <p>Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.</p>
1232
1208
  */
1233
1209
  BlockPublicPolicy?: boolean;
1234
1210
  }
@@ -1240,11 +1216,11 @@ export declare namespace PutResourcePolicyRequest {
1240
1216
  }
1241
1217
  export interface PutResourcePolicyResponse {
1242
1218
  /**
1243
- * <p>The ARN of the secret retrieved by the resource-based policy.</p>
1219
+ * <p>The ARN of the secret.</p>
1244
1220
  */
1245
1221
  ARN?: string;
1246
1222
  /**
1247
- * <p>The friendly name of the secret retrieved by the resource-based policy.</p>
1223
+ * <p>The name of the secret.</p>
1248
1224
  */
1249
1225
  Name?: string;
1250
1226
  }
@@ -1256,25 +1232,24 @@ export declare namespace PutResourcePolicyResponse {
1256
1232
  }
1257
1233
  export interface PutSecretValueRequest {
1258
1234
  /**
1259
- * <p>Specifies the secret to which you want to add a new version. You can specify either the
1260
- * Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already
1261
- * exist.</p>
1235
+ * <p>The ARN or name of the secret to add a new version to.</p>
1262
1236
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1263
1237
  * than a partial ARN.</p>
1238
+ * <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
1264
1239
  */
1265
1240
  SecretId: string | undefined;
1266
1241
  /**
1267
- * <p>(Optional) Specifies a unique identifier for the new version of the secret. </p>
1242
+ * <p>A unique identifier for the new version of the secret. </p>
1268
1243
  * <note>
1269
- * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
1270
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that
1271
- * in the request. If you don't use the SDK and instead generate a raw HTTP request to the
1244
+ * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can
1245
+ * leave this parameter empty because they generate a random UUID for you. If you don't
1246
+ * use the SDK and instead generate a raw HTTP request to the
1272
1247
  * Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself
1273
1248
  * for new versions and include that value in the request. </p>
1274
1249
  * </note>
1275
1250
  * <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental
1276
1251
  * creation of duplicate versions if there are failures and retries during the Lambda rotation
1277
- * function's processing. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to
1252
+ * function processing. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to
1278
1253
  * ensure uniqueness within the specified secret. </p>
1279
1254
  * <ul>
1280
1255
  * <li>
@@ -1283,13 +1258,13 @@ export interface PutSecretValueRequest {
1283
1258
  * </li>
1284
1259
  * <li>
1285
1260
  * <p>If a version with this value already exists and that version's
1286
- * <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in
1287
- * the request then the request is ignored (the operation is idempotent). </p>
1261
+ * <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in
1262
+ * the request then the request is ignored. The operation is idempotent. </p>
1288
1263
  * </li>
1289
1264
  * <li>
1290
1265
  * <p>If a version with this value already exists and the version of the
1291
- * <code>SecretString</code> and <code>SecretBinary</code> values are different from those
1292
- * in the request then the request fails because you cannot modify an existing secret
1266
+ * <code>SecretString</code> and <code>SecretBinary</code> values are different from those
1267
+ * in the request, then the request fails because you can't modify a secret
1293
1268
  * version. You can only create new versions to store new secret values.</p>
1294
1269
  * </li>
1295
1270
  * </ul>
@@ -1297,39 +1272,31 @@ export interface PutSecretValueRequest {
1297
1272
  */
1298
1273
  ClientRequestToken?: string;
1299
1274
  /**
1300
- * <p>(Optional) Specifies binary data that you want to encrypt and store in the new version of
1275
+ * <p>The binary data to encrypt and store in the new version of
1301
1276
  * the secret. To use this parameter in the command-line tools, we recommend that you store your
1302
- * binary data in a file and then use the appropriate technique for your tool to pass the
1303
- * contents of the file as a parameter. Either <code>SecretBinary</code> or
1304
- * <code>SecretString</code> must have a value, but not both. They cannot both be empty.</p>
1305
- *
1306
- * <p>This parameter is not accessible if the secret using the Secrets Manager console.</p>
1307
- * <p></p>
1277
+ * binary data in a file and then pass the
1278
+ * contents of the file as a parameter. </p>
1279
+ * <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
1280
+ * <p>You can't access this value from the Secrets Manager console.</p>
1308
1281
  */
1309
1282
  SecretBinary?: Uint8Array;
1310
1283
  /**
1311
- * <p>(Optional) Specifies text data that you want to encrypt and store in this new version of
1312
- * the secret. Either <code>SecretString</code> or <code>SecretBinary</code> must have a value,
1313
- * but not both. They cannot both be empty.</p>
1314
- *
1315
- * <p>If you create this secret by using the Secrets Manager console then Secrets Manager puts the
1316
- * protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console
1317
- * stores the information as a JSON structure of key/value pairs that the default Lambda rotation
1318
- * function knows how to parse.</p>
1319
- * <p>For storing multiple values, we recommend that you use a JSON text
1320
- * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1321
- * in the Amazon Web Services CLI User Guide.</p>
1284
+ * <p>The text to encrypt and store in the new version of the secret. </p>
1285
+ * <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
1286
+ * <p>We recommend you create the secret string as JSON key/value pairs, as shown in the example.</p>
1322
1287
  */
1323
1288
  SecretString?: string;
1324
1289
  /**
1325
- * <p>(Optional) Specifies a list of staging labels that are attached to this version of the
1326
- * secret. These staging labels are used to track the versions through the rotation process by
1327
- * the Lambda rotation function.</p>
1328
- * <p>A staging label must be unique to a single version of the secret. If you specify a staging
1329
- * label that's already associated with a different version of the same secret then that staging
1330
- * label is automatically removed from the other version and attached to this version.</p>
1331
- * <p>If you do not specify a value for <code>VersionStages</code> then Secrets Manager automatically
1332
- * moves the staging label <code>AWSCURRENT</code> to this new version.</p>
1290
+ * <p>A list of staging labels to attach to this version of the
1291
+ * secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
1292
+ * <p>If you specify a staging
1293
+ * label that's already associated with a different version of the same secret, then Secrets Manager
1294
+ * removes the label from the other version and attaches it to this version.
1295
+ * If you specify
1296
+ * <code>AWSCURRENT</code>, and it is already attached to another version, then Secrets Manager also
1297
+ * moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p>
1298
+ * <p>If you don't include <code>VersionStages</code>, then Secrets Manager automatically
1299
+ * moves the staging label <code>AWSCURRENT</code> to this version.</p>
1333
1300
  */
1334
1301
  VersionStages?: string[];
1335
1302
  }
@@ -1341,20 +1308,20 @@ export declare namespace PutSecretValueRequest {
1341
1308
  }
1342
1309
  export interface PutSecretValueResponse {
1343
1310
  /**
1344
- * <p>The Amazon Resource Name (ARN) for the secret for which you just created a version.</p>
1311
+ * <p>The ARN of the secret.</p>
1345
1312
  */
1346
1313
  ARN?: string;
1347
1314
  /**
1348
- * <p>The friendly name of the secret for which you just created or updated a version.</p>
1315
+ * <p>The name of the secret.</p>
1349
1316
  */
1350
1317
  Name?: string;
1351
1318
  /**
1352
- * <p>The unique identifier of the version of the secret you just created or updated.</p>
1319
+ * <p>The unique identifier of the version of the secret.</p>
1353
1320
  */
1354
1321
  VersionId?: string;
1355
1322
  /**
1356
1323
  * <p>The list of staging labels that are currently attached to this version of the secret.
1357
- * Staging labels are used to track a version as it progresses through the secret rotation
1324
+ * Secrets Manager uses staging labels to track a version as it progresses through the secret rotation
1358
1325
  * process.</p>
1359
1326
  */
1360
1327
  VersionStages?: string[];
@@ -1367,11 +1334,11 @@ export declare namespace PutSecretValueResponse {
1367
1334
  }
1368
1335
  export interface RemoveRegionsFromReplicationRequest {
1369
1336
  /**
1370
- * <p>Remove a secret by <code>SecretId</code> from replica Regions.</p>
1337
+ * <p>The ARN or name of the secret.</p>
1371
1338
  */
1372
1339
  SecretId: string | undefined;
1373
1340
  /**
1374
- * <p>Remove replication from specific Regions.</p>
1341
+ * <p>The Regions of the replicas to remove.</p>
1375
1342
  */
1376
1343
  RemoveReplicaRegions: string[] | undefined;
1377
1344
  }
@@ -1383,11 +1350,11 @@ export declare namespace RemoveRegionsFromReplicationRequest {
1383
1350
  }
1384
1351
  export interface RemoveRegionsFromReplicationResponse {
1385
1352
  /**
1386
- * <p>The secret <code>ARN</code> removed from replication regions.</p>
1353
+ * <p>The ARN of the primary secret.</p>
1387
1354
  */
1388
1355
  ARN?: string;
1389
1356
  /**
1390
- * <p>Describes the remaining replication status after you remove regions from the replication list.</p>
1357
+ * <p>The status of replicas for this secret after you remove Regions.</p>
1391
1358
  */
1392
1359
  ReplicationStatus?: ReplicationStatusType[];
1393
1360
  }
@@ -1399,16 +1366,15 @@ export declare namespace RemoveRegionsFromReplicationResponse {
1399
1366
  }
1400
1367
  export interface ReplicateSecretToRegionsRequest {
1401
1368
  /**
1402
- * <p>Use the <code>Secret Id</code> to replicate a secret to regions.</p>
1369
+ * <p>The ARN or name of the secret to replicate.</p>
1403
1370
  */
1404
1371
  SecretId: string | undefined;
1405
1372
  /**
1406
- * <p>Add Regions to replicate the secret.</p>
1373
+ * <p>A list of Regions in which to replicate the secret.</p>
1407
1374
  */
1408
1375
  AddReplicaRegions: ReplicaRegionType[] | undefined;
1409
1376
  /**
1410
- * <p>(Optional) If set, Secrets Manager replication overwrites a secret with the same name in the
1411
- * destination region.</p>
1377
+ * <p>Specifies whether to overwrite a secret with the same name in the destination Region.</p>
1412
1378
  */
1413
1379
  ForceOverwriteReplicaSecret?: boolean;
1414
1380
  }
@@ -1420,12 +1386,11 @@ export declare namespace ReplicateSecretToRegionsRequest {
1420
1386
  }
1421
1387
  export interface ReplicateSecretToRegionsResponse {
1422
1388
  /**
1423
- * <p>Replicate a secret based on the <code>ReplicaRegionType</code>> consisting of a
1424
- * Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. </p>
1389
+ * <p>The ARN of the primary secret.</p>
1425
1390
  */
1426
1391
  ARN?: string;
1427
1392
  /**
1428
- * <p>Describes the secret replication status as <code>PENDING</code>, <code>SUCCESS</code> or <code>FAIL</code>.</p>
1393
+ * <p>The status of replication.</p>
1429
1394
  */
1430
1395
  ReplicationStatus?: ReplicationStatusType[];
1431
1396
  }
@@ -1437,8 +1402,7 @@ export declare namespace ReplicateSecretToRegionsResponse {
1437
1402
  }
1438
1403
  export interface RestoreSecretRequest {
1439
1404
  /**
1440
- * <p>Specifies the secret that you want to restore from a previously scheduled deletion. You
1441
- * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1405
+ * <p>The ARN or name of the secret to restore.</p>
1442
1406
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1443
1407
  * than a partial ARN.</p>
1444
1408
  */
@@ -1456,7 +1420,7 @@ export interface RestoreSecretResponse {
1456
1420
  */
1457
1421
  ARN?: string;
1458
1422
  /**
1459
- * <p>The friendly name of the secret that was restored.</p>
1423
+ * <p>The name of the secret that was restored.</p>
1460
1424
  */
1461
1425
  Name?: string;
1462
1426
  }
@@ -1468,31 +1432,29 @@ export declare namespace RestoreSecretResponse {
1468
1432
  }
1469
1433
  export interface RotateSecretRequest {
1470
1434
  /**
1471
- * <p>Specifies the secret that you want to rotate. You can specify either the Amazon Resource
1472
- * Name (ARN) or the friendly name of the secret.</p>
1435
+ * <p>The ARN or name of the secret to rotate.</p>
1473
1436
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1474
1437
  * than a partial ARN.</p>
1475
1438
  */
1476
1439
  SecretId: string | undefined;
1477
1440
  /**
1478
- * <p>(Optional) Specifies a unique identifier for the new version of the secret that helps
1479
- * ensure idempotency. </p>
1441
+ * <p>A unique identifier for the new version of the secret that helps
1442
+ * ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
1443
+ * there are failures and retries during rotation. This value becomes the
1444
+ * <code>VersionId</code> of the new version.</p>
1480
1445
  * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
1481
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that
1482
- * in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP
1483
- * request to the Secrets Manager service endpoint, then you must generate a
1484
- * <code>ClientRequestToken</code> yourself for new versions and include that value in the
1485
- * request.</p>
1486
- * <p>You only need to specify your own value if you implement your own retry logic and want to
1487
- * ensure that a given secret is not created twice. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to
1488
- * ensure uniqueness within the specified secret. </p>
1489
- * <p>Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
1490
- * there are failures and retries during the function's processing. This value becomes the
1491
- * <code>VersionId</code> of the new version.</p>
1446
+ * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that
1447
+ * in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP
1448
+ * request to the Secrets Manager service endpoint, then you must generate a
1449
+ * <code>ClientRequestToken</code> yourself for new versions and include that value in the
1450
+ * request.</p>
1451
+ * <p>You only need to specify this value if you implement your own retry logic and you want to
1452
+ * ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to
1453
+ * ensure uniqueness within the specified secret. </p>
1492
1454
  */
1493
1455
  ClientRequestToken?: string;
1494
1456
  /**
1495
- * <p>(Optional) Specifies the ARN of the Lambda function that can rotate the secret.</p>
1457
+ * <p>The ARN of the Lambda rotation function that can rotate the secret.</p>
1496
1458
  */
1497
1459
  RotationLambdaARN?: string;
1498
1460
  /**
@@ -1512,12 +1474,11 @@ export interface RotateSecretResponse {
1512
1474
  */
1513
1475
  ARN?: string;
1514
1476
  /**
1515
- * <p>The friendly name of the secret.</p>
1477
+ * <p>The name of the secret.</p>
1516
1478
  */
1517
1479
  Name?: string;
1518
1480
  /**
1519
- * <p>The ID of the new version of the secret created by the rotation started by this
1520
- * request.</p>
1481
+ * <p>The ID of the new version of the secret.</p>
1521
1482
  */
1522
1483
  VersionId?: string;
1523
1484
  }
@@ -1529,7 +1490,7 @@ export declare namespace RotateSecretResponse {
1529
1490
  }
1530
1491
  export interface StopReplicationToReplicaRequest {
1531
1492
  /**
1532
- * <p>Response to <code>StopReplicationToReplica</code> of a secret, based on the <code>SecretId</code>.</p>
1493
+ * <p>The ARN of the primary secret. </p>
1533
1494
  */
1534
1495
  SecretId: string | undefined;
1535
1496
  }
@@ -1541,7 +1502,7 @@ export declare namespace StopReplicationToReplicaRequest {
1541
1502
  }
1542
1503
  export interface StopReplicationToReplicaResponse {
1543
1504
  /**
1544
- * <p>Response <code>StopReplicationToReplica</code> of a secret, based on the <code>ARN,</code>.</p>
1505
+ * <p>The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.</p>
1545
1506
  */
1546
1507
  ARN?: string;
1547
1508
  }
@@ -1553,16 +1514,16 @@ export declare namespace StopReplicationToReplicaResponse {
1553
1514
  }
1554
1515
  export interface TagResourceRequest {
1555
1516
  /**
1556
- * <p>The identifier for the secret that you want to attach tags to. You can specify either the
1517
+ * <p>The identifier for the secret to attach tags to. You can specify either the
1557
1518
  * Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1558
1519
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1559
1520
  * than a partial ARN.</p>
1560
1521
  */
1561
1522
  SecretId: string | undefined;
1562
1523
  /**
1563
- * <p>The tags to attach to the secret. Each element in the list consists of a <code>Key</code>
1524
+ * <p>The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a <code>Key</code>
1564
1525
  * and a <code>Value</code>.</p>
1565
- * <p>This parameter to the API requires a JSON text string argument.</p>
1526
+ *
1566
1527
  * <p>For storing multiple values, we recommend that you use a JSON text
1567
1528
  * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1568
1529
  * in the Amazon Web Services CLI User Guide.</p>
@@ -1577,8 +1538,7 @@ export declare namespace TagResourceRequest {
1577
1538
  }
1578
1539
  export interface UntagResourceRequest {
1579
1540
  /**
1580
- * <p>The identifier for the secret that you want to remove tags from. You can specify either
1581
- * the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1541
+ * <p>The ARN or name of the secret.</p>
1582
1542
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1583
1543
  * than a partial ARN.</p>
1584
1544
  */
@@ -1586,7 +1546,7 @@ export interface UntagResourceRequest {
1586
1546
  /**
1587
1547
  * <p>A list of tag key names to remove from the secret. You don't specify the value. Both the
1588
1548
  * key and its associated value are removed.</p>
1589
- * <p>This parameter to the API requires a JSON text string argument.</p>
1549
+ * <p>This parameter requires a JSON text string argument.</p>
1590
1550
  * <p>For storing multiple values, we recommend that you use a JSON text
1591
1551
  * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1592
1552
  * in the Amazon Web Services CLI User Guide.</p>
@@ -1601,83 +1561,59 @@ export declare namespace UntagResourceRequest {
1601
1561
  }
1602
1562
  export interface UpdateSecretRequest {
1603
1563
  /**
1604
- * <p>Specifies the secret that you want to modify or to which you want to add a new version.
1605
- * You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1606
- * secret.</p>
1564
+ * <p>The ARN or name of the secret.</p>
1607
1565
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1608
1566
  * than a partial ARN.</p>
1609
1567
  */
1610
1568
  SecretId: string | undefined;
1611
1569
  /**
1612
- * <p>(Optional) If you want to add a new version to the secret, this parameter specifies a
1613
- * unique identifier for the new version that helps ensure idempotency. </p>
1614
- * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
1615
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that
1616
- * in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
1617
- * service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for new
1618
- * versions and include that value in the request.</p>
1619
- * <p>You typically only need to interact with this value if you implement your own retry logic
1620
- * and want to ensure that a given secret is not created twice. We recommend that you generate a
1621
- * <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
1622
- * value to ensure uniqueness within the specified secret. </p>
1623
- * <p>Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
1624
- * there are failures and retries during the Lambda rotation function's processing.</p>
1625
- * <ul>
1626
- * <li>
1627
- * <p>If the <code>ClientRequestToken</code> value isn't already associated with a version
1628
- * of the secret then a new version of the secret is created. </p>
1629
- * </li>
1630
- * <li>
1631
- * <p>If a version with this value already exists and that version's
1632
- * <code>SecretString</code> and <code>SecretBinary</code> values are the same as those in
1633
- * the request then the request is ignored (the operation is idempotent). </p>
1634
- * </li>
1635
- * <li>
1636
- * <p>If a version with this value already exists and that version's
1637
- * <code>SecretString</code> and <code>SecretBinary</code> values are different from the
1638
- * request then an error occurs because you cannot modify an existing secret value.</p>
1639
- * </li>
1640
- * </ul>
1570
+ * <p>If you include <code>SecretString</code> or <code>SecretBinary</code>, then Secrets Manager creates
1571
+ * a new version for the secret, and this parameter specifies the unique identifier for the new
1572
+ * version.</p>
1573
+ * <note>
1574
+ * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can
1575
+ * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it
1576
+ * as the value for this parameter in the request. If you don't use the SDK and instead
1577
+ * generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
1578
+ * <code>ClientRequestToken</code> yourself for the new version and include the value in the
1579
+ * request.</p>
1580
+ * </note>
1641
1581
  * <p>This value becomes the <code>VersionId</code> of the new version.</p>
1642
1582
  */
1643
1583
  ClientRequestToken?: string;
1644
1584
  /**
1645
- * <p>(Optional) Specifies an updated user-provided description of the secret.</p>
1585
+ * <p>The description of the secret.</p>
1646
1586
  */
1647
1587
  Description?: string;
1648
1588
  /**
1649
- * <p>(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager
1650
- * uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label">Staging
1651
- * Labels</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.</p>
1589
+ * <p>The ARN, key ID, or alias of the KMS key that Secrets Manager
1590
+ * uses to encrypt new secret versions as well as any existing versions the staging labels
1591
+ * <code>AWSCURRENT</code>, <code>AWSPENDING</code>, or <code>AWSPREVIOUS</code>.
1592
+ * For more information about versions and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">Concepts: Version</a>.</p>
1652
1593
  * <important>
1653
- * <p>You can only use the account's default CMK to encrypt and decrypt if you call this
1654
- * operation using credentials from the same account that owns the secret. If the secret is in
1655
- * a different account, then you must create a custom CMK and provide the ARN of that CMK in
1656
- * this field. The user making the call must have permissions to both the secret and the CMK in
1594
+ * <p>You can only use the Amazon Web Services managed key <code>aws/secretsmanager</code> if you call this
1595
+ * operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in
1596
+ * a different account, then you must use a customer managed key and provide the ARN of that KMS key in
1597
+ * this field. The user making the call must have permissions to both the secret and the KMS key in
1657
1598
  * their respective accounts.</p>
1658
1599
  * </important>
1659
1600
  */
1660
1601
  KmsKeyId?: string;
1661
1602
  /**
1662
- * <p>(Optional) Specifies updated binary data that you want to encrypt and store in the new
1663
- * version of the secret. To use this parameter in the command-line tools, we recommend that you
1664
- * store your binary data in a file and then use the appropriate technique for your tool to pass
1665
- * the contents of the file as a parameter. Either <code>SecretBinary</code> or
1666
- * <code>SecretString</code> must have a value, but not both. They cannot both be empty.</p>
1667
- * <p>This parameter is not accessible using the Secrets Manager console.</p>
1603
+ * <p>The binary data to encrypt and store in the new
1604
+ * version of the secret. We recommend that you
1605
+ * store your binary data in a file and then pass
1606
+ * the contents of the file as a parameter. </p>
1607
+ * <p>Either <code>SecretBinary</code> or
1608
+ * <code>SecretString</code> must have a value, but not both.</p>
1609
+ * <p>You can't access this parameter in the Secrets Manager console.</p>
1668
1610
  */
1669
1611
  SecretBinary?: Uint8Array;
1670
1612
  /**
1671
- * <p>(Optional) Specifies updated text data that you want to encrypt and store in this new
1672
- * version of the secret. Either <code>SecretBinary</code> or <code>SecretString</code> must have
1673
- * a value, but not both. They cannot both be empty.</p>
1674
- * <p>If you create this secret by using the Secrets Manager console then Secrets Manager puts the
1675
- * protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console
1676
- * stores the information as a JSON structure of key/value pairs that the default Lambda rotation
1677
- * function knows how to parse.</p>
1678
- * <p>For storing multiple values, we recommend that you use a JSON text
1679
- * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1680
- * in the Amazon Web Services CLI User Guide.</p>
1613
+ * <p>The text data to encrypt and store in the new
1614
+ * version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value. </p>
1615
+ * <p>Either <code>SecretBinary</code> or <code>SecretString</code> must have
1616
+ * a value, but not both. </p>
1681
1617
  */
1682
1618
  SecretString?: string;
1683
1619
  }
@@ -1690,21 +1626,14 @@ export declare namespace UpdateSecretRequest {
1690
1626
  export interface UpdateSecretResponse {
1691
1627
  /**
1692
1628
  * <p>The ARN of the secret that was updated.</p>
1693
- * <note>
1694
- * <p>Secrets Manager automatically adds several random characters to the name at the end of the ARN when
1695
- * you initially create a secret. This affects only the ARN and not the actual friendly name.
1696
- * This ensures that if you create a new secret with the same name as an old secret that you
1697
- * previously deleted, then users with access to the old secret <i>don't</i>
1698
- * automatically get access to the new secret because the ARNs are different.</p>
1699
- * </note>
1700
1629
  */
1701
1630
  ARN?: string;
1702
1631
  /**
1703
- * <p>The friendly name of the secret that was updated.</p>
1632
+ * <p>The name of the secret that was updated.</p>
1704
1633
  */
1705
1634
  Name?: string;
1706
1635
  /**
1707
- * <p>If a new version of the secret was created by this operation, then <code>VersionId</code>
1636
+ * <p>If Secrets Manager created a new version of the secret during this operation, then <code>VersionId</code>
1708
1637
  * contains the unique identifier of the new version.</p>
1709
1638
  */
1710
1639
  VersionId?: string;
@@ -1717,9 +1646,7 @@ export declare namespace UpdateSecretResponse {
1717
1646
  }
1718
1647
  export interface UpdateSecretVersionStageRequest {
1719
1648
  /**
1720
- * <p>Specifies the secret with the version with the list of staging labels you want to modify.
1721
- * You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1722
- * secret.</p>
1649
+ * <p>The ARN or the name of the secret with the version and staging labelsto modify.</p>
1723
1650
  * <p>For an ARN, we recommend that you specify a complete ARN rather
1724
1651
  * than a partial ARN.</p>
1725
1652
  */
@@ -1729,7 +1656,7 @@ export interface UpdateSecretVersionStageRequest {
1729
1656
  */
1730
1657
  VersionStage: string | undefined;
1731
1658
  /**
1732
- * <p>Specifies the secret version ID of the version that the staging label is to be removed
1659
+ * <p>The ID of the version that the staging label is to be removed
1733
1660
  * from. If the staging label you are trying to attach to one version is already attached to a
1734
1661
  * different version, then you must include this parameter and specify the version that the label
1735
1662
  * is to be removed from. If the label is attached and you either do not specify this parameter,
@@ -1737,7 +1664,7 @@ export interface UpdateSecretVersionStageRequest {
1737
1664
  */
1738
1665
  RemoveFromVersionId?: string;
1739
1666
  /**
1740
- * <p>(Optional) The secret version ID that you want to add the staging label. If you want to
1667
+ * <p>The ID of the version to add the staging label to. To
1741
1668
  * remove a label from a version, then do not specify this parameter.</p>
1742
1669
  * <p>If the staging label is already attached to a different version of the secret, then you
1743
1670
  * must also specify the <code>RemoveFromVersionId</code> parameter. </p>
@@ -1752,11 +1679,11 @@ export declare namespace UpdateSecretVersionStageRequest {
1752
1679
  }
1753
1680
  export interface UpdateSecretVersionStageResponse {
1754
1681
  /**
1755
- * <p>The ARN of the secret with the modified staging label.</p>
1682
+ * <p>The ARN of the secret that was updated.</p>
1756
1683
  */
1757
1684
  ARN?: string;
1758
1685
  /**
1759
- * <p>The friendly name of the secret with the modified staging label.</p>
1686
+ * <p>The name of the secret that was updated.</p>
1760
1687
  */
1761
1688
  Name?: string;
1762
1689
  }
@@ -1768,19 +1695,13 @@ export declare namespace UpdateSecretVersionStageResponse {
1768
1695
  }
1769
1696
  export interface ValidateResourcePolicyRequest {
1770
1697
  /**
1771
- * <p> (Optional) The identifier of the secret with the resource-based policy you want to
1772
- * validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1773
- * secret.</p>
1774
- * <p>For an ARN, we recommend that you specify a complete ARN rather
1775
- * than a partial ARN.</p>
1698
+ * <p>This field is reserved for internal use.</p>
1776
1699
  */
1777
1700
  SecretId?: string;
1778
1701
  /**
1779
- * <p>A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services
1702
+ * <p>A JSON-formatted string that contains an Amazon Web Services
1780
1703
  * resource-based policy. The policy in the string identifies who can access or manage this
1781
- * secret and its versions. For information on how to format a JSON parameter for the various
1782
- * command line tool environments, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using
1783
- * JSON for Parameters</a> in the <i>CLI User Guide</i>.publi</p>
1704
+ * secret and its versions. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
1784
1705
  */
1785
1706
  ResourcePolicy: string | undefined;
1786
1707
  }
@@ -1811,11 +1732,11 @@ export declare namespace ValidationErrorsEntry {
1811
1732
  }
1812
1733
  export interface ValidateResourcePolicyResponse {
1813
1734
  /**
1814
- * <p>Returns a message stating that your Reource Policy passed validation. </p>
1735
+ * <p>True if your policy passes validation, otherwise false.</p>
1815
1736
  */
1816
1737
  PolicyValidationPassed?: boolean;
1817
1738
  /**
1818
- * <p>Returns an error message if your policy doesn't pass validatation.</p>
1739
+ * <p>Validation errors if your policy didn't pass validation.</p>
1819
1740
  */
1820
1741
  ValidationErrors?: ValidationErrorsEntry[];
1821
1742
  }