@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
@@ -7,14 +7,13 @@ export interface UpdateSecretVersionStageCommandInput extends UpdateSecretVersio
7
7
  export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersionStageResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Modifies the staging labels attached to a version of a secret. Staging labels are used to
11
- * track a version as it progresses through the secret rotation process. You can attach a staging
12
- * label to only one version of a secret at a time. If a staging label to be added is already
13
- * attached to another version, then it is moved--removed from the other version first and
14
- * then attached to this one. For more information about staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label">Staging
15
- * Labels</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>. </p>
10
+ * <p>Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to
11
+ * track a version as it progresses through the secret rotation process. Each staging label can be
12
+ * attached to only one version at a time. To add a staging label to a version when it is already
13
+ * attached to another version, Secrets Manager first removes it from the other version first and
14
+ * then attaches it to this one. For more information about versions and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">Concepts: Version</a>. </p>
16
15
  * <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added
17
- * to the existing list of staging labels--they don't replace it.</p>
16
+ * to the existing list of staging labels for the version. </p>
18
17
  * <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this
19
18
  * call.</p>
20
19
  * <note>
@@ -23,27 +22,6 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
23
22
  * </note>
24
23
  * <p>If this action results in the last label being removed from a version, then the version is
25
24
  * considered to be 'deprecated' and can be deleted by Secrets Manager.</p>
26
- * <p>
27
- * <b>Minimum permissions</b>
28
- * </p>
29
- * <p>To run this command, you must have the following permissions:</p>
30
- * <ul>
31
- * <li>
32
- * <p>secretsmanager:UpdateSecretVersionStage</p>
33
- * </li>
34
- * </ul>
35
- * <p>
36
- * <b>Related operations</b>
37
- * </p>
38
- * <ul>
39
- * <li>
40
- * <p>To get the list of staging labels that are currently associated with a version of a
41
- * secret, use <code>
42
- * <a>DescribeSecret</a>
43
- * </code> and examine the
44
- * <code>SecretVersionsToStages</code> response value. </p>
45
- * </li>
46
- * </ul>
47
25
  * @example
48
26
  * Use a bare-bones client and the command you need to make an API call.
49
27
  * ```javascript
@@ -56,7 +34,7 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
56
34
  *
57
35
  * @see {@link UpdateSecretVersionStageCommandInput} for command's `input` shape.
58
36
  * @see {@link UpdateSecretVersionStageCommandOutput} for command's `response` shape.
59
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
37
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
60
38
  *
61
39
  */
62
40
  export declare class UpdateSecretVersionStageCommand extends $Command<UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOutput, SecretsManagerClientResolvedConfig> {
@@ -7,15 +7,13 @@ export interface ValidateResourcePolicyCommandInput extends ValidateResourcePoli
7
7
  export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePolicyResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Validates that the resource policy does not grant a wide range of IAM principals access to
11
- * your 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. A resource-based policy is optional for secrets.</p>
14
- * <p>The API performs three checks when validating the secret:</p>
10
+ * <p>Validates that a resource policy does not grant a wide range of principals access to
11
+ * your secret. A resource-based policy is optional for secrets.</p>
12
+ * <p>The API performs three checks when validating the policy:</p>
15
13
  * <ul>
16
14
  * <li>
17
- * <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 Policy does not
18
- * allow broad access to your secret.</p>
15
+ * <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 policy does not
16
+ * allow broad access to your secret, for example policies that use a wildcard for the principal.</p>
19
17
  * </li>
20
18
  * <li>
21
19
  * <p>Checks for correct syntax in a policy.</p>
@@ -24,24 +22,6 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
24
22
  * <p>Verifies the policy does not lock out a caller.</p>
25
23
  * </li>
26
24
  * </ul>
27
- *
28
- *
29
- * <p>
30
- * <b>Minimum Permissions</b>
31
- * </p>
32
- * <p>You must have the permissions required to access the following APIs:</p>
33
- * <ul>
34
- * <li>
35
- * <p>
36
- * <code>secretsmanager:PutResourcePolicy</code>
37
- * </p>
38
- * </li>
39
- * <li>
40
- * <p>
41
- * <code>secretsmanager:ValidateResourcePolicy</code>
42
- * </p>
43
- * </li>
44
- * </ul>
45
25
  * @example
46
26
  * Use a bare-bones client and the command you need to make an API call.
47
27
  * ```javascript
@@ -54,7 +34,7 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
54
34
  *
55
35
  * @see {@link ValidateResourcePolicyCommandInput} for command's `input` shape.
56
36
  * @see {@link ValidateResourcePolicyCommandOutput} for command's `response` shape.
57
- * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
37
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
58
38
  *
59
39
  */
60
40
  export declare class ValidateResourcePolicyCommand extends $Command<ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {