@depup/aws-sdk__client-secrets-manager 3.1010.0-depup.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 (159) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +39 -0
  3. package/changes.json +42 -0
  4. package/dist-cjs/auth/httpAuthSchemeProvider.js +46 -0
  5. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  6. package/dist-cjs/endpoint/ruleset.js +7 -0
  7. package/dist-cjs/index.js +511 -0
  8. package/dist-cjs/models/SecretsManagerServiceException.js +12 -0
  9. package/dist-cjs/models/errors.js +184 -0
  10. package/dist-cjs/runtimeConfig.browser.js +38 -0
  11. package/dist-cjs/runtimeConfig.js +53 -0
  12. package/dist-cjs/runtimeConfig.native.js +15 -0
  13. package/dist-cjs/runtimeConfig.shared.js +43 -0
  14. package/dist-cjs/schemas/schemas_0.js +665 -0
  15. package/dist-es/SecretsManager.js +61 -0
  16. package/dist-es/SecretsManagerClient.js +50 -0
  17. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  18. package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
  19. package/dist-es/commands/BatchGetSecretValueCommand.js +16 -0
  20. package/dist-es/commands/CancelRotateSecretCommand.js +16 -0
  21. package/dist-es/commands/CreateSecretCommand.js +16 -0
  22. package/dist-es/commands/DeleteResourcePolicyCommand.js +16 -0
  23. package/dist-es/commands/DeleteSecretCommand.js +16 -0
  24. package/dist-es/commands/DescribeSecretCommand.js +16 -0
  25. package/dist-es/commands/GetRandomPasswordCommand.js +16 -0
  26. package/dist-es/commands/GetResourcePolicyCommand.js +16 -0
  27. package/dist-es/commands/GetSecretValueCommand.js +16 -0
  28. package/dist-es/commands/ListSecretVersionIdsCommand.js +16 -0
  29. package/dist-es/commands/ListSecretsCommand.js +16 -0
  30. package/dist-es/commands/PutResourcePolicyCommand.js +16 -0
  31. package/dist-es/commands/PutSecretValueCommand.js +16 -0
  32. package/dist-es/commands/RemoveRegionsFromReplicationCommand.js +16 -0
  33. package/dist-es/commands/ReplicateSecretToRegionsCommand.js +16 -0
  34. package/dist-es/commands/RestoreSecretCommand.js +16 -0
  35. package/dist-es/commands/RotateSecretCommand.js +16 -0
  36. package/dist-es/commands/StopReplicationToReplicaCommand.js +16 -0
  37. package/dist-es/commands/TagResourceCommand.js +16 -0
  38. package/dist-es/commands/UntagResourceCommand.js +16 -0
  39. package/dist-es/commands/UpdateSecretCommand.js +16 -0
  40. package/dist-es/commands/UpdateSecretVersionStageCommand.js +16 -0
  41. package/dist-es/commands/ValidateResourcePolicyCommand.js +16 -0
  42. package/dist-es/commands/index.js +23 -0
  43. package/dist-es/endpoint/EndpointParameters.js +13 -0
  44. package/dist-es/endpoint/endpointResolver.js +14 -0
  45. package/dist-es/endpoint/ruleset.js +4 -0
  46. package/dist-es/extensionConfiguration.js +1 -0
  47. package/dist-es/index.js +9 -0
  48. package/dist-es/models/SecretsManagerServiceException.js +8 -0
  49. package/dist-es/models/enums.js +24 -0
  50. package/dist-es/models/errors.js +169 -0
  51. package/dist-es/models/models_0.js +1 -0
  52. package/dist-es/pagination/BatchGetSecretValuePaginator.js +4 -0
  53. package/dist-es/pagination/Interfaces.js +1 -0
  54. package/dist-es/pagination/ListSecretVersionIdsPaginator.js +4 -0
  55. package/dist-es/pagination/ListSecretsPaginator.js +4 -0
  56. package/dist-es/pagination/index.js +4 -0
  57. package/dist-es/runtimeConfig.browser.js +33 -0
  58. package/dist-es/runtimeConfig.js +48 -0
  59. package/dist-es/runtimeConfig.native.js +11 -0
  60. package/dist-es/runtimeConfig.shared.js +39 -0
  61. package/dist-es/runtimeExtensions.js +9 -0
  62. package/dist-es/schemas/schemas_0.js +661 -0
  63. package/dist-types/SecretsManager.d.ts +220 -0
  64. package/dist-types/SecretsManagerClient.d.ts +235 -0
  65. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  66. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  67. package/dist-types/commands/BatchGetSecretValueCommand.d.ts +210 -0
  68. package/dist-types/commands/CancelRotateSecretCommand.d.ts +135 -0
  69. package/dist-types/commands/CreateSecretCommand.d.ts +218 -0
  70. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +126 -0
  71. package/dist-types/commands/DeleteSecretCommand.d.ts +135 -0
  72. package/dist-types/commands/DescribeSecretCommand.d.ts +137 -0
  73. package/dist-types/commands/GetRandomPasswordCommand.d.ts +135 -0
  74. package/dist-types/commands/GetResourcePolicyCommand.d.ts +138 -0
  75. package/dist-types/commands/GetSecretValueCommand.d.ts +157 -0
  76. package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +151 -0
  77. package/dist-types/commands/ListSecretsCommand.d.ts +208 -0
  78. package/dist-types/commands/PutResourcePolicyCommand.d.ts +147 -0
  79. package/dist-types/commands/PutSecretValueCommand.d.ts +183 -0
  80. package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +122 -0
  81. package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +157 -0
  82. package/dist-types/commands/RestoreSecretCommand.d.ts +126 -0
  83. package/dist-types/commands/RotateSecretCommand.d.ts +180 -0
  84. package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +111 -0
  85. package/dist-types/commands/TagResourceCommand.d.ts +145 -0
  86. package/dist-types/commands/UntagResourceCommand.d.ts +134 -0
  87. package/dist-types/commands/UpdateSecretCommand.d.ts +221 -0
  88. package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +187 -0
  89. package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +161 -0
  90. package/dist-types/commands/index.d.ts +23 -0
  91. package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
  92. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  93. package/dist-types/endpoint/ruleset.d.ts +2 -0
  94. package/dist-types/extensionConfiguration.d.ts +9 -0
  95. package/dist-types/index.d.ts +42 -0
  96. package/dist-types/models/SecretsManagerServiceException.d.ts +14 -0
  97. package/dist-types/models/enums.d.ts +56 -0
  98. package/dist-types/models/errors.d.ts +175 -0
  99. package/dist-types/models/models_0.d.ts +1957 -0
  100. package/dist-types/pagination/BatchGetSecretValuePaginator.d.ts +7 -0
  101. package/dist-types/pagination/Interfaces.d.ts +8 -0
  102. package/dist-types/pagination/ListSecretVersionIdsPaginator.d.ts +7 -0
  103. package/dist-types/pagination/ListSecretsPaginator.d.ts +7 -0
  104. package/dist-types/pagination/index.d.ts +4 -0
  105. package/dist-types/runtimeConfig.browser.d.ts +55 -0
  106. package/dist-types/runtimeConfig.d.ts +55 -0
  107. package/dist-types/runtimeConfig.native.d.ts +54 -0
  108. package/dist-types/runtimeConfig.shared.d.ts +27 -0
  109. package/dist-types/runtimeExtensions.d.ts +17 -0
  110. package/dist-types/schemas/schemas_0.d.ts +99 -0
  111. package/dist-types/ts3.4/SecretsManager.d.ts +426 -0
  112. package/dist-types/ts3.4/SecretsManagerClient.d.ts +258 -0
  113. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  114. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
  115. package/dist-types/ts3.4/commands/BatchGetSecretValueCommand.d.ts +51 -0
  116. package/dist-types/ts3.4/commands/CancelRotateSecretCommand.d.ts +51 -0
  117. package/dist-types/ts3.4/commands/CreateSecretCommand.d.ts +47 -0
  118. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +51 -0
  119. package/dist-types/ts3.4/commands/DeleteSecretCommand.d.ts +47 -0
  120. package/dist-types/ts3.4/commands/DescribeSecretCommand.d.ts +50 -0
  121. package/dist-types/ts3.4/commands/GetRandomPasswordCommand.d.ts +51 -0
  122. package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +51 -0
  123. package/dist-types/ts3.4/commands/GetSecretValueCommand.d.ts +50 -0
  124. package/dist-types/ts3.4/commands/ListSecretVersionIdsCommand.d.ts +51 -0
  125. package/dist-types/ts3.4/commands/ListSecretsCommand.d.ts +47 -0
  126. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +51 -0
  127. package/dist-types/ts3.4/commands/PutSecretValueCommand.d.ts +50 -0
  128. package/dist-types/ts3.4/commands/RemoveRegionsFromReplicationCommand.d.ts +51 -0
  129. package/dist-types/ts3.4/commands/ReplicateSecretToRegionsCommand.d.ts +51 -0
  130. package/dist-types/ts3.4/commands/RestoreSecretCommand.d.ts +50 -0
  131. package/dist-types/ts3.4/commands/RotateSecretCommand.d.ts +47 -0
  132. package/dist-types/ts3.4/commands/StopReplicationToReplicaCommand.d.ts +51 -0
  133. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
  134. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
  135. package/dist-types/ts3.4/commands/UpdateSecretCommand.d.ts +47 -0
  136. package/dist-types/ts3.4/commands/UpdateSecretVersionStageCommand.d.ts +51 -0
  137. package/dist-types/ts3.4/commands/ValidateResourcePolicyCommand.d.ts +51 -0
  138. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  139. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  140. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  141. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  142. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  143. package/dist-types/ts3.4/index.d.ts +12 -0
  144. package/dist-types/ts3.4/models/SecretsManagerServiceException.d.ts +9 -0
  145. package/dist-types/ts3.4/models/enums.d.ts +29 -0
  146. package/dist-types/ts3.4/models/errors.d.ts +97 -0
  147. package/dist-types/ts3.4/models/models_0.d.ts +333 -0
  148. package/dist-types/ts3.4/pagination/BatchGetSecretValuePaginator.d.ts +11 -0
  149. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  150. package/dist-types/ts3.4/pagination/ListSecretVersionIdsPaginator.d.ts +11 -0
  151. package/dist-types/ts3.4/pagination/ListSecretsPaginator.d.ts +11 -0
  152. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  153. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +100 -0
  154. package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
  155. package/dist-types/ts3.4/runtimeConfig.native.d.ts +104 -0
  156. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
  157. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  158. package/dist-types/ts3.4/schemas/schemas_0.d.ts +98 -0
  159. package/package.json +159 -0
