@aws-sdk/client-secrets-manager 3.315.0 → 3.316.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 (9) hide show
  1. package/dist-cjs/SecretsManager.js +26 -308
  2. package/dist-cjs/protocols/Aws_json1_1.js +4 -4
  3. package/dist-es/SecretsManager.js +26 -308
  4. package/dist-es/protocols/Aws_json1_1.js +4 -4
  5. package/dist-types/SecretsManager.d.ts +54 -436
  6. package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +1 -1
  7. package/dist-types/models/models_0.d.ts +8 -8
  8. package/dist-types/ts3.4/SecretsManager.d.ts +4 -1
  9. package/package.json +6 -6
package/dist-types/SecretsManager.d.ts CHANGED
@@ -22,550 +22,168 @@ import { UpdateSecretCommandInput, UpdateSecretCommandOutput } from "./commands/
22
22
  import { UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOutput } from "./commands/UpdateSecretVersionStageCommand";
23
23
  import { ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput } from "./commands/ValidateResourcePolicyCommand";
24
24
  import { SecretsManagerClient } from "./SecretsManagerClient";
25
- /**
26
- * @public
27
- * <fullname>Amazon Web Services Secrets Manager</fullname>
28
- * <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
29
- * <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
30
- * service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html">Amazon Web Services Secrets Manager User Guide</a>.</p>
31
- * <p>
32
- * <b>API Version</b>
33
- * </p>
34
- * <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
35
- * <p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
36
- * endpoints</a>.</p>
37
- * <p>
38
- * <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
39
- * </p>
40
- * <p>We welcome your feedback. Send your comments to <a href="mailto:awssecretsmanager-feedback@amazon.com">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=296">Amazon Web Services Secrets Manager Discussion Forum</a>. For more
41
- * information about the Amazon Web Services Discussion Forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums
42
- * Help</a>.</p>
43
- * <p>
44
- * <b>Logging API Requests</b>
45
- * </p>
46
- * <p>Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services
47
- * account and delivers log files to an Amazon S3 bucket. By using information that's collected
48
- * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the
49
- * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services
50
- * CloudTrail, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
51
- * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.
52
- * 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>
53
- */
54
- export declare class SecretsManager extends SecretsManagerClient {
25
+ export interface SecretsManager {
55
26
  /**
56
- * @public
57
- * <p>Turns off automatic rotation, and if a rotation is currently in
58
- * progress, cancels the rotation.</p>
59
- * <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
60
- * labels in an unexpected state. You might
61
- * need to remove the staging label <code>AWSPENDING</code> from the partially created version.
62
- * You also need to determine whether to roll back to the previous version of the secret
63
- * by moving the staging label <code>AWSCURRENT</code> to the version that has <code>AWSPENDING</code>.
64
- * To determine
65
- * which version has a specific staging label, call <a>ListSecretVersionIds</a>. Then use
66
- * <a>UpdateSecretVersionStage</a> to change staging labels.
67
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
68
- * <p>To turn on automatic rotation again, call <a>RotateSecret</a>.</p>
69
- * <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>
70
- * <p>
71
- * <b>Required permissions: </b>
72
- * <code>secretsmanager:CancelRotateSecret</code>.
73
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
74
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
75
- * and access control in Secrets Manager</a>. </p>
27
+ * @see {@link CancelRotateSecretCommand}
76
28
  */
77
29
  cancelRotateSecret(args: CancelRotateSecretCommandInput, options?: __HttpHandlerOptions): Promise<CancelRotateSecretCommandOutput>;
78
30
  cancelRotateSecret(args: CancelRotateSecretCommandInput, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void): void;
79
31
  cancelRotateSecret(args: CancelRotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void): void;
80
32
  /**
81
- * @public
82
- * <p>Creates a new secret. A <i>secret</i> can be a password, a set of
83
- * credentials such as a user name and password, an OAuth token, or other secret information
84
- * that you store in an encrypted form in Secrets Manager. The secret also
85
- * includes the connection information to access a database or other service, which Secrets Manager
86
- * doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
87
- * important information needed to manage the secret.</p>
88
- * <p>For secrets that use <i>managed rotation</i>, you need to create the secret through the managing service. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.
89
- *
90
- * </p>
91
- * <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>
92
- * <p>To create a secret, you can provide the secret value to be encrypted in either the
93
- * <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both.
94
- * If you include <code>SecretString</code> or <code>SecretBinary</code>
95
- * then Secrets Manager creates an initial secret version and automatically attaches the staging
96
- * label <code>AWSCURRENT</code> to it.</p>
97
- * <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,
98
- * you must make sure the JSON you store in the <code>SecretString</code> matches the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html">JSON structure of
99
- * a database secret</a>.</p>
100
- * <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
101
- * <code>aws/secretsmanager</code>. If this key
102
- * doesn't already exist in your account, then Secrets Manager creates it for you automatically. All
103
- * users and roles in the Amazon Web Services account automatically have access to use <code>aws/secretsmanager</code>.
104
- * Creating <code>aws/secretsmanager</code> can result in a one-time significant delay in returning the
105
- * result.</p>
106
- * <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then
107
- * you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must create
108
- * and use a customer managed KMS key. </p>
109
- * <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except <code>SecretBinary</code> or <code>SecretString</code> 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>
110
- * <p>
111
- * <b>Required permissions: </b>
112
- * <code>secretsmanager:CreateSecret</code>. If you
113
- * include tags in the secret, you also need <code>secretsmanager:TagResource</code>.
114
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
115
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
116
- * and access control in Secrets Manager</a>. </p>
117
- * <p>To encrypt the secret with a KMS key other than <code>aws/secretsmanager</code>, you need <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permission to the key. </p>
33
+ * @see {@link CreateSecretCommand}
118
34
  */
119
35
  createSecret(args: CreateSecretCommandInput, options?: __HttpHandlerOptions): Promise<CreateSecretCommandOutput>;
120
36
  createSecret(args: CreateSecretCommandInput, cb: (err: any, data?: CreateSecretCommandOutput) => void): void;
121
37
  createSecret(args: CreateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecretCommandOutput) => void): void;
122
38
  /**
123
- * @public
124
- * <p>Deletes the resource-based permission policy attached to the secret. To attach a policy to
125
- * a secret, use <a>PutResourcePolicy</a>.</p>
126
- * <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>
127
- * <p>
128
- * <b>Required permissions: </b>
129
- * <code>secretsmanager:DeleteResourcePolicy</code>.
130
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
131
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
132
- * and access control in Secrets Manager</a>. </p>
39
+ * @see {@link DeleteResourcePolicyCommand}
133
40
  */
134
41
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourcePolicyCommandOutput>;
135
42
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
136
43
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
137
44
  /**
138
- * @public
139
- * <p>Deletes a secret and all of its versions. You can specify a recovery
140
- * window during which you can restore the secret. The minimum recovery window is 7 days.
141
- * The default recovery window is 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
142
- * the secret that specifies the end of the recovery window. At the end of the recovery window,
143
- * Secrets Manager deletes the secret permanently.</p>
144
- * <p>You can't delete a primary secret that is replicated to other Regions. You must first delete the
145
- * replicas using <a>RemoveRegionsFromReplication</a>, and then delete the primary secret.
146
- * When you delete a replica, it is deleted immediately.</p>
147
- * <p>You can't directly delete a version of a secret. Instead, you remove all staging labels
148
- * from the version using <a>UpdateSecretVersionStage</a>. This marks the version as deprecated,
149
- * and then Secrets Manager can automatically delete the version in the background.</p>
150
- * <p>To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm
151
- * to alert you to any attempts to access a secret during the recovery window. For more information,
152
- * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html">
153
- * Monitor secrets scheduled for deletion</a>.</p>
154
- * <p>Secrets Manager performs the permanent secret deletion at the end of the waiting period as a
155
- * background task with low priority. There is no guarantee of a specific time after the
156
- * recovery window for the permanent delete to occur.</p>
157
- * <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to
158
- * remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>
159
- * <p>When a secret is scheduled for deletion, you cannot retrieve the secret value.
160
- * You must first cancel the deletion with <a>RestoreSecret</a> and then you can retrieve the secret.</p>
161
- * <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>
162
- * <p>
163
- * <b>Required permissions: </b>
164
- * <code>secretsmanager:DeleteSecret</code>.
165
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
166
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
167
- * and access control in Secrets Manager</a>. </p>
45
+ * @see {@link DeleteSecretCommand}
168
46
  */
169
47
  deleteSecret(args: DeleteSecretCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSecretCommandOutput>;
170
48
  deleteSecret(args: DeleteSecretCommandInput, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void;
171
49
  deleteSecret(args: DeleteSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void;
172
50
  /**
173
- * @public
174
- * <p>Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager
175
- * only returns fields that have a value in the response. </p>
176
- * <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>
177
- * <p>
178
- * <b>Required permissions: </b>
179
- * <code>secretsmanager:DescribeSecret</code>.
180
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
181
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
182
- * and access control in Secrets Manager</a>. </p>
51
+ * @see {@link DescribeSecretCommand}
183
52
  */
184
53
  describeSecret(args: DescribeSecretCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSecretCommandOutput>;
185
54
  describeSecret(args: DescribeSecretCommandInput, cb: (err: any, data?: DescribeSecretCommandOutput) => void): void;
186
55
  describeSecret(args: DescribeSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecretCommandOutput) => void): void;
187
56
  /**
188
- * @public
189
- * <p>Generates a random password. We recommend that you specify the
190
- * maximum length and include every character type that the system you are generating a password
191
- * for can support.</p>
192
- * <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>
193
- * <p>
194
- * <b>Required permissions: </b>
195
- * <code>secretsmanager:GetRandomPassword</code>.
196
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
197
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
198
- * and access control in Secrets Manager</a>. </p>
57
+ * @see {@link GetRandomPasswordCommand}
199
58
  */
200
59
  getRandomPassword(args: GetRandomPasswordCommandInput, options?: __HttpHandlerOptions): Promise<GetRandomPasswordCommandOutput>;
201
60
  getRandomPassword(args: GetRandomPasswordCommandInput, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void): void;
202
61
  getRandomPassword(args: GetRandomPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void): void;
203
62
  /**
204
- * @public
205
- * <p>Retrieves the JSON text of the resource-based policy document attached to the
206
- * secret. For more information about permissions policies attached to a secret, see
207
- * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
208
- * policies attached to a secret</a>.</p>
209
- * <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>
210
- * <p>
211
- * <b>Required permissions: </b>
212
- * <code>secretsmanager:GetResourcePolicy</code>.
213
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
214
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
215
- * and access control in Secrets Manager</a>. </p>
63
+ * @see {@link GetResourcePolicyCommand}
216
64
  */
217
65
  getResourcePolicy(args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcePolicyCommandOutput>;
218
66
  getResourcePolicy(args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
219
67
  getResourcePolicy(args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
220
68
  /**
221
- * @public
222
- * <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
223
- * <code>SecretBinary</code> from the specified version of a secret, whichever contains
224
- * content.</p>
225
- * <p>We recommend that you cache your secret values by using client-side caching.
226
- * Caching secrets improves speed and reduces your costs. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html">Cache secrets for
227
- * your applications</a>.</p>
228
- * <p>To retrieve the previous version of a secret, use <code>VersionStage</code> and specify
229
- * AWSPREVIOUS. To revert to the previous version of a secret, call <a href="https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html">UpdateSecretVersionStage</a>.</p>
230
- * <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>
231
- * <p>
232
- * <b>Required permissions: </b>
233
- * <code>secretsmanager:GetSecretValue</code>.
234
- * If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key
235
- * <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code> permissions for that key.
236
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
237
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
238
- * and access control in Secrets Manager</a>. </p>
69
+ * @see {@link GetSecretValueCommand}
239
70
  */
240
71
  getSecretValue(args: GetSecretValueCommandInput, options?: __HttpHandlerOptions): Promise<GetSecretValueCommandOutput>;
241
72
  getSecretValue(args: GetSecretValueCommandInput, cb: (err: any, data?: GetSecretValueCommandOutput) => void): void;
242
73
  getSecretValue(args: GetSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecretValueCommandOutput) => void): void;
243
74
  /**
244
- * @public
245
- * <p>Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets
246
- * that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.</p>
247
- * <p>ListSecrets is eventually consistent, however it might not reflect changes from the last five minutes.
248
- * To get the latest information for a specific secret, use <a>DescribeSecret</a>.</p>
249
- * <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p>
250
- * <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>,
251
- * call <a>GetSecretValue</a>.</p>
252
- * <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 Secrets Manager</a>.</p>
253
- * <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>
254
- * <p>
255
- * <b>Required permissions: </b>
256
- * <code>secretsmanager:ListSecrets</code>.
257
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
258
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
259
- * and access control in Secrets Manager</a>. </p>
75
+ * @see {@link ListSecretsCommand}
260
76
  */
261
77
  listSecrets(args: ListSecretsCommandInput, options?: __HttpHandlerOptions): Promise<ListSecretsCommandOutput>;
262
78
  listSecrets(args: ListSecretsCommandInput, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
263
79
  listSecrets(args: ListSecretsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
264
80
  /**
265
- * @public
266
- * <p>Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions
267
- * of a secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">
268
- * Secrets Manager concepts: Versions</a>.</p>
269
- * <p>To list the secrets in the account, use <a>ListSecrets</a>.</p>
270
- * <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>
271
- * <p>
272
- * <b>Required permissions: </b>
273
- * <code>secretsmanager:ListSecretVersionIds</code>.
274
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
275
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
276
- * and access control in Secrets Manager</a>. </p>
81
+ * @see {@link ListSecretVersionIdsCommand}
277
82
  */
278
83
  listSecretVersionIds(args: ListSecretVersionIdsCommandInput, options?: __HttpHandlerOptions): Promise<ListSecretVersionIdsCommandOutput>;
279
84
  listSecretVersionIds(args: ListSecretVersionIdsCommandInput, cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void): void;
280
85
  listSecretVersionIds(args: ListSecretVersionIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void): void;
281
86
  /**
282
- * @public
283
- * <p>Attaches a resource-based permission policy to a secret. A resource-based policy is
284
- * 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>
285
- * </p>
286
- * <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
287
- * permissions policy to a secret</a>.</p>
288
- * <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>
289
- * <p>
290
- * <b>Required permissions: </b>
291
- * <code>secretsmanager:PutResourcePolicy</code>.
292
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
293
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
294
- * and access control in Secrets Manager</a>. </p>
87
+ * @see {@link PutResourcePolicyCommand}
295
88
  */
296
89
  putResourcePolicy(args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutResourcePolicyCommandOutput>;
297
90
  putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
298
91
  putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
299
92
  /**
300
- * @public
301
- * <p>Creates a new version with a new encrypted secret value and attaches it to the secret. The
302
- * version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. </p>
303
- * <p>We recommend you avoid calling <code>PutSecretValue</code> at a sustained rate of more than
304
- * once every 10 minutes. When you update the secret value, Secrets Manager creates a new version
305
- * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
306
- * remove versions created less than 24 hours ago. If you call <code>PutSecretValue</code> more
307
- * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
308
- * the quota for secret versions.</p>
309
- * <p>You can specify the staging labels to attach to the new version in <code>VersionStages</code>.
310
- * If you don't include <code>VersionStages</code>, then Secrets Manager automatically
311
- * moves the staging label <code>AWSCURRENT</code> to this version. If this operation creates
312
- * the first version for the secret, then Secrets Manager
313
- * automatically attaches the staging label <code>AWSCURRENT</code> to it.
314
- * If this operation moves the staging label <code>AWSCURRENT</code> from another version to this
315
- * version, then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to
316
- * the version that <code>AWSCURRENT</code> was removed from.</p>
317
- * <p>This operation is idempotent. If you call this operation with a <code>ClientRequestToken</code>
318
- * that matches an existing version's VersionId, and you specify the
319
- * same secret data, the operation succeeds but does nothing. However, if the secret data is
320
- * different, then the operation fails because you can't modify an existing version; you can
321
- * only create new ones.</p>
322
- * <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except <code>SecretBinary</code> or <code>SecretString</code> 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>
323
- * <p>
324
- * <b>Required permissions: </b>
325
- * <code>secretsmanager:PutSecretValue</code>.
326
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
327
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
328
- * and access control in Secrets Manager</a>. </p>
93
+ * @see {@link PutSecretValueCommand}
329
94
  */
330
95
  putSecretValue(args: PutSecretValueCommandInput, options?: __HttpHandlerOptions): Promise<PutSecretValueCommandOutput>;
331
96
  putSecretValue(args: PutSecretValueCommandInput, cb: (err: any, data?: PutSecretValueCommandOutput) => void): void;
332
97
  putSecretValue(args: PutSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSecretValueCommandOutput) => void): void;
333
98
  /**
334
- * @public
335
- * <p>For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.</p>
336
- * <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>
337
- * <p>
338
- * <b>Required permissions: </b>
339
- * <code>secretsmanager:RemoveRegionsFromReplication</code>.
340
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
341
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
342
- * and access control in Secrets Manager</a>. </p>
99
+ * @see {@link RemoveRegionsFromReplicationCommand}
343
100
  */
344
101
  removeRegionsFromReplication(args: RemoveRegionsFromReplicationCommandInput, options?: __HttpHandlerOptions): Promise<RemoveRegionsFromReplicationCommandOutput>;
345
102
  removeRegionsFromReplication(args: RemoveRegionsFromReplicationCommandInput, cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void): void;
346
103
  removeRegionsFromReplication(args: RemoveRegionsFromReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void): void;
347
104
  /**
348
- * @public
349
- * <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>
350
- * <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>
351
- * <p>
352
- * <b>Required permissions: </b>
353
- * <code>secretsmanager:ReplicateSecretToRegions</code>.
354
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
355
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
356
- * and access control in Secrets Manager</a>. </p>
105
+ * @see {@link ReplicateSecretToRegionsCommand}
357
106
  */
358
107
  replicateSecretToRegions(args: ReplicateSecretToRegionsCommandInput, options?: __HttpHandlerOptions): Promise<ReplicateSecretToRegionsCommandOutput>;
359
108
  replicateSecretToRegions(args: ReplicateSecretToRegionsCommandInput, cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void): void;
360
109
  replicateSecretToRegions(args: ReplicateSecretToRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void): void;
361
110
  /**
362
- * @public
363
- * <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time
364
- * stamp. You can access a secret again after it has been restored.</p>
365
- * <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>
366
- * <p>
367
- * <b>Required permissions: </b>
368
- * <code>secretsmanager:RestoreSecret</code>.
369
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
370
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
371
- * and access control in Secrets Manager</a>. </p>
111
+ * @see {@link RestoreSecretCommand}
372
112
  */
373
113
  restoreSecret(args: RestoreSecretCommandInput, options?: __HttpHandlerOptions): Promise<RestoreSecretCommandOutput>;
374
114
  restoreSecret(args: RestoreSecretCommandInput, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
375
115
  restoreSecret(args: RestoreSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
376
116
  /**
377
- * @public
378
- * <p>Configures and starts the asynchronous process of rotating the secret. For information about rotation,
379
- * see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a> in the <i>Secrets Manager User Guide</i>. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. </p>
380
- * <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
381
- * to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any
382
- * version. If the <code>AWSPENDING</code> staging label is present but not attached to the same
383
- * version as <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code>
384
- * assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
385
- * <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>
386
- * <p>
387
- * <b>Required permissions: </b>
388
- * <code>secretsmanager:RotateSecret</code>.
389
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
390
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
391
- * and access control in Secrets Manager</a>. You also need <code>lambda:InvokeFunction</code> permissions on the rotation function.
392
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html">
393
- * Permissions for rotation</a>.</p>
117
+ * @see {@link RotateSecretCommand}
394
118
  */
395
119
  rotateSecret(args: RotateSecretCommandInput, options?: __HttpHandlerOptions): Promise<RotateSecretCommandOutput>;
396
120
  rotateSecret(args: RotateSecretCommandInput, cb: (err: any, data?: RotateSecretCommandOutput) => void): void;
397
121
  rotateSecret(args: RotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateSecretCommandOutput) => void): void;
398
122
  /**
399
- * @public
400
- * <p>Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.</p>
401
- * <p>You must call this operation from the Region in which you want to promote the replica to a primary secret.</p>
402
- * <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>
403
- * <p>
404
- * <b>Required permissions: </b>
405
- * <code>secretsmanager:StopReplicationToReplica</code>.
406
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
407
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
408
- * and access control in Secrets Manager</a>. </p>
123
+ * @see {@link StopReplicationToReplicaCommand}
409
124
  */
410
125
  stopReplicationToReplica(args: StopReplicationToReplicaCommandInput, options?: __HttpHandlerOptions): Promise<StopReplicationToReplicaCommandOutput>;
411
126
  stopReplicationToReplica(args: StopReplicationToReplicaCommandInput, cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void): void;
412
127
  stopReplicationToReplica(args: StopReplicationToReplicaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void): void;
413
128
  /**
414
- * @public
415
- * <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the
416
- * secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.</p>
417
- * <p>The following restrictions apply to tags:</p>
418
- * <ul>
419
- * <li>
420
- * <p>Maximum number of tags per secret: 50</p>
421
- * </li>
422
- * <li>
423
- * <p>Maximum key length: 127 Unicode characters in UTF-8</p>
424
- * </li>
425
- * <li>
426
- * <p>Maximum value length: 255 Unicode characters in UTF-8</p>
427
- * </li>
428
- * <li>
429
- * <p>Tag keys and values are case sensitive.</p>
430
- * </li>
431
- * <li>
432
- * <p>Do not use the <code>aws:</code> prefix in your tag names or values because Amazon Web Services reserves it
433
- * for Amazon Web Services use. You can't edit or delete tag names or values with this
434
- * prefix. Tags with this prefix do not count against your tags per secret limit.</p>
435
- * </li>
436
- * <li>
437
- * <p>If you use your tagging schema across multiple services and resources,
438
- * other services might have restrictions on allowed characters. Generally
439
- * allowed characters: letters, spaces, and numbers representable in UTF-8, plus the
440
- * following special characters: + - = . _ : / @.</p>
441
- * </li>
442
- * </ul>
443
- * <important>
444
- * <p>If you use tags as part of your security strategy, then adding or removing a tag can
445
- * change permissions. If successfully completing this operation would result in you losing
446
- * your permissions for this secret, then the operation is blocked and returns an Access Denied
447
- * error.</p>
448
- * </important>
449
- * <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>
450
- * <p>
451
- * <b>Required permissions: </b>
452
- * <code>secretsmanager:TagResource</code>.
453
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
454
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
455
- * and access control in Secrets Manager</a>. </p>
129
+ * @see {@link TagResourceCommand}
456
130
  */
457
131
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
458
132
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
459
133
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
460
134
  /**
461
- * @public
462
- * <p>Removes specific tags from a secret.</p>
463
- * <p>This operation is idempotent. If a requested tag is not attached to the secret, no error
464
- * is returned and the secret metadata is unchanged.</p>
465
- * <important>
466
- * <p>If you use tags as part of your security strategy, then removing a tag can change
467
- * permissions. If successfully completing this operation would result in you losing your
468
- * permissions for this secret, then the operation is blocked and returns an Access Denied
469
- * error.</p>
470
- * </important>
471
- * <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>
472
- * <p>
473
- * <b>Required permissions: </b>
474
- * <code>secretsmanager:UntagResource</code>.
475
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
476
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
477
- * and access control in Secrets Manager</a>. </p>
135
+ * @see {@link UntagResourceCommand}
478
136
  */
479
137
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
480
138
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
481
139
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
482
140
  /**
483
- * @public
484
- * <p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>
485
- * <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>
486
- * <p>To change a secret so that it is managed by another service, you need to recreate the secret in that service. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.</p>
487
- * <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than
488
- * once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret value, Secrets Manager creates a new version
489
- * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
490
- * remove versions created less than 24 hours ago. If you update the secret value more
491
- * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
492
- * the quota for secret versions.</p>
493
- * <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new
494
- * secret version, Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to the new
495
- * version. Then it attaches the label <code>AWSPREVIOUS</code>
496
- * to the version that <code>AWSCURRENT</code> was removed from.</p>
497
- * <p>If you call this operation with a <code>ClientRequestToken</code> that matches an existing version's
498
- * <code>VersionId</code>, the operation results in an error. You can't modify an existing
499
- * version, you can only create a new version. To remove a version, remove all staging labels from it. See
500
- * <a>UpdateSecretVersionStage</a>.</p>
501
- * <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except <code>SecretBinary</code> or <code>SecretString</code> 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>
502
- * <p>
503
- * <b>Required permissions: </b>
504
- * <code>secretsmanager:UpdateSecret</code>.
505
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
506
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
507
- * and access control in Secrets Manager</a>.
508
- * If you use a customer managed key, you must also have <code>kms:GenerateDataKey</code> and
509
- * <code>kms:Decrypt</code> permissions on the key. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html">
510
- * Secret encryption and decryption</a>.</p>
141
+ * @see {@link UpdateSecretCommand}
511
142
  */
512
143
  updateSecret(args: UpdateSecretCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSecretCommandOutput>;
513
144
  updateSecret(args: UpdateSecretCommandInput, cb: (err: any, data?: UpdateSecretCommandOutput) => void): void;
514
145
  updateSecret(args: UpdateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecretCommandOutput) => void): void;
515
146
  /**
516
- * @public
517
- * <p>Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to
518
- * track a version as it progresses through the secret rotation process. Each staging label can be
519
- * attached to only one version at a time. To add a staging label to a version when it is already
520
- * attached to another version, Secrets Manager first removes it from the other version first and
521
- * 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>
522
- * <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added
523
- * to the existing list of staging labels for the version. </p>
524
- * <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this
525
- * call.</p>
526
- * <note>
527
- * <p>Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label <code>AWSPREVIOUS</code>
528
- * to the version that <code>AWSCURRENT</code> was removed from.</p>
529
- * </note>
530
- * <p>If this action results in the last label being removed from a version, then the version is
531
- * considered to be 'deprecated' and can be deleted by Secrets Manager.</p>
532
- * <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>
533
- * <p>
534
- * <b>Required permissions: </b>
535
- * <code>secretsmanager:UpdateSecretVersionStage</code>.
536
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
537
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
538
- * and access control in Secrets Manager</a>. </p>
147
+ * @see {@link UpdateSecretVersionStageCommand}
539
148
  */
540
149
  updateSecretVersionStage(args: UpdateSecretVersionStageCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSecretVersionStageCommandOutput>;
541
150
  updateSecretVersionStage(args: UpdateSecretVersionStageCommandInput, cb: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void): void;
542
151
  updateSecretVersionStage(args: UpdateSecretVersionStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void): void;
543
152
  /**
544
- * @public
545
- * <p>Validates that a resource policy does not grant a wide range of principals access to
546
- * your secret. A resource-based policy is optional for secrets.</p>
547
- * <p>The API performs three checks when validating the policy:</p>
548
- * <ul>
549
- * <li>
550
- * <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
551
- * allow broad access to your secret, for example policies that use a wildcard for the principal.</p>
552
- * </li>
553
- * <li>
554
- * <p>Checks for correct syntax in a policy.</p>
555
- * </li>
556
- * <li>
557
- * <p>Verifies the policy does not lock out a caller.</p>
558
- * </li>
559
- * </ul>
560
- * <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>
561
- * <p>
562
- * <b>Required permissions: </b>
563
- * <code>secretsmanager:ValidateResourcePolicy</code>.
564
- * For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
565
- * IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
566
- * and access control in Secrets Manager</a>. </p>
153
+ * @see {@link ValidateResourcePolicyCommand}
567
154
  */
568
155
  validateResourcePolicy(args: ValidateResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<ValidateResourcePolicyCommandOutput>;
569
156
  validateResourcePolicy(args: ValidateResourcePolicyCommandInput, cb: (err: any, data?: ValidateResourcePolicyCommandOutput) => void): void;
570
157
  validateResourcePolicy(args: ValidateResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateResourcePolicyCommandOutput) => void): void;
571
158
  }
159
+ /**
160
+ * @public
161
+ * <fullname>Amazon Web Services Secrets Manager</fullname>
162
+ * <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
163
+ * <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
164
+ * service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html">Amazon Web Services Secrets Manager User Guide</a>.</p>
165
+ * <p>
166
+ * <b>API Version</b>
167
+ * </p>
168
+ * <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
169
+ * <p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
170
+ * endpoints</a>.</p>
171
+ * <p>
172
+ * <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
173
+ * </p>
174
+ * <p>We welcome your feedback. Send your comments to <a href="mailto:awssecretsmanager-feedback@amazon.com">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=296">Amazon Web Services Secrets Manager Discussion Forum</a>. For more
175
+ * information about the Amazon Web Services Discussion Forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums
176
+ * Help</a>.</p>
177
+ * <p>
178
+ * <b>Logging API Requests</b>
179
+ * </p>
180
+ * <p>Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services
181
+ * account and delivers log files to an Amazon S3 bucket. By using information that's collected
182
+ * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the
183
+ * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services
184
+ * CloudTrail, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
185
+ * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.
186
+ * 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>
187
+ */
188
+ export declare class SecretsManager extends SecretsManagerClient implements SecretsManager {
189
+ }