@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
@@ -204,7 +204,7 @@ export interface SecretsManagerClientResolvedConfig extends SecretsManagerClient
204
204
  * account and delivers log files to an Amazon S3 bucket. By using information that's collected
205
205
  * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the
206
206
  * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services
207
- * CloudTrail, see <a href="http://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
207
+ * CloudTrail, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
208
208
  * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.
209
209
  * To learn more about CloudTrail, including enabling it and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">Amazon Web Services CloudTrail User Guide</a>.</p>
210
210
  */
@@ -7,59 +7,17 @@ export interface CancelRotateSecretCommandInput extends CancelRotateSecretReques
7
7
  export interface CancelRotateSecretCommandOutput extends CancelRotateSecretResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Disables automatic scheduled rotation and cancels the rotation of a secret if currently in
11
- * progress.</p>
12
- * <p>To re-enable scheduled rotation, call <a>RotateSecret</a> with
13
- * <code>AutomaticallyRotateAfterDays</code> set to a value greater than 0. This immediately
14
- * rotates your secret and then enables the automatic schedule.</p>
10
+ * <p>Turns off automatic rotation, and if a rotation is currently in
11
+ * progress, cancels the rotation.</p>
12
+ * <p>To turn on automatic rotation again, call <a>RotateSecret</a>.</p>
15
13
  * <note>
16
- * <p>If you cancel a rotation while in progress, it can leave the <code>VersionStage</code>
14
+ * <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
17
15
  * labels in an unexpected state. Depending on the step of the rotation in progress, you might
18
16
  * need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified
19
- * by the <code>VersionId</code> response value. You should also evaluate the partially rotated
20
- * new version to see if it should be deleted, which you can do by removing all staging labels
21
- * from the new version <code>VersionStage</code> field.</p>
17
+ * by the <code>VersionId</code> response value. We recommend you also evaluate the partially rotated
18
+ * new version to see if it should be deleted. You can delete a version by removing all staging labels
19
+ * from it.</p>
22
20
  * </note>
23
- * <p>To successfully start a rotation, the staging label <code>AWSPENDING</code> must be in one of the
24
- * following states:</p>
25
- * <ul>
26
- * <li>
27
- * <p>Not attached to any version at all</p>
28
- * </li>
29
- * <li>
30
- * <p>Attached to the same version as the staging label <code>AWSCURRENT</code>
31
- * </p>
32
- * </li>
33
- * </ul>
34
- * <p>If the staging label <code>AWSPENDING</code> attached to a different version than the version with
35
- * <code>AWSCURRENT</code> then the attempt to rotate fails.</p>
36
- *
37
- * <p>
38
- * <b>Minimum permissions</b>
39
- * </p>
40
- * <p>To run this command, you must have the following permissions:</p>
41
- * <ul>
42
- * <li>
43
- * <p>secretsmanager:CancelRotateSecret</p>
44
- * </li>
45
- * </ul>
46
- * <p>
47
- * <b>Related operations</b>
48
- * </p>
49
- * <ul>
50
- * <li>
51
- * <p>To configure rotation for a secret or to manually trigger a rotation, use <a>RotateSecret</a>.</p>
52
- * </li>
53
- * <li>
54
- * <p>To get the rotation configuration details for a secret, use <a>DescribeSecret</a>.</p>
55
- * </li>
56
- * <li>
57
- * <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
58
- * </li>
59
- * <li>
60
- * <p>To list all of the versions currently associated with a secret, use <a>ListSecretVersionIds</a>.</p>
61
- * </li>
62
- * </ul>
63
21
  * @example
64
22
  * Use a bare-bones client and the command you need to make an API call.
