@aws-sdk/client-secrets-manager 3.934.0 → 3.935.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +72 -29
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +18 -0
- package/dist-es/models/errors.js +169 -0
- package/dist-es/models/models_0.js +1 -187
- package/dist-es/schemas/schemas_0.js +54 -12
- package/dist-types/commands/BatchGetSecretValueCommand.d.ts +17 -6
- package/dist-types/commands/CancelRotateSecretCommand.d.ts +11 -13
- package/dist-types/commands/CreateSecretCommand.d.ts +40 -30
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +5 -5
- package/dist-types/commands/DeleteSecretCommand.d.ts +25 -23
- package/dist-types/commands/DescribeSecretCommand.d.ts +13 -5
- package/dist-types/commands/GetRandomPasswordCommand.d.ts +10 -7
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +5 -7
- package/dist-types/commands/GetSecretValueCommand.d.ts +12 -12
- package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +6 -6
- package/dist-types/commands/ListSecretsCommand.d.ts +20 -7
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +5 -6
- package/dist-types/commands/PutSecretValueCommand.d.ts +29 -25
- package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +5 -3
- package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +8 -3
- package/dist-types/commands/RestoreSecretCommand.d.ts +5 -5
- package/dist-types/commands/RotateSecretCommand.d.ts +28 -13
- package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +7 -5
- package/dist-types/commands/TagResourceCommand.d.ts +12 -11
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -8
- package/dist-types/commands/UpdateSecretCommand.d.ts +35 -24
- package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +19 -16
- package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +8 -6
- package/dist-types/index.d.ts +3 -1
- package/dist-types/models/enums.d.ts +42 -0
- package/dist-types/models/errors.d.ts +175 -0
- package/dist-types/models/models_0.d.ts +582 -588
- package/dist-types/schemas/schemas_0.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +3 -1
- package/dist-types/ts3.4/models/enums.d.ts +22 -0
- package/dist-types/ts3.4/models/errors.d.ts +97 -0
- package/dist-types/ts3.4/models/models_0.d.ts +21 -119
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +2 -0
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -1
- package/dist-types/models/index.d.ts +0 -1
- package/dist-types/ts3.4/models/index.d.ts +0 -1
|
@@ -39,6 +39,10 @@ const _EL = "ExcludeLowercase";
|
|
|
39
39
|
const _EM = "ErrorMessage";
|
|
40
40
|
const _EN = "ExcludeNumbers";
|
|
41
41
|
const _EP = "ExcludePunctuation";
|
|
42
|
+
const _ESRM = "ExternalSecretRotationMetadata";
|
|
43
|
+
const _ESRMI = "ExternalSecretRotationMetadataItem";
|
|
44
|
+
const _ESRMT = "ExternalSecretRotationMetadataType";
|
|
45
|
+
const _ESRRA = "ExternalSecretRotationRoleArn";
|
|
42
46
|
const _EU = "ExcludeUppercase";
|
|
43
47
|
const _F = "Filters";
|
|
44
48
|
const _FDWR = "ForceDeleteWithoutRecovery";
|
|
@@ -155,6 +159,7 @@ const _TLT = "TagListType";
|
|
|
155
159
|
const _TR = "TagResource";
|
|
156
160
|
const _TRR = "TagResourceRequest";
|
|
157
161
|
const _Ta = "Tag";
|
|
162
|
+
const _Ty = "Type";
|
|
158
163
|
const _UR = "UntagResource";
|
|
159
164
|
const _URR = "UntagResourceRequest";
|
|
160
165
|
const _US = "UpdateSecret";
|
|
@@ -163,7 +168,7 @@ const _USRp = "UpdateSecretResponse";
|
|
|
163
168
|
const _USVS = "UpdateSecretVersionStage";
|
|
164
169
|
const _USVSR = "UpdateSecretVersionStageRequest";
|
|
165
170
|
const _USVSRp = "UpdateSecretVersionStageResponse";
|
|
166
|
-
const _V = "
|
|
171
|
+
const _V = "Value";
|
|
167
172
|
const _VE = "ValidationErrors";
|
|
168
173
|
const _VEE = "ValidationErrorsEntry";
|
|
169
174
|
const _VET = "ValidationErrorsType";
|
|
@@ -174,7 +179,7 @@ const _VRPR = "ValidateResourcePolicyRequest";
|
|
|
174
179
|
const _VRPRa = "ValidateResourcePolicyResponse";
|
|
175
180
|
const _VS = "VersionStage";
|
|
176
181
|
const _VSe = "VersionStages";
|
|
177
|
-
const _Va = "
|
|
182
|
+
const _Va = "Values";
|
|
178
183
|
const _Ve = "Versions";
|
|
179
184
|
const _c = "client";
|
|
180
185
|
const _e = "error";
|
|
@@ -182,7 +187,7 @@ const _s = "server";
|
|
|
182
187
|
const _sm = "smithy.ts.sdk.synthetic.com.amazonaws.secretsmanager";
|
|
183
188
|
const n0 = "com.amazonaws.secretsmanager";
|
|
184
189
|
import { TypeRegistry } from "@smithy/core/schema";
|
|
185
|
-
import { DecryptionFailure as __DecryptionFailure, EncryptionFailure as __EncryptionFailure, InternalServiceError as __InternalServiceError, InvalidNextTokenException as __InvalidNextTokenException, InvalidParameterException as __InvalidParameterException, InvalidRequestException as __InvalidRequestException, LimitExceededException as __LimitExceededException, MalformedPolicyDocumentException as __MalformedPolicyDocumentException, PreconditionNotMetException as __PreconditionNotMetException, PublicPolicyException as __PublicPolicyException, ResourceExistsException as __ResourceExistsException, ResourceNotFoundException as __ResourceNotFoundException, } from "../models/
|
|
190
|
+
import { DecryptionFailure as __DecryptionFailure, EncryptionFailure as __EncryptionFailure, InternalServiceError as __InternalServiceError, InvalidNextTokenException as __InvalidNextTokenException, InvalidParameterException as __InvalidParameterException, InvalidRequestException as __InvalidRequestException, LimitExceededException as __LimitExceededException, MalformedPolicyDocumentException as __MalformedPolicyDocumentException, PreconditionNotMetException as __PreconditionNotMetException, PublicPolicyException as __PublicPolicyException, ResourceExistsException as __ResourceExistsException, ResourceNotFoundException as __ResourceNotFoundException, } from "../models/errors";
|
|
186
191
|
import { SecretsManagerServiceException as __SecretsManagerServiceException } from "../models/SecretsManagerServiceException";
|
|
187
192
|
export var RandomPasswordType = [0, n0, _RPT, 8, 0];
|
|
188
193
|
export var RotationTokenType = [0, n0, _RTT, 8, 0];
|
|
@@ -212,7 +217,7 @@ export var CreateSecretRequest = [
|
|
|
212
217
|
n0,
|
|
213
218
|
_CSR,
|
|
214
219
|
0,
|
|
215
|
-
[_N, _CRT, _D, _KKI, _SB, _SS, _T, _ARR, _FORS],
|
|
220
|
+
[_N, _CRT, _D, _KKI, _SB, _SS, _T, _ARR, _FORS, _Ty],
|
|
216
221
|
[
|
|
217
222
|
0,
|
|
218
223
|
[0, 4],
|
|
@@ -223,6 +228,7 @@ export var CreateSecretRequest = [
|
|
|
223
228
|
() => TagListType,
|
|
224
229
|
() => AddReplicaRegionListType,
|
|
225
230
|
2,
|
|
231
|
+
0,
|
|
226
232
|
],
|
|
227
233
|
];
|
|
228
234
|
export var CreateSecretResponse = [
|
|
@@ -254,15 +260,40 @@ export var DescribeSecretResponse = [
|
|
|
254
260
|
n0,
|
|
255
261
|
_DSResc,
|
|
256
262
|
0,
|
|
257
|
-
[
|
|
263
|
+
[
|
|
264
|
+
_ARN,
|
|
265
|
+
_N,
|
|
266
|
+
_Ty,
|
|
267
|
+
_D,
|
|
268
|
+
_KKI,
|
|
269
|
+
_RE,
|
|
270
|
+
_RLARN,
|
|
271
|
+
_RR,
|
|
272
|
+
_ESRM,
|
|
273
|
+
_ESRRA,
|
|
274
|
+
_LRD,
|
|
275
|
+
_LCD,
|
|
276
|
+
_LAD,
|
|
277
|
+
_DDe,
|
|
278
|
+
_NRD,
|
|
279
|
+
_T,
|
|
280
|
+
_VITS,
|
|
281
|
+
_OS,
|
|
282
|
+
_CD,
|
|
283
|
+
_PR,
|
|
284
|
+
_RS,
|
|
285
|
+
],
|
|
258
286
|
[
|
|
259
287
|
0,
|
|
260
288
|
0,
|
|
261
289
|
0,
|
|
262
290
|
0,
|
|
291
|
+
0,
|
|
263
292
|
2,
|
|
264
293
|
0,
|
|
265
294
|
() => RotationRulesType,
|
|
295
|
+
() => ExternalSecretRotationMetadataType,
|
|
296
|
+
0,
|
|
266
297
|
4,
|
|
267
298
|
4,
|
|
268
299
|
4,
|
|
@@ -287,7 +318,8 @@ export var EncryptionFailure = [
|
|
|
287
318
|
[0],
|
|
288
319
|
];
|
|
289
320
|
TypeRegistry.for(n0).registerError(EncryptionFailure, __EncryptionFailure);
|
|
290
|
-
export var
|
|
321
|
+
export var ExternalSecretRotationMetadataItem = [3, n0, _ESRMI, 0, [_K, _V], [0, 0]];
|
|
322
|
+
export var Filter = [3, n0, _Fi, 0, [_K, _Va], [0, 64 | 0]];
|
|
291
323
|
export var GetRandomPasswordRequest = [
|
|
292
324
|
3,
|
|
293
325
|
n0,
|
|
@@ -488,8 +520,8 @@ export var RotateSecretRequest = [
|
|
|
488
520
|
n0,
|
|
489
521
|
_RSRo,
|
|
490
522
|
0,
|
|
491
|
-
[_SI, _CRT, _RLARN, _RR, _RI],
|
|
492
|
-
[0, [0, 4], 0, () => RotationRulesType, 2],
|
|
523
|
+
[_SI, _CRT, _RLARN, _RR, _ESRM, _ESRRA, _RI],
|
|
524
|
+
[0, [0, 4], 0, () => RotationRulesType, () => ExternalSecretRotationMetadataType, 0, 2],
|
|
493
525
|
];
|
|
494
526
|
export var RotateSecretResponse = [3, n0, _RSRot, 0, [_ARN, _N, _VI], [0, 0, 0]];
|
|
495
527
|
export var RotationRulesType = [3, n0, _RRTo, 0, [_AAD, _Du, _SE], [1, 0, 0]];
|
|
@@ -498,15 +530,18 @@ export var SecretListEntry = [
|
|
|
498
530
|
n0,
|
|
499
531
|
_SLE,
|
|
500
532
|
0,
|
|
501
|
-
[_ARN, _N, _D, _KKI, _RE, _RLARN, _RR, _LRD, _LCD, _LAD, _DDe, _NRD, _T, _SVTS, _OS, _CD, _PR],
|
|
533
|
+
[_ARN, _N, _Ty, _D, _KKI, _RE, _RLARN, _RR, _ESRM, _ESRRA, _LRD, _LCD, _LAD, _DDe, _NRD, _T, _SVTS, _OS, _CD, _PR],
|
|
502
534
|
[
|
|
503
535
|
0,
|
|
504
536
|
0,
|
|
505
537
|
0,
|
|
506
538
|
0,
|
|
539
|
+
0,
|
|
507
540
|
2,
|
|
508
541
|
0,
|
|
509
542
|
() => RotationRulesType,
|
|
543
|
+
() => ExternalSecretRotationMetadataType,
|
|
544
|
+
0,
|
|
510
545
|
4,
|
|
511
546
|
4,
|
|
512
547
|
4,
|
|
@@ -537,7 +572,7 @@ export var SecretVersionsListEntry = [
|
|
|
537
572
|
];
|
|
538
573
|
export var StopReplicationToReplicaRequest = [3, n0, _SRTRR, 0, [_SI], [0]];
|
|
539
574
|
export var StopReplicationToReplicaResponse = [3, n0, _SRTRRt, 0, [_ARN], [0]];
|
|
540
|
-
export var Tag = [3, n0, _Ta, 0, [_K,
|
|
575
|
+
export var Tag = [3, n0, _Ta, 0, [_K, _V], [0, 0]];
|
|
541
576
|
export var TagResourceRequest = [3, n0, _TRR, 0, [_SI, _T], [0, () => TagListType]];
|
|
542
577
|
export var UntagResourceRequest = [3, n0, _URR, 0, [_SI, _TK], [0, 64 | 0]];
|
|
543
578
|
export var UpdateSecretRequest = [
|
|
@@ -545,8 +580,8 @@ export var UpdateSecretRequest = [
|
|
|
545
580
|
n0,
|
|
546
581
|
_USR,
|
|
547
582
|
0,
|
|
548
|
-
[_SI, _CRT, _D, _KKI, _SB, _SS],
|
|
549
|
-
[0, [0, 4], 0, 0, [() => SecretBinaryType, 0], [() => SecretStringType, 0]],
|
|
583
|
+
[_SI, _CRT, _D, _KKI, _SB, _SS, _Ty],
|
|
584
|
+
[0, [0, 4], 0, 0, [() => SecretBinaryType, 0], [() => SecretStringType, 0], 0],
|
|
550
585
|
];
|
|
551
586
|
export var UpdateSecretResponse = [3, n0, _USRp, 0, [_ARN, _N, _VI], [0, 0, 0]];
|
|
552
587
|
export var UpdateSecretVersionStageRequest = [
|
|
@@ -573,6 +608,13 @@ export var SecretsManagerServiceException = [-3, _sm, "SecretsManagerServiceExce
|
|
|
573
608
|
TypeRegistry.for(_sm).registerError(SecretsManagerServiceException, __SecretsManagerServiceException);
|
|
574
609
|
export var AddReplicaRegionListType = [1, n0, _ARRLT, 0, () => ReplicaRegionType];
|
|
575
610
|
export var APIErrorListType = [1, n0, _APIELT, 0, () => APIErrorType];
|
|
611
|
+
export var ExternalSecretRotationMetadataType = [
|
|
612
|
+
1,
|
|
613
|
+
n0,
|
|
614
|
+
_ESRMT,
|
|
615
|
+
0,
|
|
616
|
+
() => ExternalSecretRotationMetadataItem,
|
|
617
|
+
];
|
|
576
618
|
export var FiltersListType = [1, n0, _FLT, 0, () => Filter];
|
|
577
619
|
export var FilterValuesStringList = 64 | 0;
|
|
578
620
|
export var KmsKeyIdListType = 64 | 0;
|
|
@@ -27,14 +27,25 @@ declare const BatchGetSecretValueCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
|
|
31
|
+
* <code>SecretBinary</code> for up to 20 secrets. To retrieve a single secret, call
|
|
32
|
+
* <a>GetSecretValue</a>. </p>
|
|
33
|
+
* <p>To choose which secrets to retrieve, you can specify a list of secrets by name or ARN,
|
|
34
|
+
* or you can use filters. If Secrets Manager encounters errors such as
|
|
35
|
+
* <code>AccessDeniedException</code> while attempting to retrieve any of the secrets,
|
|
36
|
+
* you can see the errors in <code>Errors</code> in the response.</p>
|
|
37
|
+
* <p>Secrets Manager generates CloudTrail
|
|
38
|
+
* <code>GetSecretValue</code> log entries for each secret you request when you call this
|
|
39
|
+
* action. Do not include sensitive information in request parameters because it might be
|
|
40
|
+
* logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
33
41
|
* <p>
|
|
34
42
|
* <b>Required permissions: </b>
|
|
35
|
-
* <code>secretsmanager:BatchGetSecretValue</code>, and you must have
|
|
36
|
-
*
|
|
37
|
-
*
|
|
43
|
+
* <code>secretsmanager:BatchGetSecretValue</code>, and you must have
|
|
44
|
+
* <code>secretsmanager:GetSecretValue</code> for each secret. If you use filters, you
|
|
45
|
+
* must also have <code>secretsmanager:ListSecrets</code>. If the secrets are encrypted
|
|
46
|
+
* using customer-managed keys instead of the Amazon Web Services managed key
|
|
47
|
+
* <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code>
|
|
48
|
+
* permissions for the keys. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
38
49
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
39
50
|
* and access control in Secrets Manager</a>. </p>
|
|
40
51
|
* @example
|
|
@@ -27,23 +27,21 @@ declare const CancelRotateSecretCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Turns off automatic rotation, and if a rotation is currently in
|
|
31
|
-
*
|
|
30
|
+
* <p>Turns off automatic rotation, and if a rotation is currently in progress, cancels the
|
|
31
|
+
* rotation.</p>
|
|
32
32
|
* <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* <a>UpdateSecretVersionStage</a> to change staging labels.
|
|
40
|
-
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
|
|
33
|
+
* labels in an unexpected state. You might need to remove the staging label
|
|
34
|
+
* <code>AWSPENDING</code> from the partially created version. You also need to
|
|
35
|
+
* determine whether to roll back to the previous version of the secret by moving the
|
|
36
|
+
* staging label <code>AWSCURRENT</code> to the version that has <code>AWSPENDING</code>.
|
|
37
|
+
* To determine which version has a specific staging label, call <a>ListSecretVersionIds</a>. Then use <a>UpdateSecretVersionStage</a> to change staging labels. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation
|
|
38
|
+
* works</a>.</p>
|
|
41
39
|
* <p>To turn on automatic rotation again, call <a>RotateSecret</a>.</p>
|
|
42
40
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
43
41
|
* <p>
|
|
44
|
-
* <b>Required permissions:
|
|
45
|
-
*
|
|
46
|
-
*
|
|
42
|
+
* <b>Required permissions:
|
|
43
|
+
* </b>
|
|
44
|
+
* <code>secretsmanager:CancelRotateSecret</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
47
45
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
48
46
|
* and access control in Secrets Manager</a>. </p>
|
|
49
47
|
* @example
|
|
@@ -28,41 +28,50 @@ declare const CreateSecretCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Creates a new secret. A <i>secret</i> can be a password, a set of
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* <p>For secrets that use <i>managed rotation</i>, you need to create the
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* <p>For information about creating a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html">Create a
|
|
31
|
+
* credentials such as a user name and password, an OAuth token, or other secret
|
|
32
|
+
* information that you store in an encrypted form in Secrets Manager. The secret also includes the
|
|
33
|
+
* connection information to access a database or other service, which Secrets Manager doesn't
|
|
34
|
+
* encrypt. A secret in Secrets Manager consists of both the protected secret data and the important
|
|
35
|
+
* information needed to manage the secret.</p>
|
|
36
|
+
* <p>For secrets that use <i>managed rotation</i>, you need to create the
|
|
37
|
+
* secret through the managing service. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets
|
|
38
|
+
* managed by other Amazon Web Services services</a>. </p>
|
|
39
|
+
* <p>For information about creating a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html">Create a
|
|
40
|
+
* secret</a>.</p>
|
|
40
41
|
* <p>To create a secret, you can provide the secret value to be encrypted in either the
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the
|
|
46
|
-
*
|
|
47
|
-
*
|
|
42
|
+
* <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but
|
|
43
|
+
* not both. If you include <code>SecretString</code> or <code>SecretBinary</code> then
|
|
44
|
+
* Secrets Manager creates an initial secret version and automatically attaches the staging label
|
|
45
|
+
* <code>AWSCURRENT</code> to it.</p>
|
|
46
|
+
* <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the
|
|
47
|
+
* secret, you must make sure the JSON you store in the <code>SecretString</code> matches
|
|
48
|
+
* the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html">JSON
|
|
49
|
+
* structure of a database secret</a>.</p>
|
|
48
50
|
* <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
* <p>If the secret is in a different Amazon Web Services account from the credentials calling the API,
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* <p>Secrets Manager generates a CloudTrail log entry when you call this action.
|
|
51
|
+
* <code>aws/secretsmanager</code>. If this key doesn't already exist in your account,
|
|
52
|
+
* then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account
|
|
53
|
+
* automatically have access to use <code>aws/secretsmanager</code>. Creating
|
|
54
|
+
* <code>aws/secretsmanager</code> can result in a one-time significant delay in
|
|
55
|
+
* returning the result.</p>
|
|
56
|
+
* <p>If the secret is in a different Amazon Web Services account from the credentials calling the API,
|
|
57
|
+
* then you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must
|
|
58
|
+
* create and use a customer managed KMS key. </p>
|
|
59
|
+
* <p>Secrets Manager generates a CloudTrail log entry when you call this action.
|
|
60
|
+
* Do not include sensitive information in request parameters except
|
|
61
|
+
* <code>SecretBinary</code> or <code>SecretString</code> because it might be logged.
|
|
62
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
58
63
|
* <p>
|
|
59
|
-
* <b>Required permissions:
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
64
|
+
* <b>Required permissions:
|
|
65
|
+
* </b>
|
|
66
|
+
* <code>secretsmanager:CreateSecret</code>. If you include tags in the
|
|
67
|
+
* secret, you also need <code>secretsmanager:TagResource</code>. To add replica Regions,
|
|
68
|
+
* you must also have <code>secretsmanager:ReplicateSecretToRegions</code>.
|
|
69
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
63
70
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
64
71
|
* and access control in Secrets Manager</a>. </p>
|
|
65
|
-
* <p>To encrypt the secret with a KMS key other than <code>aws/secretsmanager</code>, you
|
|
72
|
+
* <p>To encrypt the secret with a KMS key other than <code>aws/secretsmanager</code>, you
|
|
73
|
+
* need <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permission to the
|
|
74
|
+
* key. </p>
|
|
66
75
|
* <important>
|
|
67
76
|
* <p>When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html">Mitigate the risks of using command-line tools to store Secrets Manager secrets</a>.</p>
|
|
68
77
|
* </important>
|
|
@@ -94,6 +103,7 @@ declare const CreateSecretCommand_base: {
|
|
|
94
103
|
* },
|
|
95
104
|
* ],
|
|
96
105
|
* ForceOverwriteReplicaSecret: true || false,
|
|
106
|
+
* Type: "STRING_VALUE",
|
|
97
107
|
* };
|
|
98
108
|
* const command = new CreateSecretCommand(input);
|
|
99
109
|
* const response = await client.send(command);
|
|
@@ -27,13 +27,13 @@ declare const DeleteResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the resource-based permission policy attached to the secret. To attach a
|
|
31
|
-
*
|
|
30
|
+
* <p>Deletes the resource-based permission policy attached to the secret. To attach a
|
|
31
|
+
* policy to a secret, use <a>PutResourcePolicy</a>.</p>
|
|
32
32
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
33
33
|
* <p>
|
|
34
|
-
* <b>Required permissions:
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* <b>Required permissions:
|
|
35
|
+
* </b>
|
|
36
|
+
* <code>secretsmanager:DeleteResourcePolicy</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
37
37
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
38
38
|
* and access control in Secrets Manager</a>. </p>
|
|
39
39
|
* @example
|
|
@@ -27,33 +27,35 @@ declare const DeleteSecretCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a secret and all of its versions. You can specify a recovery
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* <p>You can't delete a primary secret that is replicated to other Regions. You must first
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* <p>You can't directly delete a version of a secret. Instead, you remove all staging
|
|
39
|
-
*
|
|
40
|
-
*
|
|
30
|
+
* <p>Deletes a secret and all of its versions. You can specify a recovery window during
|
|
31
|
+
* which you can restore the secret. The minimum recovery window is 7 days. The default
|
|
32
|
+
* recovery window is 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to the
|
|
33
|
+
* secret that specifies the end of the recovery window. At the end of the recovery window,
|
|
34
|
+
* Secrets Manager deletes the secret permanently.</p>
|
|
35
|
+
* <p>You can't delete a primary secret that is replicated to other Regions. You must first
|
|
36
|
+
* delete the replicas using <a>RemoveRegionsFromReplication</a>, and then
|
|
37
|
+
* delete the primary secret. When you delete a replica, it is deleted immediately.</p>
|
|
38
|
+
* <p>You can't directly delete a version of a secret. Instead, you remove all staging
|
|
39
|
+
* labels from the version using <a>UpdateSecretVersionStage</a>. This marks the
|
|
40
|
+
* version as deprecated, and then Secrets Manager can automatically delete the version in the
|
|
41
|
+
* background.</p>
|
|
41
42
|
* <p>To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
43
|
+
* to alert you to any attempts to access a secret during the recovery window. For more
|
|
44
|
+
* information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html">
|
|
45
|
+
* Monitor secrets scheduled for deletion</a>.</p>
|
|
45
46
|
* <p>Secrets Manager performs the permanent secret deletion at the end of the waiting period as a
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* <p>At any time before recovery window ends, you can use <a>RestoreSecret</a>
|
|
49
|
-
*
|
|
50
|
-
* <p>When a secret is scheduled for deletion, you cannot retrieve the secret value.
|
|
51
|
-
*
|
|
47
|
+
* background task with low priority. There is no guarantee of a specific time after the
|
|
48
|
+
* recovery window for the permanent delete to occur.</p>
|
|
49
|
+
* <p>At any time before recovery window ends, you can use <a>RestoreSecret</a>
|
|
50
|
+
* to remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>
|
|
51
|
+
* <p>When a secret is scheduled for deletion, you cannot retrieve the secret value. You
|
|
52
|
+
* must first cancel the deletion with <a>RestoreSecret</a> and then you can
|
|
53
|
+
* retrieve the secret.</p>
|
|
52
54
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
53
55
|
* <p>
|
|
54
|
-
* <b>Required permissions:
|
|
55
|
-
*
|
|
56
|
-
*
|
|
56
|
+
* <b>Required permissions:
|
|
57
|
+
* </b>
|
|
58
|
+
* <code>secretsmanager:DeleteSecret</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
57
59
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
58
60
|
* and access control in Secrets Manager</a>. </p>
|
|
59
61
|
* @example
|
|
@@ -27,13 +27,13 @@ declare const DescribeSecretCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the details of a secret. It does not include the encrypted secret value.
|
|
31
|
-
*
|
|
30
|
+
* <p>Retrieves the details of a secret. It does not include the encrypted secret value.
|
|
31
|
+
* Secrets Manager only returns fields that have a value in the response. </p>
|
|
32
32
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
33
33
|
* <p>
|
|
34
|
-
* <b>Required permissions:
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* <b>Required permissions:
|
|
35
|
+
* </b>
|
|
36
|
+
* <code>secretsmanager:DescribeSecret</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
37
37
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
38
38
|
* and access control in Secrets Manager</a>. </p>
|
|
39
39
|
* @example
|
|
@@ -52,6 +52,7 @@ declare const DescribeSecretCommand_base: {
|
|
|
52
52
|
* // { // DescribeSecretResponse
|
|
53
53
|
* // ARN: "STRING_VALUE",
|
|
54
54
|
* // Name: "STRING_VALUE",
|
|
55
|
+
* // Type: "STRING_VALUE",
|
|
55
56
|
* // Description: "STRING_VALUE",
|
|
56
57
|
* // KmsKeyId: "STRING_VALUE",
|
|
57
58
|
* // RotationEnabled: true || false,
|
|
@@ -61,6 +62,13 @@ declare const DescribeSecretCommand_base: {
|
|
|
61
62
|
* // Duration: "STRING_VALUE",
|
|
62
63
|
* // ScheduleExpression: "STRING_VALUE",
|
|
63
64
|
* // },
|
|
65
|
+
* // ExternalSecretRotationMetadata: [ // ExternalSecretRotationMetadataType
|
|
66
|
+
* // { // ExternalSecretRotationMetadataItem
|
|
67
|
+
* // Key: "STRING_VALUE",
|
|
68
|
+
* // Value: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // ExternalSecretRotationRoleArn: "STRING_VALUE",
|
|
64
72
|
* // LastRotatedDate: new Date("TIMESTAMP"),
|
|
65
73
|
* // LastChangedDate: new Date("TIMESTAMP"),
|
|
66
74
|
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
@@ -27,15 +27,18 @@ declare const GetRandomPasswordCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Generates a random password. We recommend that you specify the
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Generates a random password. We recommend that you specify the maximum length and
|
|
31
|
+
* include every character type that the system you are generating a password for can
|
|
32
|
+
* support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the
|
|
33
|
+
* following characters in passwords:
|
|
34
|
+
* <code>!\"#$%&'()*+,-./:;<=>?@[\\]^_`\{|\}~</code>
|
|
33
35
|
* </p>
|
|
34
|
-
* <p>Secrets Manager generates a CloudTrail log entry when you call this
|
|
36
|
+
* <p>Secrets Manager generates a CloudTrail log entry when you call this
|
|
37
|
+
* action.</p>
|
|
35
38
|
* <p>
|
|
36
|
-
* <b>Required permissions:
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
+
* <b>Required permissions:
|
|
40
|
+
* </b>
|
|
41
|
+
* <code>secretsmanager:GetRandomPassword</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
39
42
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
40
43
|
* and access control in Secrets Manager</a>. </p>
|
|
41
44
|
* @example
|
|
@@ -27,15 +27,13 @@ declare const GetResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the JSON text of the resource-based policy document attached to the
|
|
31
|
-
*
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
|
|
33
|
-
* policies attached to a secret</a>.</p>
|
|
30
|
+
* <p>Retrieves the JSON text of the resource-based policy document attached to the secret.
|
|
31
|
+
* For more information about permissions policies attached to a secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions policies attached to a secret</a>.</p>
|
|
34
32
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
35
33
|
* <p>
|
|
36
|
-
* <b>Required permissions:
|
|
37
|
-
*
|
|
38
|
-
*
|
|
34
|
+
* <b>Required permissions:
|
|
35
|
+
* </b>
|
|
36
|
+
* <code>secretsmanager:GetResourcePolicy</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
39
37
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
40
38
|
* and access control in Secrets Manager</a>. </p>
|
|
41
39
|
* @example
|
|
@@ -28,21 +28,21 @@ declare const GetSecretValueCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* <code>SecretBinary</code> from the specified version of a secret, whichever contains
|
|
32
|
+
* content.</p>
|
|
33
33
|
* <p>To retrieve the values for a group of secrets, call <a>BatchGetSecretValue</a>.</p>
|
|
34
|
-
* <p>We recommend that you cache your secret values by using client-side caching.
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* AWSPREVIOUS. To revert to the previous version of a secret, call <a href="https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html">UpdateSecretVersionStage</a>.</p>
|
|
34
|
+
* <p>We recommend that you cache your secret values by using client-side caching. Caching
|
|
35
|
+
* secrets improves speed and reduces your costs. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html">Cache secrets for your applications</a>.</p>
|
|
36
|
+
* <p>To retrieve the previous version of a secret, use <code>VersionStage</code> and
|
|
37
|
+
* specify AWSPREVIOUS. To revert to the previous version of a secret, call <a href="https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html">UpdateSecretVersionStage</a>.</p>
|
|
39
38
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
40
39
|
* <p>
|
|
41
|
-
* <b>Required permissions:
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
40
|
+
* <b>Required permissions:
|
|
41
|
+
* </b>
|
|
42
|
+
* <code>secretsmanager:GetSecretValue</code>. If the secret is encrypted
|
|
43
|
+
* using a customer-managed key instead of the Amazon Web Services managed key
|
|
44
|
+
* <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code>
|
|
45
|
+
* permissions for that key. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
46
46
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
47
47
|
* and access control in Secrets Manager</a>. </p>
|
|
48
48
|
* @example
|
|
@@ -27,15 +27,15 @@ declare const ListSecretVersionIdsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different
|
|
31
|
+
* versions of a secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version"> Secrets Manager
|
|
32
|
+
* concepts: Versions</a>.</p>
|
|
33
33
|
* <p>To list the secrets in the account, use <a>ListSecrets</a>.</p>
|
|
34
34
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
35
35
|
* <p>
|
|
36
|
-
* <b>Required permissions:
|
|
37
|
-
*
|
|
38
|
-
*
|
|
36
|
+
* <b>Required permissions:
|
|
37
|
+
* </b>
|
|
38
|
+
* <code>secretsmanager:ListSecretVersionIds</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
39
39
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
40
40
|
* and access control in Secrets Manager</a>. </p>
|
|
41
41
|
* @example
|