@@ -0,0 +1,126 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { RestoreSecretRequest, RestoreSecretResponse } from "../models/models_0";
4
+ import type { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link RestoreSecretCommand}.
14
+ */
15
+ export interface RestoreSecretCommandInput extends RestoreSecretRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link RestoreSecretCommand}.
21
+ */
22
+ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __MetadataBearer {
23
+ }
24
+ declare const RestoreSecretCommand_base: {
25
+ new (input: RestoreSecretCommandInput): import("@smithy/smithy-client").CommandImpl<RestoreSecretCommandInput, RestoreSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: RestoreSecretCommandInput): import("@smithy/smithy-client").CommandImpl<RestoreSecretCommandInput, RestoreSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
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
+ * <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
+ * <p>
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
+ * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
38
+ * and access control in Secrets Manager</a>. </p>
39
+ * @example
40
+ * Use a bare-bones client and the command you need to make an API call.
41
+ * ```javascript
42
+ * import { SecretsManagerClient, RestoreSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
43
+ * // const { SecretsManagerClient, RestoreSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
44
+ * // import type { SecretsManagerClientConfig } from "@aws-sdk/client-secrets-manager";
45
+ * const config = {}; // type is SecretsManagerClientConfig
46
+ * const client = new SecretsManagerClient(config);
47
+ * const input = { // RestoreSecretRequest
48
+ * SecretId: "STRING_VALUE", // required
49
+ * };
50
+ * const command = new RestoreSecretCommand(input);
51
+ * const response = await client.send(command);
52
+ * // { // RestoreSecretResponse
53
+ * // ARN: "STRING_VALUE",
54
+ * // Name: "STRING_VALUE",
55
+ * // };
56
+ *
57
+ * ```
58
+ *
59
+ * @param RestoreSecretCommandInput - {@link RestoreSecretCommandInput}
60
+ * @returns {@link RestoreSecretCommandOutput}
61
+ * @see {@link RestoreSecretCommandInput} for command's `input` shape.
62
+ * @see {@link RestoreSecretCommandOutput} for command's `response` shape.
63
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
64
+ *
65
+ * @throws {@link InternalServiceError} (server fault)
66
+ * <p>An error occurred on the server side.</p>
67
+ *
68
+ * @throws {@link InvalidParameterException} (client fault)
69
+ * <p>The parameter name or value is invalid.</p>
70
+ *
71
+ * @throws {@link InvalidRequestException} (client fault)
72
+ * <p>A parameter value is not valid for the current state of the
73
+ * resource.</p>
74
+ * <p>Possible causes:</p>
75
+ * <ul>
76
+ * <li>
77
+ * <p>The secret is scheduled for deletion.</p>
78
+ * </li>
79
+ * <li>
80
+ * <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
81
+ * ARN configured and you didn't include such an ARN as a parameter in this call. </p>
82
+ * </li>
83
+ * <li>
84
+ * <p>The secret is managed by another service, and you must use that service to update it.
85
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
86
+ * </li>
87
+ * </ul>
88
+ *
89
+ * @throws {@link ResourceNotFoundException} (client fault)
90
+ * <p>Secrets Manager can't find the resource that you asked for.</p>
91
+ *
92
+ * @throws {@link SecretsManagerServiceException}
93
+ * <p>Base exception class for all service exceptions from SecretsManager service.</p>
94
+ *
95
+ *
96
+ * @example To restore a previously deleted secret
97
+ * ```javascript
98
+ * // The following example shows how to restore a secret that you previously scheduled for deletion.
99
+ * const input = {
100
+ * SecretId: "MyTestDatabaseSecret"
101
+ * };
102
+ * const command = new RestoreSecretCommand(input);
103
+ * const response = await client.send(command);
104
+ * /* response is
105
+ * {
106
+ * ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
107
+ * Name: "MyTestDatabaseSecret"
108
+ * }
109
+ * *\/
110
+ * ```
111
+ *
112
+ * @public
113
+ */
114
+ export declare class RestoreSecretCommand extends RestoreSecretCommand_base {
115
+ /** @internal type navigation helper, not in runtime. */
116
+ protected static __types: {
117
+ api: {
118
+ input: RestoreSecretRequest;
119
+ output: RestoreSecretResponse;
120
+ };
121
+ sdk: {
122
+ input: RestoreSecretCommandInput;
123
+ output: RestoreSecretCommandOutput;
124
+ };
125
+ };
126
+ }
@@ -0,0 +1,180 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { RotateSecretRequest, RotateSecretResponse } from "../models/models_0";
4
+ import type { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link RotateSecretCommand}.
14
+ */
15
+ export interface RotateSecretCommandInput extends RotateSecretRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link RotateSecretCommand}.
21
+ */
22
+ export interface RotateSecretCommandOutput extends RotateSecretResponse, __MetadataBearer {
23
+ }
24
+ declare const RotateSecretCommand_base: {
25
+ new (input: RotateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<RotateSecretCommandInput, RotateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: RotateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<RotateSecretCommandInput, RotateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
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>
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>
46
+ * <p>
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">
50
+ * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
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>
54
+ * @example
55
+ * Use a bare-bones client and the command you need to make an API call.
56
+ * ```javascript
57
+ * import { SecretsManagerClient, RotateSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
58
+ * // const { SecretsManagerClient, RotateSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
59
+ * // import type { SecretsManagerClientConfig } from "@aws-sdk/client-secrets-manager";
60
+ * const config = {}; // type is SecretsManagerClientConfig
61
+ * const client = new SecretsManagerClient(config);
62
+ * const input = { // RotateSecretRequest
63
+ * SecretId: "STRING_VALUE", // required
64
+ * ClientRequestToken: "STRING_VALUE",
65
+ * RotationLambdaARN: "STRING_VALUE",
66
+ * RotationRules: { // RotationRulesType
67
+ * AutomaticallyAfterDays: Number("long"),
68
+ * Duration: "STRING_VALUE",
69
+ * ScheduleExpression: "STRING_VALUE",
70
+ * },
71
+ * ExternalSecretRotationMetadata: [ // ExternalSecretRotationMetadataType
72
+ * { // ExternalSecretRotationMetadataItem
73
+ * Key: "STRING_VALUE",
74
+ * Value: "STRING_VALUE",
75
+ * },
76
+ * ],
77
+ * ExternalSecretRotationRoleArn: "STRING_VALUE",
78
+ * RotateImmediately: true || false,
79
+ * };
80
+ * const command = new RotateSecretCommand(input);
81
+ * const response = await client.send(command);
82
+ * // { // RotateSecretResponse
83
+ * // ARN: "STRING_VALUE",
84
+ * // Name: "STRING_VALUE",
85
+ * // VersionId: "STRING_VALUE",
86
+ * // };
87
+ *
88
+ * ```
89
+ *
90
+ * @param RotateSecretCommandInput - {@link RotateSecretCommandInput}
91
+ * @returns {@link RotateSecretCommandOutput}
92
+ * @see {@link RotateSecretCommandInput} for command's `input` shape.
93
+ * @see {@link RotateSecretCommandOutput} for command's `response` shape.
94
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
95
+ *
96
+ * @throws {@link InternalServiceError} (server fault)
97
+ * <p>An error occurred on the server side.</p>
98
+ *
99
+ * @throws {@link InvalidParameterException} (client fault)
100
+ * <p>The parameter name or value is invalid.</p>
101
+ *
102
+ * @throws {@link InvalidRequestException} (client fault)
103
+ * <p>A parameter value is not valid for the current state of the
104
+ * resource.</p>
105
+ * <p>Possible causes:</p>
106
+ * <ul>
107
+ * <li>
108
+ * <p>The secret is scheduled for deletion.</p>
109
+ * </li>
110
+ * <li>
111
+ * <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
112
+ * ARN configured and you didn't include such an ARN as a parameter in this call. </p>
113
+ * </li>
114
+ * <li>
115
+ * <p>The secret is managed by another service, and you must use that service to update it.
116
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
117
+ * </li>
118
+ * </ul>
119
+ *
120
+ * @throws {@link ResourceNotFoundException} (client fault)
121
+ * <p>Secrets Manager can't find the resource that you asked for.</p>
122
+ *
123
+ * @throws {@link SecretsManagerServiceException}
124
+ * <p>Base exception class for all service exceptions from SecretsManager service.</p>
125
+ *
126
+ *
127
+ * @example To configure rotation for a secret
128
+ * ```javascript
129
+ * // The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.
130
+ * const input = {
131
+ * RotationLambdaARN: "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda",
132
+ * RotationRules: {
133
+ * Duration: "2h",
134
+ * ScheduleExpression: "cron(0 16 1,15 * ? *)"
135
+ * },
136
+ * SecretId: "MyTestDatabaseSecret"
137
+ * };
138
+ * const command = new RotateSecretCommand(input);
139
+ * const response = await client.send(command);
140
+ * /* response is
141
+ * {
142
+ * ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
143
+ * Name: "MyTestDatabaseSecret",
144
+ * VersionId: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
145
+ * }
146
+ * *\/
147
+ * ```
148
+ *
149
+ * @example To request an immediate rotation for a secret
150
+ * ```javascript
151
+ * // The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.
152
+ * const input = {
153
+ * SecretId: "MyTestDatabaseSecret"
154
+ * };
155
+ * const command = new RotateSecretCommand(input);
156
+ * const response = await client.send(command);
157
+ * /* response is
158
+ * {
159
+ * ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
160
+ * Name: "MyTestDatabaseSecret",
161
+ * VersionId: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
162
+ * }
163
+ * *\/
164
+ * ```
165
+ *
166
+ * @public
167
+ */
168
+ export declare class RotateSecretCommand extends RotateSecretCommand_base {
169
+ /** @internal type navigation helper, not in runtime. */
170
+ protected static __types: {
171
+ api: {
172
+ input: RotateSecretRequest;
173
+ output: RotateSecretResponse;
174
+ };
175
+ sdk: {
176
+ input: RotateSecretCommandInput;
177
+ output: RotateSecretCommandOutput;
178
+ };
179
+ };
180
+ }
@@ -0,0 +1,111 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { StopReplicationToReplicaRequest, StopReplicationToReplicaResponse } from "../models/models_0";
4
+ import type { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StopReplicationToReplicaCommand}.
14
+ */
15
+ export interface StopReplicationToReplicaCommandInput extends StopReplicationToReplicaRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StopReplicationToReplicaCommand}.
21
+ */
22
+ export interface StopReplicationToReplicaCommandOutput extends StopReplicationToReplicaResponse, __MetadataBearer {
23
+ }
24
+ declare const StopReplicationToReplicaCommand_base: {
25
+ new (input: StopReplicationToReplicaCommandInput): import("@smithy/smithy-client").CommandImpl<StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StopReplicationToReplicaCommandInput): import("@smithy/smithy-client").CommandImpl<StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
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>
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
+ * <p>
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">
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
+ * and access control in Secrets Manager</a>. </p>
41
+ * @example
42
+ * Use a bare-bones client and the command you need to make an API call.
43
+ * ```javascript
44
+ * import { SecretsManagerClient, StopReplicationToReplicaCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
45
+ * // const { SecretsManagerClient, StopReplicationToReplicaCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
46
+ * // import type { SecretsManagerClientConfig } from "@aws-sdk/client-secrets-manager";
47
+ * const config = {}; // type is SecretsManagerClientConfig
48
+ * const client = new SecretsManagerClient(config);
49
+ * const input = { // StopReplicationToReplicaRequest
50
+ * SecretId: "STRING_VALUE", // required
51
+ * };
52
+ * const command = new StopReplicationToReplicaCommand(input);
53
+ * const response = await client.send(command);
54
+ * // { // StopReplicationToReplicaResponse
55
+ * // ARN: "STRING_VALUE",
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param StopReplicationToReplicaCommandInput - {@link StopReplicationToReplicaCommandInput}
61
+ * @returns {@link StopReplicationToReplicaCommandOutput}
62
+ * @see {@link StopReplicationToReplicaCommandInput} for command's `input` shape.
63
+ * @see {@link StopReplicationToReplicaCommandOutput} for command's `response` shape.
64
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
65
+ *
66
+ * @throws {@link InternalServiceError} (server fault)
67
+ * <p>An error occurred on the server side.</p>
68
+ *
69
+ * @throws {@link InvalidParameterException} (client fault)
70
+ * <p>The parameter name or value is invalid.</p>
71
+ *
72
+ * @throws {@link InvalidRequestException} (client fault)
73
+ * <p>A parameter value is not valid for the current state of the
74
+ * resource.</p>
75
+ * <p>Possible causes:</p>
76
+ * <ul>
77
+ * <li>
78
+ * <p>The secret is scheduled for deletion.</p>
79
+ * </li>
80
+ * <li>
81
+ * <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
82
+ * ARN configured and you didn't include such an ARN as a parameter in this call. </p>
83
+ * </li>
84
+ * <li>
85
+ * <p>The secret is managed by another service, and you must use that service to update it.
86
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
87
+ * </li>
88
+ * </ul>
89
+ *
90
+ * @throws {@link ResourceNotFoundException} (client fault)
91
+ * <p>Secrets Manager can't find the resource that you asked for.</p>
92
+ *
93
+ * @throws {@link SecretsManagerServiceException}
94
+ * <p>Base exception class for all service exceptions from SecretsManager service.</p>
95
+ *
96
+ *
97
+ * @public
98
+ */
99
+ export declare class StopReplicationToReplicaCommand extends StopReplicationToReplicaCommand_base {
100
+ /** @internal type navigation helper, not in runtime. */
101
+ protected static __types: {
102
+ api: {
103
+ input: StopReplicationToReplicaRequest;
104
+ output: StopReplicationToReplicaResponse;
105
+ };
106
+ sdk: {
107
+ input: StopReplicationToReplicaCommandInput;
108
+ output: StopReplicationToReplicaCommandOutput;
109
+ };
110
+ };
111
+ }
@@ -0,0 +1,145 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { TagResourceRequest } from "../models/models_0";
4
+ import type { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link TagResourceCommand}.
14
+ */
15
+ export interface TagResourceCommandInput extends TagResourceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link TagResourceCommand}.
21
+ */
22
+ export interface TagResourceCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const TagResourceCommand_base: {
25
+ new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
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>
35
+ * <important>
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>
40
+ * </important>
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>
42
+ * <p>
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">
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
+ * and access control in Secrets Manager</a>. </p>
48
+ * @example
49
+ * Use a bare-bones client and the command you need to make an API call.
50
+ * ```javascript
51
+ * import { SecretsManagerClient, TagResourceCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
52
+ * // const { SecretsManagerClient, TagResourceCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
53
+ * // import type { SecretsManagerClientConfig } from "@aws-sdk/client-secrets-manager";
54
+ * const config = {}; // type is SecretsManagerClientConfig
55
+ * const client = new SecretsManagerClient(config);
56
+ * const input = { // TagResourceRequest
57
+ * SecretId: "STRING_VALUE", // required
58
+ * Tags: [ // TagListType // required
59
+ * { // Tag
60
+ * Key: "STRING_VALUE",
61
+ * Value: "STRING_VALUE",
62
+ * },
63
+ * ],
64
+ * };
65
+ * const command = new TagResourceCommand(input);
66
+ * const response = await client.send(command);
67
+ * // {};
68
+ *
69
+ * ```
70
+ *
71
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
72
+ * @returns {@link TagResourceCommandOutput}
73
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
74
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
75
+ * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
76
+ *
77
+ * @throws {@link InternalServiceError} (server fault)
78
+ * <p>An error occurred on the server side.</p>
79
+ *
80
+ * @throws {@link InvalidParameterException} (client fault)
81
+ * <p>The parameter name or value is invalid.</p>
82
+ *
83
+ * @throws {@link InvalidRequestException} (client fault)
84
+ * <p>A parameter value is not valid for the current state of the
85
+ * resource.</p>
86
+ * <p>Possible causes:</p>
87
+ * <ul>
88
+ * <li>
89
+ * <p>The secret is scheduled for deletion.</p>
90
+ * </li>
91
+ * <li>
92
+ * <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
93
+ * ARN configured and you didn't include such an ARN as a parameter in this call. </p>
94
+ * </li>
95
+ * <li>
96
+ * <p>The secret is managed by another service, and you must use that service to update it.
97
+ * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
98
+ * </li>
99
+ * </ul>
100
+ *
101
+ * @throws {@link ResourceNotFoundException} (client fault)
102
+ * <p>Secrets Manager can't find the resource that you asked for.</p>
103
+ *
104
+ * @throws {@link SecretsManagerServiceException}
105
+ * <p>Base exception class for all service exceptions from SecretsManager service.</p>
106
+ *
107
+ *
108
+ * @example To add tags to a secret
109
+ * ```javascript
110
+ * // The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.
111
+ * const input = {
112
+ * SecretId: "MyExampleSecret",
113
+ * Tags: [
114
+ * {
115
+ * Key: "FirstTag",
116
+ * Value: "SomeValue"
117
+ * },
118
+ * {
119
+ * Key: "SecondTag",
120
+ * Value: "AnotherValue"
121
+ * }
122
+ * ]
123
+ * };
124
+ * const command = new TagResourceCommand(input);
125
+ * const response = await client.send(command);
126
+ * /* response is
127
+ * { /* metadata only *\/ }
128
+ * *\/
129
+ * ```
130
+ *
131
+ * @public
132
+ */
133
+ export declare class TagResourceCommand extends TagResourceCommand_base {
134
+ /** @internal type navigation helper, not in runtime. */
135
+ protected static __types: {
136
+ api: {
137
+ input: TagResourceRequest;
138
+ output: {};
139
+ };
140
+ sdk: {
141
+ input: TagResourceCommandInput;
142
+ output: TagResourceCommandOutput;
143
+ };
144
+ };
145
+ }