65
23
  * ```javascript
@@ -72,7 +30,7 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
72
30
  *
73
31
  * @see {@link CancelRotateSecretCommandInput} for command's `input` shape.
74
32
  * @see {@link CancelRotateSecretCommandOutput} for command's `response` shape.
75
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
33
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
76
34
  *
77
35
  */
78
36
  export declare class CancelRotateSecretCommand extends $Command<CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,94 +7,26 @@ export interface CreateSecretCommandInput extends CreateSecretRequest {
7
7
  export interface CreateSecretCommandOutput extends CreateSecretResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the
10
+ * <p>Creates a new secret. A <i>secret</i> is a set of credentials, such as a
11
+ * user name and password, that you store in an encrypted form in Secrets Manager. The secret also
12
+ * includes the connection information to access a database or other service, which Secrets Manager
13
+ * doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
11
14
  * important information needed to manage the secret.</p>
12
- * <p>Secrets Manager stores the encrypted secret data in one of a collection of "versions"
13
- * associated with the secret. Each version contains a copy of the encrypted secret data. Each
14
- * version is associated with one or more "staging labels" that identify where the version is in
15
- * the rotation cycle. The <code>SecretVersionsToStages</code> field of the secret contains the
16
- * mapping of staging labels to the active versions of the secret. Versions without a staging
17
- * label are considered deprecated and not included in the list.</p>
18
- * <p>You provide the secret data to be encrypted by putting text in either the
19
- * <code>SecretString</code> parameter or binary data in the <code>SecretBinary</code>
20
- * parameter, but not both. If you include <code>SecretString</code> or <code>SecretBinary</code>
21
- * then Secrets Manager also creates an initial secret version and automatically attaches the staging
22
- * label <code>AWSCURRENT</code> to the new version.</p>
23
- * <note>
24
- * <ul>
25
- * <li>
26
- * <p>If you call an operation to encrypt or decrypt the <code>SecretString</code>
27
- * or <code>SecretBinary</code> for a secret in the same account as the calling user and that
28
- * secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default
29
- * Amazon Web Services managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key
30
- * doesn't already exist in your account then Secrets Manager creates it for you automatically. All
31
- * users and roles in the same Amazon Web Services account automatically have access to use the default CMK.
32
- * Note that if an Secrets Manager API call results in Amazon Web Services creating the account's
33
- * Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the
34
- * result.</p>
35
- * </li>
36
- * <li>
37
- * <p>If the secret resides in a different Amazon Web Services account from the credentials calling an API that
38
- * requires encryption or decryption of the secret value then you must create and use a custom
39
- * Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials
40
- * from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the
41
- * secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an
42
- * API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code>
43
- * using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account
44
- * access to that other account's user or role for both the kms:GenerateDataKey and
45
- * kms:Decrypt operations.</p>
46
- * </li>
47
- * </ul>
48
- * </note>
49
- * <p> </p>
50
- * <p>
51
- * <b>Minimum permissions</b>
52
- * </p>
53
- * <p>To run this command, you must have the following permissions:</p>
54
- * <ul>
55
- * <li>
56
- * <p>secretsmanager:CreateSecret</p>
57
- * </li>
58
- * <li>
59
- * <p>kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt
60
- * the secret. You do not need this permission to use the account default Amazon Web Services managed CMK
61
- * for Secrets Manager.</p>
62
- * </li>
63
- * <li>
64
- * <p>kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the
65
- * secret. You do not need this permission to use the account default Amazon Web Services managed CMK for
66
- * Secrets Manager.</p>
67
- * </li>
68
- * <li>
69
- * <p>secretsmanager:TagResource - needed only if you include the <code>Tags</code>
70
- * parameter. </p>
71
- * </li>
72
- * </ul>
73
- * <p>
74
- * <b>Related operations</b>
75
- * </p>
76
- * <ul>
77
- * <li>
78
- * <p>To delete a secret, use <a>DeleteSecret</a>.</p>
79
- * </li>
80
- * <li>
81
- * <p>To modify an existing secret, use <a>UpdateSecret</a>.</p>
82
- * </li>
83
- * <li>
84
- * <p>To create a new version of a secret, use <a>PutSecretValue</a>.</p>
85
- * </li>
86
- * <li>
87
- * <p>To retrieve the encrypted secure string and secure binary values, use <a>GetSecretValue</a>.</p>
88
- * </li>
89
- * <li>
90
- * <p>To retrieve all other details for a secret, use <a>DescribeSecret</a>. This
91
- * does not include the encrypted secure string and secure binary values.</p>
92
- * </li>
93
- * <li>
94
- * <p>To retrieve the list of secret versions associated with the current secret, use <a>DescribeSecret</a> and examine the <code>SecretVersionsToStages</code> response
95
- * value.</p>
96
- * </li>
97
- * </ul>
15
+ * <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 secret</a>.</p>
16
+ * <p>To create a secret, you can provide the secret value to be encrypted in either the
17
+ * <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both.
18
+ * If you include <code>SecretString</code> or <code>SecretBinary</code>
19
+ * then Secrets Manager creates an initial secret version and automatically attaches the staging
20
+ * label <code>AWSCURRENT</code> to it.</p>
21
+ * <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
22
+ * <code>aws/secretsmanager</code>. If this key
23
+ * doesn't already exist in your account, then Secrets Manager creates it for you automatically. All
24
+ * users and roles in the Amazon Web Services account automatically have access to use <code>aws/secretsmanager</code>.
25
+ * Creating <code>aws/secretsmanager</code> can result in a one-time significant delay in returning the
26
+ * result.</p>
27
+ * <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then
28
+ * you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must create
29
+ * and use a customer managed KMS key. </p>
98
30
  * @example
99
31
  * Use a bare-bones client and the command you need to make an API call.
100
32
  * ```javascript
