@aws-sdk/client-secrets-manager 3.933.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
|
@@ -28,16 +28,21 @@ declare const ListSecretsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager
|
|
32
|
+
* console.</p>
|
|
33
|
+
* <p>All Secrets Manager operations are eventually consistent. ListSecrets might not
|
|
34
|
+
* reflect changes from the last five minutes. You can get more recent information for a
|
|
35
|
+
* specific secret by calling <a>DescribeSecret</a>.</p>
|
|
33
36
|
* <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p>
|
|
34
|
-
* <p>To retrieve the values for the secrets, call <a>BatchGetSecretValue</a> or
|
|
35
|
-
*
|
|
37
|
+
* <p>To retrieve the values for the secrets, call <a>BatchGetSecretValue</a> or
|
|
38
|
+
* <a>GetSecretValue</a>.</p>
|
|
39
|
+
* <p>For information about finding secrets in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in
|
|
40
|
+
* Secrets Manager</a>.</p>
|
|
36
41
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
37
42
|
* <p>
|
|
38
|
-
* <b>Required permissions:
|
|
39
|
-
*
|
|
40
|
-
*
|
|
43
|
+
* <b>Required permissions:
|
|
44
|
+
* </b>
|
|
45
|
+
* <code>secretsmanager:ListSecrets</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
41
46
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
42
47
|
* and access control in Secrets Manager</a>. </p>
|
|
43
48
|
* @example
|
|
@@ -69,6 +74,7 @@ declare const ListSecretsCommand_base: {
|
|
|
69
74
|
* // { // SecretListEntry
|
|
70
75
|
* // ARN: "STRING_VALUE",
|
|
71
76
|
* // Name: "STRING_VALUE",
|
|
77
|
+
* // Type: "STRING_VALUE",
|
|
72
78
|
* // Description: "STRING_VALUE",
|
|
73
79
|
* // KmsKeyId: "STRING_VALUE",
|
|
74
80
|
* // RotationEnabled: true || false,
|
|
@@ -78,6 +84,13 @@ declare const ListSecretsCommand_base: {
|
|
|
78
84
|
* // Duration: "STRING_VALUE",
|
|
79
85
|
* // ScheduleExpression: "STRING_VALUE",
|
|
80
86
|
* // },
|
|
87
|
+
* // ExternalSecretRotationMetadata: [ // ExternalSecretRotationMetadataType
|
|
88
|
+
* // { // ExternalSecretRotationMetadataItem
|
|
89
|
+
* // Key: "STRING_VALUE",
|
|
90
|
+
* // Value: "STRING_VALUE",
|
|
91
|
+
* // },
|
|
92
|
+
* // ],
|
|
93
|
+
* // ExternalSecretRotationRoleArn: "STRING_VALUE",
|
|
81
94
|
* // LastRotatedDate: new Date("TIMESTAMP"),
|
|
82
95
|
* // LastChangedDate: new Date("TIMESTAMP"),
|
|
83
96
|
* // LastAccessedDate: new Date("TIMESTAMP"),
|
|
@@ -28,15 +28,14 @@ declare const PutResourcePolicyCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Attaches a resource-based permission policy to a secret. A resource-based policy is
|
|
31
|
-
*
|
|
31
|
+
* optional. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control for Secrets Manager</a>
|
|
32
32
|
* </p>
|
|
33
|
-
* <p>For information about attaching a policy in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html">Attach a
|
|
34
|
-
* permissions policy to a secret</a>.</p>
|
|
33
|
+
* <p>For information about attaching a policy in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html">Attach a permissions policy to a secret</a>.</p>
|
|
35
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>
|
|
36
35
|
* <p>
|
|
37
|
-
* <b>Required permissions:
|
|
38
|
-
*
|
|
39
|
-
*
|
|
36
|
+
* <b>Required permissions:
|
|
37
|
+
* </b>
|
|
38
|
+
* <code>secretsmanager:PutResourcePolicy</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
40
39
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
41
40
|
* and access control in Secrets Manager</a>. </p>
|
|
42
41
|
* @example
|
|
@@ -27,32 +27,36 @@ declare const PutSecretValueCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new version
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
30
|
+
* <p>Creates a new version of your secret by creating a new encrypted value and attaching
|
|
31
|
+
* it to the secret. version can contain a new <code>SecretString</code> value or a new
|
|
32
|
+
* <code>SecretBinary</code> value. </p>
|
|
33
|
+
* <p>Do not call <code>PutSecretValue</code> at a sustained rate of more than once every 10
|
|
34
|
+
* minutes. When you update the secret value, Secrets Manager creates a new version of the secret.
|
|
35
|
+
* Secrets Manager keeps 100 of the most recent versions, but it keeps <i>all</i>
|
|
36
|
+
* secret versions created in the last 24 hours. If you call <code>PutSecretValue</code>
|
|
37
|
+
* more than once every 10 minutes, you will create more versions than Secrets Manager removes, and
|
|
38
|
+
* you will reach the quota for secret versions.</p>
|
|
39
|
+
* <p>You can specify the staging labels to attach to the new version in
|
|
40
|
+
* <code>VersionStages</code>. If you don't include <code>VersionStages</code>, then
|
|
41
|
+
* Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to this version. If
|
|
42
|
+
* this operation creates the first version for the secret, then Secrets Manager automatically
|
|
43
|
+
* attaches the staging label <code>AWSCURRENT</code> to it. If this operation moves the
|
|
44
|
+
* staging label <code>AWSCURRENT</code> from another version to this version, then Secrets Manager
|
|
45
|
+
* also automatically moves the staging label <code>AWSPREVIOUS</code> to the version that
|
|
46
|
+
* <code>AWSCURRENT</code> was removed from.</p>
|
|
47
|
+
* <p>This operation is idempotent. If you call this operation with a
|
|
48
|
+
* <code>ClientRequestToken</code> that matches an existing version's VersionId, and
|
|
49
|
+
* you specify the same secret data, the operation succeeds but does nothing. However, if
|
|
50
|
+
* the secret data is different, then the operation fails because you can't modify an
|
|
51
|
+
* existing version; you can only create new ones.</p>
|
|
52
|
+
* <p>Secrets Manager generates a CloudTrail log entry when you call this action.
|
|
53
|
+
* Do not include sensitive information in request parameters except
|
|
54
|
+
* <code>SecretBinary</code>, <code>SecretString</code>, or <code>RotationToken</code>
|
|
55
|
+
* 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>
|
|
52
56
|
* <p>
|
|
53
|
-
* <b>Required permissions:
|
|
54
|
-
*
|
|
55
|
-
*
|
|
57
|
+
* <b>Required permissions:
|
|
58
|
+
* </b>
|
|
59
|
+
* <code>secretsmanager:PutSecretValue</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
56
60
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
57
61
|
* and access control in Secrets Manager</a>. </p>
|
|
58
62
|
* <important>
|
|
@@ -27,12 +27,14 @@ declare const RemoveRegionsFromReplicationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>For a secret that is replicated to other Regions, deletes the secret replicas from the
|
|
30
|
+
* <p>For a secret that is replicated to other Regions, deletes the secret replicas from the
|
|
31
|
+
* Regions you specify.</p>
|
|
31
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>
|
|
32
33
|
* <p>
|
|
33
|
-
* <b>Required permissions:
|
|
34
|
+
* <b>Required permissions:
|
|
35
|
+
* </b>
|
|
34
36
|
* <code>secretsmanager:RemoveRegionsFromReplication</code>.
|
|
35
|
-
*
|
|
37
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
36
38
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
37
39
|
* and access control in Secrets Manager</a>. </p>
|
|
38
40
|
* @example
|
|
@@ -30,9 +30,14 @@ declare const ReplicateSecretToRegionsCommand_base: {
|
|
|
30
30
|
* <p>Replicates the secret to a new Regions. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html">Multi-Region secrets</a>.</p>
|
|
31
31
|
* <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>
|
|
32
32
|
* <p>
|
|
33
|
-
* <b>Required permissions:
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* <b>Required permissions:
|
|
34
|
+
* </b>
|
|
35
|
+
* <code>secretsmanager:ReplicateSecretToRegions</code>. If the primary
|
|
36
|
+
* secret is encrypted with a KMS key other than <code>aws/secretsmanager</code>, you also
|
|
37
|
+
* need <code>kms:Decrypt</code> permission to the key. To encrypt the replicated secret
|
|
38
|
+
* with a KMS key other than <code>aws/secretsmanager</code>, you need
|
|
39
|
+
* <code>kms:GenerateDataKey</code> and <code>kms:Encrypt</code> to the key.
|
|
40
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
36
41
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
37
42
|
* and access control in Secrets Manager</a>. </p>
|
|
38
43
|
* @example
|
|
@@ -27,13 +27,13 @@ declare const RestoreSecretCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code>
|
|
31
|
-
*
|
|
30
|
+
* <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code>
|
|
31
|
+
* time stamp. You can access a secret again after it has been restored.</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:RestoreSecret</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,22 +27,30 @@ declare const RotateSecretCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Configures and starts the asynchronous process of rotating the secret. For information
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
30
|
+
* <p>Configures and starts the asynchronous process of rotating the secret. For information
|
|
31
|
+
* about rotation, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>
|
|
32
|
+
* in the <i>Secrets Manager User Guide</i>. If you include the configuration
|
|
33
|
+
* parameters, the operation sets the values for the secret and then immediately starts a
|
|
34
|
+
* rotation. If you don't include the configuration parameters, the operation starts a
|
|
35
|
+
* rotation with the values already stored in the secret. </p>
|
|
36
|
+
* <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be
|
|
37
|
+
* attached to the same version as the <code>AWSCURRENT</code> version, or it might not be
|
|
38
|
+
* attached to any version. If the <code>AWSPENDING</code> staging label is present but not
|
|
39
|
+
* attached to the same version as <code>AWSCURRENT</code>, then any later invocation of
|
|
40
|
+
* <code>RotateSecret</code> assumes that a previous rotation request is still in
|
|
41
|
+
* progress and returns an error. When rotation is unsuccessful, the
|
|
42
|
+
* <code>AWSPENDING</code> staging label might be attached to an empty secret version.
|
|
43
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot
|
|
44
|
+
* rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
|
|
37
45
|
* <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>
|
|
38
46
|
* <p>
|
|
39
|
-
* <b>Required permissions:
|
|
40
|
-
*
|
|
41
|
-
*
|
|
47
|
+
* <b>Required permissions:
|
|
48
|
+
* </b>
|
|
49
|
+
* <code>secretsmanager:RotateSecret</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
42
50
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
43
|
-
* and access control in Secrets Manager</a>. You also
|
|
44
|
-
*
|
|
45
|
-
*
|
|
51
|
+
* and access control in Secrets Manager</a>. You also
|
|
52
|
+
* need <code>lambda:InvokeFunction</code> permissions on the rotation function. For more
|
|
53
|
+
* information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html"> Permissions for rotation</a>.</p>
|
|
46
54
|
* @example
|
|
47
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
48
56
|
* ```javascript
|
|
@@ -60,6 +68,13 @@ declare const RotateSecretCommand_base: {
|
|
|
60
68
|
* Duration: "STRING_VALUE",
|
|
61
69
|
* ScheduleExpression: "STRING_VALUE",
|
|
62
70
|
* },
|
|
71
|
+
* ExternalSecretRotationMetadata: [ // ExternalSecretRotationMetadataType
|
|
72
|
+
* { // ExternalSecretRotationMetadataItem
|
|
73
|
+
* Key: "STRING_VALUE",
|
|
74
|
+
* Value: "STRING_VALUE",
|
|
75
|
+
* },
|
|
76
|
+
* ],
|
|
77
|
+
* ExternalSecretRotationRoleArn: "STRING_VALUE",
|
|
63
78
|
* RotateImmediately: true || false,
|
|
64
79
|
* };
|
|
65
80
|
* const command = new RotateSecretCommand(input);
|
|
@@ -27,13 +27,15 @@ declare const StopReplicationToReplicaCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Removes the link between the replica secret and the primary secret and promotes the
|
|
31
|
-
*
|
|
30
|
+
* <p>Removes the link between the replica secret and the primary secret and promotes the
|
|
31
|
+
* replica to a primary secret in the replica Region.</p>
|
|
32
|
+
* <p>You must call this operation from the Region in which you want to promote the replica
|
|
33
|
+
* to a primary secret.</p>
|
|
32
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>
|
|
33
35
|
* <p>
|
|
34
|
-
* <b>Required permissions:
|
|
35
|
-
*
|
|
36
|
-
*
|
|
36
|
+
* <b>Required permissions:
|
|
37
|
+
* </b>
|
|
38
|
+
* <code>secretsmanager:StopReplicationToReplica</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
37
39
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
38
40
|
* and access control in Secrets Manager</a>. </p>
|
|
39
41
|
* @example
|
|
@@ -27,21 +27,22 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of
|
|
31
|
+
* the secret's metadata. They are not associated with specific versions of the secret.
|
|
32
|
+
* This operation appends tags to the existing list of tags.</p>
|
|
33
|
+
* <p>For tag quotas and naming restrictions, see <a href="https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas">Service quotas for
|
|
34
|
+
* Tagging</a> in the <i>Amazon Web Services General Reference guide</i>.</p>
|
|
34
35
|
* <important>
|
|
35
|
-
* <p>If you use tags as part of your security strategy, then adding or removing a tag
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
36
|
+
* <p>If you use tags as part of your security strategy, then adding or removing a tag
|
|
37
|
+
* can change permissions. If successfully completing this operation would result in
|
|
38
|
+
* you losing your permissions for this secret, then the operation is blocked and
|
|
39
|
+
* returns an Access Denied error.</p>
|
|
39
40
|
* </important>
|
|
40
41
|
* <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>
|
|
41
42
|
* <p>
|
|
42
|
-
* <b>Required permissions:
|
|
43
|
-
*
|
|
44
|
-
*
|
|
43
|
+
* <b>Required permissions:
|
|
44
|
+
* </b>
|
|
45
|
+
* <code>secretsmanager:TagResource</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
45
46
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
46
47
|
* and access control in Secrets Manager</a>. </p>
|
|
47
48
|
* @example
|
|
@@ -28,19 +28,19 @@ declare const UntagResourceCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Removes specific tags from a secret.</p>
|
|
31
|
-
* <p>This operation is idempotent. If a requested tag is not attached to the secret, no
|
|
32
|
-
*
|
|
31
|
+
* <p>This operation is idempotent. If a requested tag is not attached to the secret, no
|
|
32
|
+
* error is returned and the secret metadata is unchanged.</p>
|
|
33
33
|
* <important>
|
|
34
34
|
* <p>If you use tags as part of your security strategy, then removing a tag can change
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
35
|
+
* permissions. If successfully completing this operation would result in you losing
|
|
36
|
+
* your permissions for this secret, then the operation is blocked and returns an
|
|
37
|
+
* Access Denied error.</p>
|
|
38
38
|
* </important>
|
|
39
39
|
* <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
40
|
* <p>
|
|
41
|
-
* <b>Required permissions:
|
|
42
|
-
*
|
|
43
|
-
*
|
|
41
|
+
* <b>Required permissions:
|
|
42
|
+
* </b>
|
|
43
|
+
* <code>secretsmanager:UntagResource</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
44
44
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
45
45
|
* and access control in Secrets Manager</a>. </p>
|
|
46
46
|
* @example
|
|
@@ -27,33 +27,43 @@ declare const UpdateSecretCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Modifies the details of a secret, including metadata and the secret value. To change
|
|
31
|
-
*
|
|
32
|
-
* <p>To change
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
30
|
+
* <p>Modifies the details of a secret, including metadata and the secret value. To change
|
|
31
|
+
* the secret value, you can also use <a>PutSecretValue</a>.</p>
|
|
32
|
+
* <p>To change the rotation configuration of a secret, use <a>RotateSecret</a>
|
|
33
|
+
* instead.</p>
|
|
34
|
+
* <p>To change a secret so that it is managed by another service, you need to recreate the
|
|
35
|
+
* secret in that service. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets
|
|
36
|
+
* managed by other Amazon Web Services services</a>.</p>
|
|
37
|
+
* <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more
|
|
38
|
+
* than once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret
|
|
39
|
+
* value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when
|
|
40
|
+
* there are more than 100, but it does not remove versions created less than 24 hours ago.
|
|
41
|
+
* If you update the secret value more than once every 10 minutes, you create more versions
|
|
42
|
+
* than Secrets Manager removes, and you will reach the quota for secret versions.</p>
|
|
39
43
|
* <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* <p>If you call this operation with a <code>ClientRequestToken</code> that matches an
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
* <p>Secrets Manager generates a CloudTrail log entry when you call this action.
|
|
44
|
+
* secret version, Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to
|
|
45
|
+
* the new version. Then it attaches the label <code>AWSPREVIOUS</code> to the version that
|
|
46
|
+
* <code>AWSCURRENT</code> was removed from.</p>
|
|
47
|
+
* <p>If you call this operation with a <code>ClientRequestToken</code> that matches an
|
|
48
|
+
* existing version's <code>VersionId</code>, the operation results in an error. You can't
|
|
49
|
+
* modify an existing version, you can only create a new version. To remove a version,
|
|
50
|
+
* remove all staging labels from it. See <a>UpdateSecretVersionStage</a>.</p>
|
|
51
|
+
* <p>Secrets Manager generates a CloudTrail log entry when you call this action.
|
|
52
|
+
* Do not include sensitive information in request parameters except
|
|
53
|
+
* <code>SecretBinary</code> or <code>SecretString</code> because it might be logged.
|
|
54
|
+
* 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>
|
|
48
55
|
* <p>
|
|
49
|
-
* <b>Required permissions:
|
|
50
|
-
*
|
|
51
|
-
*
|
|
56
|
+
* <b>Required permissions:
|
|
57
|
+
* </b>
|
|
58
|
+
* <code>secretsmanager:UpdateSecret</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
52
59
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
53
|
-
* and access control in Secrets Manager</a>.
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
60
|
+
* and access control in Secrets Manager</a>. If you use a
|
|
61
|
+
* customer managed key, you must also have <code>kms:GenerateDataKey</code>,
|
|
62
|
+
* <code>kms:Encrypt</code>, and <code>kms:Decrypt</code> permissions on the key. If
|
|
63
|
+
* you change the KMS key and you don't have <code>kms:Encrypt</code> permission to the new
|
|
64
|
+
* key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more
|
|
65
|
+
* information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html"> Secret encryption
|
|
66
|
+
* and decryption</a>.</p>
|
|
57
67
|
* <important>
|
|
58
68
|
* <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>
|
|
59
69
|
* </important>
|
|
@@ -72,6 +82,7 @@ declare const UpdateSecretCommand_base: {
|
|
|
72
82
|
* KmsKeyId: "STRING_VALUE",
|
|
73
83
|
* SecretBinary: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
74
84
|
* SecretString: "STRING_VALUE",
|
|
85
|
+
* Type: "STRING_VALUE",
|
|
75
86
|
* };
|
|
76
87
|
* const command = new UpdateSecretCommand(input);
|
|
77
88
|
* const response = await client.send(command);
|
|
@@ -27,26 +27,29 @@ declare const UpdateSecretVersionStageCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* <p>
|
|
38
|
-
*
|
|
30
|
+
* <p>Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging
|
|
31
|
+
* labels to track a version as it progresses through the secret rotation process. Each
|
|
32
|
+
* staging label can be attached to only one version at a time. To add a staging label to a
|
|
33
|
+
* version when it is already attached to another version, Secrets Manager first removes it from the
|
|
34
|
+
* other version first and then attaches it to this one. For more information about
|
|
35
|
+
* versions and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">Concepts:
|
|
36
|
+
* Version</a>. </p>
|
|
37
|
+
* <p>The staging labels that you specify in the <code>VersionStage</code> parameter are
|
|
38
|
+
* added to the existing list of staging labels for the version. </p>
|
|
39
|
+
* <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it
|
|
40
|
+
* in this call.</p>
|
|
39
41
|
* <note>
|
|
40
|
-
* <p>Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label
|
|
41
|
-
*
|
|
42
|
+
* <p>Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label
|
|
43
|
+
* <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed
|
|
44
|
+
* from.</p>
|
|
42
45
|
* </note>
|
|
43
|
-
* <p>If this action results in the last label being removed from a version, then the
|
|
44
|
-
*
|
|
46
|
+
* <p>If this action results in the last label being removed from a version, then the
|
|
47
|
+
* version is considered to be 'deprecated' and can be deleted by Secrets Manager.</p>
|
|
45
48
|
* <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>
|
|
46
49
|
* <p>
|
|
47
|
-
* <b>Required permissions:
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
+
* <b>Required permissions:
|
|
51
|
+
* </b>
|
|
52
|
+
* <code>secretsmanager:UpdateSecretVersionStage</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
50
53
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
51
54
|
* and access control in Secrets Manager</a>. </p>
|
|
52
55
|
* @example
|
|
@@ -28,12 +28,13 @@ declare const ValidateResourcePolicyCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Validates that a resource policy does not grant a wide range of principals access to
|
|
31
|
-
*
|
|
31
|
+
* your secret. A resource-based policy is optional for secrets.</p>
|
|
32
32
|
* <p>The API performs three checks when validating the policy:</p>
|
|
33
33
|
* <ul>
|
|
34
34
|
* <li>
|
|
35
|
-
* <p>Sends a call to <a href="https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/">Zelkova</a>, an automated reasoning engine, to ensure your resource
|
|
36
|
-
*
|
|
35
|
+
* <p>Sends a call to <a href="https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/">Zelkova</a>, an automated reasoning engine, to ensure your resource
|
|
36
|
+
* policy does not allow broad access to your secret, for example policies that use
|
|
37
|
+
* a wildcard for the principal.</p>
|
|
37
38
|
* </li>
|
|
38
39
|
* <li>
|
|
39
40
|
* <p>Checks for correct syntax in a policy.</p>
|
|
@@ -44,9 +45,10 @@ declare const ValidateResourcePolicyCommand_base: {
|
|
|
44
45
|
* </ul>
|
|
45
46
|
* <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>
|
|
46
47
|
* <p>
|
|
47
|
-
* <b>Required permissions:
|
|
48
|
-
*
|
|
49
|
-
*
|
|
48
|
+
* <b>Required permissions:
|
|
49
|
+
* </b>
|
|
50
|
+
* <code>secretsmanager:ValidateResourcePolicy</code> and
|
|
51
|
+
* <code>secretsmanager:PutResourcePolicy</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
|
|
50
52
|
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
|
|
51
53
|
* and access control in Secrets Manager</a>. </p>
|
|
52
54
|
* @example
|
package/dist-types/index.d.ts
CHANGED
|
@@ -35,5 +35,7 @@ export type { RuntimeExtension } from "./runtimeExtensions";
|
|
|
35
35
|
export type { SecretsManagerExtensionConfiguration } from "./extensionConfiguration";
|
|
36
36
|
export * from "./commands";
|
|
37
37
|
export * from "./pagination";
|
|
38
|
-
export * from "./models";
|
|
38
|
+
export * from "./models/enums";
|
|
39
|
+
export * from "./models/errors";
|
|
40
|
+
export type * from "./models/models_0";
|
|
39
41
|
export { SecretsManagerServiceException } from "./models/SecretsManagerServiceException";
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @public
|
|
3
|
+
* @enum
|
|
4
|
+
*/
|
|
5
|
+
export declare const FilterNameStringType: {
|
|
6
|
+
readonly all: "all";
|
|
7
|
+
readonly description: "description";
|
|
8
|
+
readonly name: "name";
|
|
9
|
+
readonly owning_service: "owning-service";
|
|
10
|
+
readonly primary_region: "primary-region";
|
|
11
|
+
readonly tag_key: "tag-key";
|
|
12
|
+
readonly tag_value: "tag-value";
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export type FilterNameStringType = (typeof FilterNameStringType)[keyof typeof FilterNameStringType];
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* @enum
|
|
21
|
+
*/
|
|
22
|
+
export declare const StatusType: {
|
|
23
|
+
readonly Failed: "Failed";
|
|
24
|
+
readonly InProgress: "InProgress";
|
|
25
|
+
readonly InSync: "InSync";
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export type StatusType = (typeof StatusType)[keyof typeof StatusType];
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
* @enum
|
|
34
|
+
*/
|
|
35
|
+
export declare const SortOrderType: {
|
|
36
|
+
readonly asc: "asc";
|
|
37
|
+
readonly desc: "desc";
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
export type SortOrderType = (typeof SortOrderType)[keyof typeof SortOrderType];
|