@@ -107,7 +39,7 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
107
39
  *
108
40
  * @see {@link CreateSecretCommandInput} for command's `input` shape.
109
41
  * @see {@link CreateSecretCommandOutput} for command's `response` shape.
110
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
42
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
111
43
  *
112
44
  */
113
45
  export declare class CreateSecretCommand extends $Command<CreateSecretCommandInput, CreateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,30 +7,8 @@ export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyRe
7
7
  export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Deletes the resource-based permission policy attached to the secret.</p>
11
- * <p>
12
- * <b>Minimum permissions</b>
13
- * </p>
14
- * <p>To run this command, you must have the following permissions:</p>
15
- * <ul>
16
- * <li>
17
- * <p>secretsmanager:DeleteResourcePolicy</p>
18
- * </li>
19
- * </ul>
20
- * <p>
21
- * <b>Related operations</b>
22
- * </p>
23
- * <ul>
24
- * <li>
25
- * <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p>
26
- * </li>
27
- * <li>
28
- * <p>To retrieve the current resource-based policy attached to a secret, use <a>GetResourcePolicy</a>.</p>
29
- * </li>
30
- * <li>
31
- * <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
32
- * </li>
33
- * </ul>
10
+ * <p>Deletes the resource-based permission policy attached to the secret. To attach a policy to
11
+ * a secret, use <a>PutResourcePolicy</a>.</p>
34
12
  * @example
35
13
  * Use a bare-bones client and the command you need to make an API call.
36
14
  * ```javascript
@@ -43,7 +21,7 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
43
21
  *
44
22
  * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape.
45
23
  * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
46
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
24
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
47
25
  *
48
26
  */
49
27
  export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,52 +7,19 @@ export interface DeleteSecretCommandInput extends DeleteSecretRequest {
7
7
  export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Deletes an entire secret and all of the versions. You can optionally include a recovery
11
- * window during which you can restore the secret. If you don't specify a recovery window value,
12
- * the operation defaults to 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
10
+ * <p>Deletes a secret and all of its versions. You can specify a recovery
11
+ * window during which you can restore the secret. The minimum recovery window is 7 days.
12
+ * The default recovery window is 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
13
13
  * the secret that specifies the end of the recovery window. At the end of the recovery window,
14
14
  * Secrets Manager deletes the secret permanently.</p>
15
+ * <p>For information about deleting a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html">https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html</a>. </p>
16
+ * <p>Secrets Manager performs the permanent secret deletion at the end of the waiting period as a
17
+ * background task with low priority. There is no guarantee of a specific time after the
18
+ * recovery window for the permanent delete to occur.</p>
15
19
  * <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to
16
20
  * remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>
17
- * <p>You cannot access the encrypted secret information in any secret scheduled for deletion.
18
- * If you need to access that information, you must cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p>
19
- * <note>
20
- * <ul>
21
- * <li>
22
- * <p>There is no explicit operation to delete a version of a secret. Instead, remove all
23
- * staging labels from the <code>VersionStage</code> field of a version. That marks the
24
- * version as deprecated and allows Secrets Manager to delete it as needed. Versions without any
25
- * staging labels do not show up in <a>ListSecretVersionIds</a> unless you
26
- * specify <code>IncludeDeprecated</code>.</p>
27
- * </li>
28
- * <li>
29
- * <p>The permanent secret deletion at the end of the waiting period is performed as a
30
- * background task with low priority. There is no guarantee of a specific time after the
31
- * recovery window for the actual delete operation to occur.</p>
32
- * </li>
33
- * </ul>
34
- * </note>
35
- * <p>
36
- * <b>Minimum permissions</b>
37
- * </p>
38
- * <p>To run this command, you must have the following permissions:</p>
39
- * <ul>
40
- * <li>
41
- * <p>secretsmanager:DeleteSecret</p>
42
- * </li>
43
- * </ul>
44
- * <p>
45
- * <b>Related operations</b>
46
- * </p>
47
- * <ul>
48
- * <li>
49
- * <p>To create a secret, use <a>CreateSecret</a>.</p>
50
- * </li>
51
- * <li>
52
- * <p>To cancel deletion of a version of a secret before the recovery window has expired,
53
- * use <a>RestoreSecret</a>.</p>
54
- * </li>
55
- * </ul>
21
+ * <p>In a secret scheduled for deletion, you cannot access the encrypted secret value.
22
+ * To access that information, first cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p>
56
23
  * @example
57
24
  * Use a bare-bones client and the command you need to make an API call.
58
25
  * ```javascript
@@ -65,7 +32,7 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
65
32
  *
66
33
  * @see {@link DeleteSecretCommandInput} for command's `input` shape.
67
34
  * @see {@link DeleteSecretCommandOutput} for command's `response` shape.
68
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
35
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
69
36
  *
70
37
  */
71
38
  export declare class DeleteSecretCommand extends $Command<DeleteSecretCommandInput, DeleteSecretCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,34 +7,8 @@ export interface DescribeSecretCommandInput extends DescribeSecretRequest {
7
7
  export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves the details of a secret. It does not include the encrypted fields. Secrets
11
- * Manager only returns fields populated with a value in the response. </p>
12
- * <p>
13
- * <b>Minimum permissions</b>
14
- * </p>
15
- * <p>To run this command, you must have the following permissions:</p>
16
- * <ul>
17
- * <li>
18
- * <p>secretsmanager:DescribeSecret</p>
19
- * </li>
20
- * </ul>
21
- * <p>
22
- * <b>Related operations</b>
23
- * </p>
24
- * <ul>
25
- * <li>
26
- * <p>To create a secret, use <a>CreateSecret</a>.</p>
27
- * </li>
28
- * <li>
29
- * <p>To modify a secret, use <a>UpdateSecret</a>.</p>
30
- * </li>
31
- * <li>
32
- * <p>To retrieve the encrypted secret information in a version of the secret, use <a>GetSecretValue</a>.</p>
33
- * </li>
34
- * <li>
35
- * <p>To list all of the secrets in the Amazon Web Services account, use <a>ListSecrets</a>.</p>
36
- * </li>
37
- * </ul>
10
+ * <p>Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager
11
+ * only returns fields that have a value in the response. </p>
38
12
  * @example
39
13
  * Use a bare-bones client and the command you need to make an API call.
40
14
  * ```javascript
@@ -47,7 +21,7 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
47
21
  *
48
22
  * @see {@link DescribeSecretCommandInput} for command's `input` shape.
49
23
  * @see {@link DescribeSecretCommandOutput} for command's `response` shape.
50
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
24
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
51
25
  *
52
26
  */
53
27
  export declare class DescribeSecretCommand extends $Command<DescribeSecretCommandInput, DescribeSecretCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,19 +7,9 @@ export interface GetRandomPasswordCommandInput extends GetRandomPasswordRequest
7
7
  export interface GetRandomPasswordCommandOutput extends GetRandomPasswordResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Generates a random password of the specified complexity. This operation is intended for
11
- * use in the Lambda rotation function. Per best practice, we recommend that you specify the
10
+ * <p>Generates a random password. We recommend that you specify the
12
11
  * maximum length and include every character type that the system you are generating a password
13
12
  * for can support.</p>
14
- * <p>
15
- * <b>Minimum permissions</b>
16
- * </p>
17
- * <p>To run this command, you must have the following permissions:</p>
18
- * <ul>
19
- * <li>
20
- * <p>secretsmanager:GetRandomPassword</p>
21
- * </li>
22
- * </ul>
23
13
  * @example
24
14
  * Use a bare-bones client and the command you need to make an API call.
25
15
  * ```javascript
@@ -32,7 +22,7 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
32
22
  *
33
23
  * @see {@link GetRandomPasswordCommandInput} for command's `input` shape.
34
24
  * @see {@link GetRandomPasswordCommandOutput} for command's `response` shape.
35
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
25
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
36
26
  *
37
27
  */
38
28
  export declare class GetRandomPasswordCommand extends $Command<GetRandomPasswordCommandInput, GetRandomPasswordCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,33 +7,10 @@ export interface GetResourcePolicyCommandInput extends GetResourcePolicyRequest
7
7
  export interface GetResourcePolicyCommandOutput extends GetResourcePolicyResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves the JSON text of the resource-based policy document attached to the specified
11
- * secret. The JSON request string input and response output displays formatted code
12
- * with white space and line breaks for better readability. Submit your input as a single line
13
- * JSON string.</p>
14
- * <p>
15
- * <b>Minimum permissions</b>
16
- * </p>
17
- * <p>To run this command, you must have the following permissions:</p>
18
- * <ul>
19
- * <li>
20
- * <p>secretsmanager:GetResourcePolicy</p>
21
- * </li>
22
- * </ul>
23
- * <p>
24
- * <b>Related operations</b>
25
- * </p>
26
- * <ul>
27
- * <li>
28
- * <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p>
29
- * </li>
30
- * <li>
31
- * <p>To delete the resource-based policy attached to a secret, use <a>DeleteResourcePolicy</a>.</p>
32
- * </li>
33
- * <li>
34
- * <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
35
- * </li>
36
- * </ul>
10
+ * <p>Retrieves the JSON text of the resource-based policy document attached to the
11
+ * secret. For more information about permissions policies attached to a secret, see
12
+ * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
13
+ * policies attached to a secret</a>.</p>
37
14
  * @example
38
15
  * Use a bare-bones client and the command you need to make an API call.
39
16
  * ```javascript
@@ -46,7 +23,7 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
46
23
  *
47
24
  * @see {@link GetResourcePolicyCommandInput} for command's `input` shape.
48
25
  * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape.
49
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
50
27
  *
51
28
  */
52
29
  export declare class GetResourcePolicyCommand extends $Command<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -10,31 +10,10 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
10
10
  * <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
11
11
  * <code>SecretBinary</code> from the specified version of a secret, whichever contains
12
12
  * content.</p>
13
- * <p>
14
- * <b>Minimum permissions</b>
15
- * </p>
16
- * <p>To run this command, you must have the following permissions:</p>
17
- * <ul>
18
- * <li>
19
- * <p>secretsmanager:GetSecretValue</p>
20
- * </li>
21
- * <li>
22
- * <p>kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the
23
- * secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for
24
- * Secrets Manager.</p>
25
- * </li>
26
- * </ul>
27
- * <p>
28
- * <b>Related operations</b>
29
- * </p>
30
- * <ul>
31
- * <li>
32
- * <p>To create a new version of the secret with different encrypted information, use <a>PutSecretValue</a>.</p>
33
- * </li>
34
- * <li>
35
- * <p>To retrieve the non-encrypted details for the secret, use <a>DescribeSecret</a>.</p>
36
- * </li>
37
- * </ul>
13
+ * <p>For information about retrieving the secret value in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html">Retrieve secrets</a>. </p>
14
+ * <p>To run this command, you must have <code>secretsmanager:GetSecretValue</code> permissions.
15
+ * If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key
16
+ * <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code> permissions for that key.</p>
38
17
  * @example
39
18
  * Use a bare-bones client and the command you need to make an API call.
40
19
  * ```javascript
@@ -47,7 +26,7 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
47
26
  *
48
27
  * @see {@link GetSecretValueCommandInput} for command's `input` shape.
49
28
  * @see {@link GetSecretValueCommandOutput} for command's `response` shape.
50
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
29
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
51
30
  *
52
31
  */
53
32
  export declare class GetSecretValueCommand extends $Command<GetSecretValueCommandInput, GetSecretValueCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,35 +7,16 @@ export interface ListSecretVersionIdsCommandInput extends ListSecretVersionIdsRe
7
7
  export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists all of the versions attached to the specified secret. The output does not include
11
- * the <code>SecretString</code> or <code>SecretBinary</code> fields. By default, the list
12
- * includes only versions that have at least one staging label in <code>VersionStage</code>
13
- * attached.</p>
14
- * <note>
15
- * <p>Always check the <code>NextToken</code> response parameter
16
- * when calling any of the <code>List*</code> operations. These operations can occasionally return
17
- * an empty or shorter than expected list of results even when there more results become available.
18
- * When this happens, the <code>NextToken</code> response parameter contains a value to pass to the
19
- * next call to the same API to request the next part of the list.</p>
20
- * </note>
10
+ * <p>Lists the versions for a secret. </p>
11
+ * <p>To list the secrets in the account, use <a>ListSecrets</a>.</p>
12
+ * <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>,
13
+ * call <a>GetSecretValue</a>.</p>
14
+ *
21
15
  * <p>
22
16
  * <b>Minimum
23
17
  * permissions</b>
24
18
  * </p>
25
- * <p>To run this command, you must have the following permissions:</p>
26
- * <ul>
27
- * <li>
28
- * <p>secretsmanager:ListSecretVersionIds</p>
29
- * </li>
30
- * </ul>
31
- * <p>
32
- * <b>Related operations</b>
33
- * </p>
34
- * <ul>
35
- * <li>
36
- * <p>To list the secrets in an account, use <a>ListSecrets</a>.</p>
37
- * </li>
38
- * </ul>
19
+ * <p>To run this command, you must have <code>secretsmanager:ListSecretVersionIds</code> permissions.</p>
39
20
  * @example
40
21
  * Use a bare-bones client and the command you need to make an API call.
41
22
  * ```javascript
@@ -48,7 +29,7 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
48
29
  *
49
30
  * @see {@link ListSecretVersionIdsCommandInput} for command's `input` shape.
50
31
  * @see {@link ListSecretVersionIdsCommandOutput} for command's `response` shape.
51
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
32
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
52
33
  *
53
34
  */
54
35
  export declare class ListSecretVersionIdsCommand extends $Command<ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,36 +7,17 @@ export interface ListSecretsCommandInput extends ListSecretsRequest {
7
7
  export interface ListSecretsCommandOutput extends ListSecretsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the
11
- * versions currently stored for a specific secret, use <a>ListSecretVersionIds</a>.
12
- * The encrypted fields <code>SecretString</code> and <code>SecretBinary</code> are not included
13
- * in the output. To get that information, call the <a>GetSecretValue</a>
14
- * operation.</p>
15
- * <note>
16
- * <p>Always check the <code>NextToken</code> response parameter
17
- * when calling any of the <code>List*</code> operations. These operations can occasionally return
18
- * an empty or shorter than expected list of results even when there more results become available.
19
- * When this happens, the <code>NextToken</code> response parameter contains a value to pass to the
20
- * next call to the same API to request the next part of the list.</p>
21
- * </note>
10
+ * <p>Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account. </p>
11
+ * <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p>
12
+ * <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>,
13
+ * call <a>GetSecretValue</a>.</p>
14
+ * <p>For information about finding secrets in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Enhanced search capabilities
15
+ * for secrets in Secrets Manager</a>.</p>
22
16
  * <p>
23
17
  * <b>Minimum
24
18
  * permissions</b>
25
19
  * </p>
26
- * <p>To run this command, you must have the following permissions:</p>
27
- * <ul>
28
- * <li>
29
- * <p>secretsmanager:ListSecrets</p>
30
- * </li>
31
- * </ul>
32
- * <p>
33
- * <b>Related operations</b>
34
- * </p>
35
- * <ul>
36
- * <li>
37
- * <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p>
38
- * </li>
39
- * </ul>
20
+ * <p>To run this command, you must have <code>secretsmanager:ListSecrets</code> permissions.</p>
40
21
  * @example
41
22
  * Use a bare-bones client and the command you need to make an API call.
42
23
  * ```javascript
@@ -49,7 +30,7 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
49
30
  *
50
31
  * @see {@link ListSecretsCommandInput} for command's `input` shape.
51
32
  * @see {@link ListSecretsCommandOutput} for command's `response` shape.
52
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
33
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
53
34
  *
54
35
  */
55
36
  export declare class ListSecretsCommand extends $Command<ListSecretsCommandInput, ListSecretsCommandOutput, SecretsManagerClientResolvedConfig> {