@aws-sdk/client-secrets-manager 3.533.0 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/SecretsManager.d.ts +4 -1
- package/dist-types/SecretsManagerClient.d.ts +1 -1
- package/dist-types/commands/BatchGetSecretValueCommand.d.ts +2 -1
- package/dist-types/commands/CancelRotateSecretCommand.d.ts +2 -1
- package/dist-types/commands/CreateSecretCommand.d.ts +2 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSecretCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSecretCommand.d.ts +2 -1
- package/dist-types/commands/GetRandomPasswordCommand.d.ts +3 -2
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetSecretValueCommand.d.ts +2 -1
- package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +2 -1
- package/dist-types/commands/ListSecretsCommand.d.ts +2 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/PutSecretValueCommand.d.ts +2 -1
- package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +2 -1
- package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +2 -1
- package/dist-types/commands/RestoreSecretCommand.d.ts +2 -1
- package/dist-types/commands/RotateSecretCommand.d.ts +2 -1
- package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSecretCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +2 -1
- package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +221 -220
- package/dist-types/ts3.4/SecretsManager.d.ts +3 -0
- package/dist-types/ts3.4/commands/BatchGetSecretValueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CancelRotateSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRandomPasswordCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSecretValueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecretVersionIdsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecretsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutSecretValueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemoveRegionsFromReplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ReplicateSecretToRegionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RotateSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopReplicationToReplicaCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSecretVersionStageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ValidateResourcePolicyCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -1,39 +1,39 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SecretsManagerServiceException as __BaseException } from "./SecretsManagerServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>A custom type that specifies a <code>Region</code> and the <code>KmsKeyId</code> for a replica secret.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export interface ReplicaRegionType {
|
|
8
8
|
/**
|
|
9
|
-
* @public
|
|
10
9
|
* <p>A Region code. For a list of Region codes, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints">Name and code of Regions</a>.</p>
|
|
10
|
+
* @public
|
|
11
11
|
*/
|
|
12
12
|
Region?: string;
|
|
13
13
|
/**
|
|
14
|
-
* @public
|
|
15
14
|
* <p>The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses <code>aws/secretsmanager</code>.</p>
|
|
15
|
+
* @public
|
|
16
16
|
*/
|
|
17
17
|
KmsKeyId?: string;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
|
-
* @public
|
|
21
20
|
* <p>The error Secrets Manager encountered while retrieving an individual secret as part of <a>BatchGetSecretValue</a>.</p>
|
|
21
|
+
* @public
|
|
22
22
|
*/
|
|
23
23
|
export interface APIErrorType {
|
|
24
24
|
/**
|
|
25
|
-
* @public
|
|
26
25
|
* <p>The ARN or name of the secret.</p>
|
|
26
|
+
* @public
|
|
27
27
|
*/
|
|
28
28
|
SecretId?: string;
|
|
29
29
|
/**
|
|
30
|
-
* @public
|
|
31
30
|
* <p>The error Secrets Manager encountered while retrieving an individual secret as part of <a>BatchGetSecretValue</a>, for example <code>ResourceNotFoundException</code>,<code>InvalidParameterException</code>, <code>InvalidRequestException</code>, <code>DecryptionFailure</code>, or <code>AccessDeniedException</code>.</p>
|
|
31
|
+
* @public
|
|
32
32
|
*/
|
|
33
33
|
ErrorCode?: string;
|
|
34
34
|
/**
|
|
35
|
-
* @public
|
|
36
35
|
* <p>A message describing the error.</p>
|
|
36
|
+
* @public
|
|
37
37
|
*/
|
|
38
38
|
Message?: string;
|
|
39
39
|
}
|
|
@@ -55,12 +55,11 @@ export declare const FilterNameStringType: {
|
|
|
55
55
|
*/
|
|
56
56
|
export type FilterNameStringType = (typeof FilterNameStringType)[keyof typeof FilterNameStringType];
|
|
57
57
|
/**
|
|
58
|
-
* @public
|
|
59
58
|
* <p>Allows you to add filters when you use the search function in Secrets Manager. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in Secrets Manager</a>.</p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
export interface Filter {
|
|
62
62
|
/**
|
|
63
|
-
* @public
|
|
64
63
|
* <p>The following are keys you can use:</p>
|
|
65
64
|
* <ul>
|
|
66
65
|
* <li>
|
|
@@ -92,12 +91,13 @@ export interface Filter {
|
|
|
92
91
|
* <b>all</b>: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.</p>
|
|
93
92
|
* </li>
|
|
94
93
|
* </ul>
|
|
94
|
+
* @public
|
|
95
95
|
*/
|
|
96
96
|
Key?: FilterNameStringType;
|
|
97
97
|
/**
|
|
98
|
-
* @public
|
|
99
98
|
* <p>The keyword to filter for.</p>
|
|
100
99
|
* <p>You can prefix your search value with an exclamation mark (<code>!</code>) in order to perform negation filters. </p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
Values?: string[];
|
|
103
103
|
}
|
|
@@ -106,74 +106,74 @@ export interface Filter {
|
|
|
106
106
|
*/
|
|
107
107
|
export interface BatchGetSecretValueRequest {
|
|
108
108
|
/**
|
|
109
|
-
* @public
|
|
110
109
|
* <p>The ARN or names of the secrets to retrieve. You must include <code>Filters</code> or <code>SecretIdList</code>, but not both.</p>
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
SecretIdList?: string[];
|
|
113
113
|
/**
|
|
114
|
-
* @public
|
|
115
114
|
* <p>The filters to choose which secrets to retrieve. You must include <code>Filters</code> or <code>SecretIdList</code>, but not both.</p>
|
|
115
|
+
* @public
|
|
116
116
|
*/
|
|
117
117
|
Filters?: Filter[];
|
|
118
118
|
/**
|
|
119
|
-
* @public
|
|
120
119
|
* <p>The number of results to include in the response.</p>
|
|
121
120
|
* <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
|
|
122
121
|
* To get the next results, call <code>BatchGetSecretValue</code> again with the value from
|
|
123
|
-
* <code>NextToken</code
|
|
122
|
+
* <code>NextToken</code>. To use this parameter, you must also use the <code>Filters</code> parameter.</p>
|
|
123
|
+
* @public
|
|
124
124
|
*/
|
|
125
125
|
MaxResults?: number;
|
|
126
126
|
/**
|
|
127
|
-
* @public
|
|
128
127
|
* <p>A token that indicates where the output should continue from, if a
|
|
129
128
|
* previous call did not show all results. To get the next results, call <code>BatchGetSecretValue</code> again
|
|
130
129
|
* with this value.</p>
|
|
130
|
+
* @public
|
|
131
131
|
*/
|
|
132
132
|
NextToken?: string;
|
|
133
133
|
}
|
|
134
134
|
/**
|
|
135
|
-
* @public
|
|
136
135
|
* <p>A structure that contains the secret value and other details for a secret.</p>
|
|
136
|
+
* @public
|
|
137
137
|
*/
|
|
138
138
|
export interface SecretValueEntry {
|
|
139
139
|
/**
|
|
140
|
-
* @public
|
|
141
140
|
* <p>The Amazon Resource Name (ARN) of the secret.</p>
|
|
141
|
+
* @public
|
|
142
142
|
*/
|
|
143
143
|
ARN?: string;
|
|
144
144
|
/**
|
|
145
|
-
* @public
|
|
146
145
|
* <p>The friendly name of the secret. </p>
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
Name?: string;
|
|
149
149
|
/**
|
|
150
|
-
* @public
|
|
151
150
|
* <p>The unique version identifier of this version of the secret.</p>
|
|
151
|
+
* @public
|
|
152
152
|
*/
|
|
153
153
|
VersionId?: string;
|
|
154
154
|
/**
|
|
155
|
-
* @public
|
|
156
155
|
* <p>The decrypted secret value, if the secret value was originally provided as
|
|
157
156
|
* binary data in the form of a byte array. The parameter represents the binary data as
|
|
158
157
|
* a <a href="https://tools.ietf.org/html/rfc4648#section-4">base64-encoded</a>
|
|
159
158
|
* string.</p>
|
|
159
|
+
* @public
|
|
160
160
|
*/
|
|
161
161
|
SecretBinary?: Uint8Array;
|
|
162
162
|
/**
|
|
163
|
-
* @public
|
|
164
163
|
* <p>The decrypted secret value, if the secret value was originally provided as a string or
|
|
165
164
|
* through the Secrets Manager console.</p>
|
|
165
|
+
* @public
|
|
166
166
|
*/
|
|
167
167
|
SecretString?: string;
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <p>A list of all of the staging labels currently attached to this version of the
|
|
171
170
|
* secret.</p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
VersionStages?: string[];
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>The date the secret was created.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
CreatedDate?: Date;
|
|
179
179
|
}
|
|
@@ -182,28 +182,28 @@ export interface SecretValueEntry {
|
|
|
182
182
|
*/
|
|
183
183
|
export interface BatchGetSecretValueResponse {
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>A list of secret values.</p>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
SecretValues?: SecretValueEntry[];
|
|
189
189
|
/**
|
|
190
|
-
* @public
|
|
191
190
|
* <p>Secrets Manager includes this value if
|
|
192
191
|
* there's more output available than what is included in the current response. This can
|
|
193
192
|
* occur even when the response includes no values at all, such as when you ask for a filtered view
|
|
194
193
|
* of a long list. To get the next results, call <code>BatchGetSecretValue</code> again
|
|
195
194
|
* with this value.</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
NextToken?: string;
|
|
198
198
|
/**
|
|
199
|
-
* @public
|
|
200
199
|
* <p>A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.</p>
|
|
200
|
+
* @public
|
|
201
201
|
*/
|
|
202
202
|
Errors?: APIErrorType[];
|
|
203
203
|
}
|
|
204
204
|
/**
|
|
205
|
-
* @public
|
|
206
205
|
* <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
|
|
206
|
+
* @public
|
|
207
207
|
*/
|
|
208
208
|
export declare class DecryptionFailure extends __BaseException {
|
|
209
209
|
readonly name: "DecryptionFailure";
|
|
@@ -215,8 +215,8 @@ export declare class DecryptionFailure extends __BaseException {
|
|
|
215
215
|
constructor(opts: __ExceptionOptionType<DecryptionFailure, __BaseException>);
|
|
216
216
|
}
|
|
217
217
|
/**
|
|
218
|
-
* @public
|
|
219
218
|
* <p>An error occurred on the server side.</p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
export declare class InternalServiceError extends __BaseException {
|
|
222
222
|
readonly name: "InternalServiceError";
|
|
@@ -228,8 +228,8 @@ export declare class InternalServiceError extends __BaseException {
|
|
|
228
228
|
constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
|
|
229
229
|
}
|
|
230
230
|
/**
|
|
231
|
-
* @public
|
|
232
231
|
* <p>The <code>NextToken</code> value is invalid.</p>
|
|
232
|
+
* @public
|
|
233
233
|
*/
|
|
234
234
|
export declare class InvalidNextTokenException extends __BaseException {
|
|
235
235
|
readonly name: "InvalidNextTokenException";
|
|
@@ -241,8 +241,8 @@ export declare class InvalidNextTokenException extends __BaseException {
|
|
|
241
241
|
constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
|
|
242
242
|
}
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>The parameter name or value is invalid.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
export declare class InvalidParameterException extends __BaseException {
|
|
248
248
|
readonly name: "InvalidParameterException";
|
|
@@ -254,7 +254,6 @@ export declare class InvalidParameterException extends __BaseException {
|
|
|
254
254
|
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
255
255
|
}
|
|
256
256
|
/**
|
|
257
|
-
* @public
|
|
258
257
|
* <p>A parameter value is not valid for the current state of the
|
|
259
258
|
* resource.</p>
|
|
260
259
|
* <p>Possible causes:</p>
|
|
@@ -271,6 +270,7 @@ export declare class InvalidParameterException extends __BaseException {
|
|
|
271
270
|
* 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>
|
|
272
271
|
* </li>
|
|
273
272
|
* </ul>
|
|
273
|
+
* @public
|
|
274
274
|
*/
|
|
275
275
|
export declare class InvalidRequestException extends __BaseException {
|
|
276
276
|
readonly name: "InvalidRequestException";
|
|
@@ -282,8 +282,8 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
282
282
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
286
|
+
* @public
|
|
287
287
|
*/
|
|
288
288
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
289
289
|
readonly name: "ResourceNotFoundException";
|
|
@@ -299,10 +299,10 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
299
299
|
*/
|
|
300
300
|
export interface CancelRotateSecretRequest {
|
|
301
301
|
/**
|
|
302
|
-
* @public
|
|
303
302
|
* <p>The ARN or name of the secret.</p>
|
|
304
303
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
305
304
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
305
|
+
* @public
|
|
306
306
|
*/
|
|
307
307
|
SecretId: string | undefined;
|
|
308
308
|
}
|
|
@@ -311,38 +311,38 @@ export interface CancelRotateSecretRequest {
|
|
|
311
311
|
*/
|
|
312
312
|
export interface CancelRotateSecretResponse {
|
|
313
313
|
/**
|
|
314
|
-
* @public
|
|
315
314
|
* <p>The ARN of the secret.</p>
|
|
315
|
+
* @public
|
|
316
316
|
*/
|
|
317
317
|
ARN?: string;
|
|
318
318
|
/**
|
|
319
|
-
* @public
|
|
320
319
|
* <p>The name of the secret.</p>
|
|
320
|
+
* @public
|
|
321
321
|
*/
|
|
322
322
|
Name?: string;
|
|
323
323
|
/**
|
|
324
|
-
* @public
|
|
325
324
|
* <p>The unique identifier of the version of the secret created during the rotation. This
|
|
326
325
|
* version might not be complete, and should be evaluated for possible deletion. We recommend
|
|
327
326
|
* that you remove the <code>VersionStage</code> value <code>AWSPENDING</code> from this version so that
|
|
328
327
|
* Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from
|
|
329
328
|
* starting future rotations.</p>
|
|
329
|
+
* @public
|
|
330
330
|
*/
|
|
331
331
|
VersionId?: string;
|
|
332
332
|
}
|
|
333
333
|
/**
|
|
334
|
-
* @public
|
|
335
334
|
* <p>A structure that contains information about a tag.</p>
|
|
335
|
+
* @public
|
|
336
336
|
*/
|
|
337
337
|
export interface Tag {
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p>The key identifier, or name, of the tag.</p>
|
|
340
|
+
* @public
|
|
341
341
|
*/
|
|
342
342
|
Key?: string;
|
|
343
343
|
/**
|
|
344
|
-
* @public
|
|
345
344
|
* <p>The string value associated with the key of the tag.</p>
|
|
345
|
+
* @public
|
|
346
346
|
*/
|
|
347
347
|
Value?: string;
|
|
348
348
|
}
|
|
@@ -351,17 +351,16 @@ export interface Tag {
|
|
|
351
351
|
*/
|
|
352
352
|
export interface CreateSecretRequest {
|
|
353
353
|
/**
|
|
354
|
-
* @public
|
|
355
354
|
* <p>The name of the new secret.</p>
|
|
356
355
|
* <p>The secret name can contain ASCII letters, numbers, and the following characters:
|
|
357
356
|
* /_+=.@-</p>
|
|
358
357
|
* <p>Do not end your secret name with a hyphen followed by six characters. If you do so, you
|
|
359
358
|
* risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager
|
|
360
359
|
* automatically adds a hyphen and six random characters after the secret name at the end of the ARN.</p>
|
|
360
|
+
* @public
|
|
361
361
|
*/
|
|
362
362
|
Name: string | undefined;
|
|
363
363
|
/**
|
|
364
|
-
* @public
|
|
365
364
|
* <p>If you include <code>SecretString</code> or <code>SecretBinary</code>, then
|
|
366
365
|
* Secrets Manager creates an initial version for the secret, and this parameter specifies the unique
|
|
367
366
|
* identifier for the new version. </p>
|
|
@@ -388,15 +387,15 @@ export interface CreateSecretRequest {
|
|
|
388
387
|
* </li>
|
|
389
388
|
* </ul>
|
|
390
389
|
* <p>This value becomes the <code>VersionId</code> of the new version.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
ClientRequestToken?: string;
|
|
393
393
|
/**
|
|
394
|
-
* @public
|
|
395
394
|
* <p>The description of the secret.</p>
|
|
395
|
+
* @public
|
|
396
396
|
*/
|
|
397
397
|
Description?: string;
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
|
|
401
400
|
* encrypt the secret value in the secret. An alias is always prefixed by <code>alias/</code>,
|
|
402
401
|
* for example <code>alias/aws/secretsmanager</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html">About aliases</a>.</p>
|
|
@@ -407,20 +406,20 @@ export interface CreateSecretRequest {
|
|
|
407
406
|
* <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then
|
|
408
407
|
* you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must create
|
|
409
408
|
* and use a customer managed KMS key. </p>
|
|
409
|
+
* @public
|
|
410
410
|
*/
|
|
411
411
|
KmsKeyId?: string;
|
|
412
412
|
/**
|
|
413
|
-
* @public
|
|
414
413
|
* <p>The binary data to encrypt and store in the new version of
|
|
415
414
|
* the secret. We recommend that you store your binary data in a file and then pass the
|
|
416
415
|
* contents of the file as a parameter.</p>
|
|
417
416
|
* <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not
|
|
418
417
|
* both.</p>
|
|
419
418
|
* <p>This parameter is not available in the Secrets Manager console.</p>
|
|
419
|
+
* @public
|
|
420
420
|
*/
|
|
421
421
|
SecretBinary?: Uint8Array;
|
|
422
422
|
/**
|
|
423
|
-
* @public
|
|
424
423
|
* <p>The text data to encrypt and store in this new version of
|
|
425
424
|
* the secret. We recommend you use a JSON structure of key/value pairs for your secret value.</p>
|
|
426
425
|
* <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not
|
|
@@ -428,10 +427,10 @@ export interface CreateSecretRequest {
|
|
|
428
427
|
* <p>If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected
|
|
429
428
|
* secret text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the
|
|
430
429
|
* information as a JSON structure of key/value pairs that a Lambda rotation function can parse.</p>
|
|
430
|
+
* @public
|
|
431
431
|
*/
|
|
432
432
|
SecretString?: string;
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>A list of tags to attach to the secret. Each tag
|
|
436
435
|
* is a key and value pair of strings in a JSON text string, for example:</p>
|
|
437
436
|
* <p>
|
|
@@ -451,17 +450,18 @@ export interface CreateSecretRequest {
|
|
|
451
450
|
* use single quotes to avoid confusion with the double quotes required in the JSON text.</p>
|
|
452
451
|
* <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 Tagging</a> in the <i>Amazon Web Services General
|
|
453
452
|
* Reference guide</i>.</p>
|
|
453
|
+
* @public
|
|
454
454
|
*/
|
|
455
455
|
Tags?: Tag[];
|
|
456
456
|
/**
|
|
457
|
-
* @public
|
|
458
457
|
* <p>A list of Regions and KMS keys to replicate secrets.</p>
|
|
458
|
+
* @public
|
|
459
459
|
*/
|
|
460
460
|
AddReplicaRegions?: ReplicaRegionType[];
|
|
461
461
|
/**
|
|
462
|
-
* @public
|
|
463
462
|
* <p>Specifies whether to overwrite a secret with the same name in the
|
|
464
463
|
* destination Region. By default, secrets aren't overwritten.</p>
|
|
464
|
+
* @public
|
|
465
465
|
*/
|
|
466
466
|
ForceOverwriteReplicaSecret?: boolean;
|
|
467
467
|
}
|
|
@@ -479,34 +479,34 @@ export declare const StatusType: {
|
|
|
479
479
|
*/
|
|
480
480
|
export type StatusType = (typeof StatusType)[keyof typeof StatusType];
|
|
481
481
|
/**
|
|
482
|
-
* @public
|
|
483
482
|
* <p>A replication object consisting of a <code>RegionReplicationStatus</code> object and includes a Region, KMSKeyId, status, and status message.</p>
|
|
483
|
+
* @public
|
|
484
484
|
*/
|
|
485
485
|
export interface ReplicationStatusType {
|
|
486
486
|
/**
|
|
487
|
-
* @public
|
|
488
487
|
* <p>The Region where replication occurs.</p>
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
Region?: string;
|
|
491
491
|
/**
|
|
492
|
-
* @public
|
|
493
492
|
* <p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>
|
|
493
|
+
* @public
|
|
494
494
|
*/
|
|
495
495
|
KmsKeyId?: string;
|
|
496
496
|
/**
|
|
497
|
-
* @public
|
|
498
497
|
* <p>The status can be <code>InProgress</code>, <code>Failed</code>, or <code>InSync</code>.</p>
|
|
498
|
+
* @public
|
|
499
499
|
*/
|
|
500
500
|
Status?: StatusType;
|
|
501
501
|
/**
|
|
502
|
-
* @public
|
|
503
502
|
* <p>Status message such as "<i>Secret with this name already exists in this
|
|
504
503
|
* region</i>".</p>
|
|
504
|
+
* @public
|
|
505
505
|
*/
|
|
506
506
|
StatusMessage?: string;
|
|
507
507
|
/**
|
|
508
|
-
* @public
|
|
509
508
|
* <p>The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.</p>
|
|
509
|
+
* @public
|
|
510
510
|
*/
|
|
511
511
|
LastAccessedDate?: Date;
|
|
512
512
|
}
|
|
@@ -515,25 +515,24 @@ export interface ReplicationStatusType {
|
|
|
515
515
|
*/
|
|
516
516
|
export interface CreateSecretResponse {
|
|
517
517
|
/**
|
|
518
|
-
* @public
|
|
519
518
|
* <p>The ARN of the new secret. The ARN includes the name of the secret followed by six random
|
|
520
519
|
* characters. This ensures that if you create a new secret with the same name as a deleted secret,
|
|
521
520
|
* then users with access to the old secret don't get access to the new secret because the ARNs
|
|
522
521
|
* are different.</p>
|
|
522
|
+
* @public
|
|
523
523
|
*/
|
|
524
524
|
ARN?: string;
|
|
525
525
|
/**
|
|
526
|
-
* @public
|
|
527
526
|
* <p>The name of the new secret.</p>
|
|
527
|
+
* @public
|
|
528
528
|
*/
|
|
529
529
|
Name?: string;
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <p>The unique identifier associated with the version of the new secret.</p>
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
VersionId?: string;
|
|
535
535
|
/**
|
|
536
|
-
* @public
|
|
537
536
|
* <p>A list of the replicas of this secret and their status:</p>
|
|
538
537
|
* <ul>
|
|
539
538
|
* <li>
|
|
@@ -549,14 +548,15 @@ export interface CreateSecretResponse {
|
|
|
549
548
|
* <code>InSync</code>, which indicates that the replica was created.</p>
|
|
550
549
|
* </li>
|
|
551
550
|
* </ul>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
ReplicationStatus?: ReplicationStatusType[];
|
|
554
554
|
}
|
|
555
555
|
/**
|
|
556
|
-
* @public
|
|
557
556
|
* <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
|
|
558
557
|
* KMS key is available, enabled, and not in an invalid state. For more
|
|
559
558
|
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a>.</p>
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
export declare class EncryptionFailure extends __BaseException {
|
|
562
562
|
readonly name: "EncryptionFailure";
|
|
@@ -568,8 +568,8 @@ export declare class EncryptionFailure extends __BaseException {
|
|
|
568
568
|
constructor(opts: __ExceptionOptionType<EncryptionFailure, __BaseException>);
|
|
569
569
|
}
|
|
570
570
|
/**
|
|
571
|
-
* @public
|
|
572
571
|
* <p>The request failed because it would exceed one of the Secrets Manager quotas.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
export declare class LimitExceededException extends __BaseException {
|
|
575
575
|
readonly name: "LimitExceededException";
|
|
@@ -581,8 +581,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
581
581
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
582
582
|
}
|
|
583
583
|
/**
|
|
584
|
-
* @public
|
|
585
584
|
* <p>The resource policy has syntax errors.</p>
|
|
585
|
+
* @public
|
|
586
586
|
*/
|
|
587
587
|
export declare class MalformedPolicyDocumentException extends __BaseException {
|
|
588
588
|
readonly name: "MalformedPolicyDocumentException";
|
|
@@ -594,8 +594,8 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
|
|
|
594
594
|
constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
|
|
595
595
|
}
|
|
596
596
|
/**
|
|
597
|
-
* @public
|
|
598
597
|
* <p>The request failed because you did not complete all the prerequisite steps.</p>
|
|
598
|
+
* @public
|
|
599
599
|
*/
|
|
600
600
|
export declare class PreconditionNotMetException extends __BaseException {
|
|
601
601
|
readonly name: "PreconditionNotMetException";
|
|
@@ -607,8 +607,8 @@ export declare class PreconditionNotMetException extends __BaseException {
|
|
|
607
607
|
constructor(opts: __ExceptionOptionType<PreconditionNotMetException, __BaseException>);
|
|
608
608
|
}
|
|
609
609
|
/**
|
|
610
|
-
* @public
|
|
611
610
|
* <p>A resource with the ID you requested already exists.</p>
|
|
611
|
+
* @public
|
|
612
612
|
*/
|
|
613
613
|
export declare class ResourceExistsException extends __BaseException {
|
|
614
614
|
readonly name: "ResourceExistsException";
|
|
@@ -624,10 +624,10 @@ export declare class ResourceExistsException extends __BaseException {
|
|
|
624
624
|
*/
|
|
625
625
|
export interface DeleteResourcePolicyRequest {
|
|
626
626
|
/**
|
|
627
|
-
* @public
|
|
628
627
|
* <p>The ARN or name of the secret to delete the attached resource-based policy for.</p>
|
|
629
628
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
630
629
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
630
|
+
* @public
|
|
631
631
|
*/
|
|
632
632
|
SecretId: string | undefined;
|
|
633
633
|
}
|
|
@@ -636,13 +636,13 @@ export interface DeleteResourcePolicyRequest {
|
|
|
636
636
|
*/
|
|
637
637
|
export interface DeleteResourcePolicyResponse {
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>The ARN of the secret that the resource-based policy was deleted for.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
ARN?: string;
|
|
643
643
|
/**
|
|
644
|
-
* @public
|
|
645
644
|
* <p>The name of the secret that the resource-based policy was deleted for.</p>
|
|
645
|
+
* @public
|
|
646
646
|
*/
|
|
647
647
|
Name?: string;
|
|
648
648
|
}
|
|
@@ -651,21 +651,20 @@ export interface DeleteResourcePolicyResponse {
|
|
|
651
651
|
*/
|
|
652
652
|
export interface DeleteSecretRequest {
|
|
653
653
|
/**
|
|
654
|
-
* @public
|
|
655
654
|
* <p>The ARN or name of the secret to delete.</p>
|
|
656
655
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
657
656
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
657
|
+
* @public
|
|
658
658
|
*/
|
|
659
659
|
SecretId: string | undefined;
|
|
660
660
|
/**
|
|
661
|
-
* @public
|
|
662
661
|
* <p>The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the
|
|
663
662
|
* secret. You can't use both this parameter and <code>ForceDeleteWithoutRecovery</code>
|
|
664
663
|
* in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.</p>
|
|
664
|
+
* @public
|
|
665
665
|
*/
|
|
666
666
|
RecoveryWindowInDays?: number;
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>Specifies whether to delete the secret without any recovery window. You
|
|
670
669
|
* can't use both this parameter and <code>RecoveryWindowInDays</code> in the same
|
|
671
670
|
* call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.</p>
|
|
@@ -680,6 +679,7 @@ export interface DeleteSecretRequest {
|
|
|
680
679
|
* <code>ForceDeleteWithoutRecovery</code> parameter, then you have no opportunity to recover
|
|
681
680
|
* the secret. You lose the secret permanently.</p>
|
|
682
681
|
* </important>
|
|
682
|
+
* @public
|
|
683
683
|
*/
|
|
684
684
|
ForceDeleteWithoutRecovery?: boolean;
|
|
685
685
|
}
|
|
@@ -688,20 +688,20 @@ export interface DeleteSecretRequest {
|
|
|
688
688
|
*/
|
|
689
689
|
export interface DeleteSecretResponse {
|
|
690
690
|
/**
|
|
691
|
-
* @public
|
|
692
691
|
* <p>The ARN of the secret.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
ARN?: string;
|
|
695
695
|
/**
|
|
696
|
-
* @public
|
|
697
696
|
* <p>The name of the secret.</p>
|
|
697
|
+
* @public
|
|
698
698
|
*/
|
|
699
699
|
Name?: string;
|
|
700
700
|
/**
|
|
701
|
-
* @public
|
|
702
701
|
* <p>The date and time after which this secret Secrets Manager can permanently delete this secret,
|
|
703
702
|
* and it can no longer be restored. This value is the date and time of the delete request
|
|
704
703
|
* plus the number of days in <code>RecoveryWindowInDays</code>.</p>
|
|
704
|
+
* @public
|
|
705
705
|
*/
|
|
706
706
|
DeletionDate?: Date;
|
|
707
707
|
}
|
|
@@ -710,20 +710,19 @@ export interface DeleteSecretResponse {
|
|
|
710
710
|
*/
|
|
711
711
|
export interface DescribeSecretRequest {
|
|
712
712
|
/**
|
|
713
|
-
* @public
|
|
714
713
|
* <p>The ARN or name of the secret. </p>
|
|
715
714
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
716
715
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
716
|
+
* @public
|
|
717
717
|
*/
|
|
718
718
|
SecretId: string | undefined;
|
|
719
719
|
}
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <p>A structure that defines the rotation configuration for the secret.</p>
|
|
722
|
+
* @public
|
|
723
723
|
*/
|
|
724
724
|
export interface RotationRulesType {
|
|
725
725
|
/**
|
|
726
|
-
* @public
|
|
727
726
|
* <p>The number of days between rotations of the secret. You can use this
|
|
728
727
|
* value to check that your secret meets your compliance guidelines for how often secrets must
|
|
729
728
|
* be rotated. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation
|
|
@@ -734,10 +733,10 @@ export interface RotationRulesType {
|
|
|
734
733
|
* set the rotation schedule in <code>RotationRules</code> with <code>AutomaticallyAfterDays</code>
|
|
735
734
|
* or <code>ScheduleExpression</code>, but not both. To set a rotation schedule in hours, use
|
|
736
735
|
* <code>ScheduleExpression</code>.</p>
|
|
736
|
+
* @public
|
|
737
737
|
*/
|
|
738
738
|
AutomaticallyAfterDays?: number;
|
|
739
739
|
/**
|
|
740
|
-
* @public
|
|
741
740
|
* <p>The length of the rotation window in hours, for example <code>3h</code> for a three
|
|
742
741
|
* hour window. Secrets Manager rotates your secret at any time during this window. The window must not
|
|
743
742
|
* extend into the next rotation window or the next UTC day. The window starts according to the <code>ScheduleExpression</code>. If you don't specify a <code>Duration</code>,
|
|
@@ -746,10 +745,10 @@ export interface RotationRulesType {
|
|
|
746
745
|
* end of the UTC day. For
|
|
747
746
|
* more information, including examples, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html">Schedule expressions
|
|
748
747
|
* in Secrets Manager rotation</a> in the <i>Secrets Manager Users Guide</i>.</p>
|
|
748
|
+
* @public
|
|
749
749
|
*/
|
|
750
750
|
Duration?: string;
|
|
751
751
|
/**
|
|
752
|
-
* @public
|
|
753
752
|
* <p>A <code>cron()</code> or <code>rate()</code> expression that defines the schedule for
|
|
754
753
|
* rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.</p>
|
|
755
754
|
* <p>Secrets Manager <code>rate()</code> expressions represent the interval in hours or days that you
|
|
@@ -768,6 +767,7 @@ export interface RotationRulesType {
|
|
|
768
767
|
* a cron expression that represents a schedule in days, the default rotation window closes at
|
|
769
768
|
* the end of the day. You can set the <code>Duration</code> to change the rotation window. The
|
|
770
769
|
* rotation window must not extend into the next UTC day or into the next rotation window.</p>
|
|
770
|
+
* @public
|
|
771
771
|
*/
|
|
772
772
|
ScheduleExpression?: string;
|
|
773
773
|
}
|
|
@@ -776,86 +776,86 @@ export interface RotationRulesType {
|
|
|
776
776
|
*/
|
|
777
777
|
export interface DescribeSecretResponse {
|
|
778
778
|
/**
|
|
779
|
-
* @public
|
|
780
779
|
* <p>The ARN of the secret.</p>
|
|
780
|
+
* @public
|
|
781
781
|
*/
|
|
782
782
|
ARN?: string;
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>The name of the secret.</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
Name?: string;
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>The description of the secret.</p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
Description?: string;
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
|
|
796
795
|
* If the secret is encrypted with the Amazon Web Services managed key <code>aws/secretsmanager</code>,
|
|
797
796
|
* this field is omitted. Secrets created using the console use an KMS key ID.</p>
|
|
797
|
+
* @public
|
|
798
798
|
*/
|
|
799
799
|
KmsKeyId?: string;
|
|
800
800
|
/**
|
|
801
|
-
* @public
|
|
802
801
|
* <p>Specifies whether automatic rotation is turned on for this secret.</p>
|
|
803
802
|
* <p>To turn on rotation, use <a>RotateSecret</a>. To turn off
|
|
804
803
|
* rotation, use <a>CancelRotateSecret</a>.</p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
RotationEnabled?: boolean;
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>The ARN of the Lambda function that Secrets Manager invokes to rotate the
|
|
810
809
|
* secret. </p>
|
|
810
|
+
* @public
|
|
811
811
|
*/
|
|
812
812
|
RotationLambdaARN?: string;
|
|
813
813
|
/**
|
|
814
|
-
* @public
|
|
815
814
|
* <p>The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but
|
|
816
815
|
* it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had
|
|
817
816
|
* rotation turned on, this field is omitted.</p>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
RotationRules?: RotationRulesType;
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>The last date and time that Secrets Manager rotated the secret.
|
|
823
822
|
* If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.</p>
|
|
823
|
+
* @public
|
|
824
824
|
*/
|
|
825
825
|
LastRotatedDate?: Date;
|
|
826
826
|
/**
|
|
827
|
-
* @public
|
|
828
827
|
* <p>The last date and time that this secret was modified in any way.</p>
|
|
828
|
+
* @public
|
|
829
829
|
*/
|
|
830
830
|
LastChangedDate?: Date;
|
|
831
831
|
/**
|
|
832
|
-
* @public
|
|
833
832
|
* <p>The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.</p>
|
|
833
|
+
* @public
|
|
834
834
|
*/
|
|
835
835
|
LastAccessedDate?: Date;
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <p>The date the secret is scheduled for deletion. If it is not scheduled for deletion, this
|
|
839
838
|
* field is omitted. When you delete a secret, Secrets Manager requires a
|
|
840
839
|
* recovery window of at least 7 days before deleting the secret. Some time after the deleted date,
|
|
841
840
|
* Secrets Manager deletes the secret, including all of its versions.</p>
|
|
842
841
|
* <p>If a secret is scheduled for deletion, then its details, including the encrypted secret
|
|
843
842
|
* value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use <a>RestoreSecret</a>.</p>
|
|
843
|
+
* @public
|
|
844
844
|
*/
|
|
845
845
|
DeletedDate?: Date;
|
|
846
846
|
/**
|
|
847
|
-
* @public
|
|
848
847
|
* <p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.</p>
|
|
848
|
+
* <p>This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.</p>
|
|
849
|
+
* @public
|
|
849
850
|
*/
|
|
850
851
|
NextRotationDate?: Date;
|
|
851
852
|
/**
|
|
852
|
-
* @public
|
|
853
853
|
* <p>The list of tags attached to the secret. To add tags to a
|
|
854
854
|
* secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>
|
|
855
|
+
* @public
|
|
855
856
|
*/
|
|
856
857
|
Tags?: Tag[];
|
|
857
858
|
/**
|
|
858
|
-
* @public
|
|
859
859
|
* <p>A list of the versions of the secret that have staging labels attached.
|
|
860
860
|
* Versions that don't have staging labels are considered deprecated and Secrets Manager
|
|
861
861
|
* can delete them.</p>
|
|
@@ -881,25 +881,25 @@ export interface DescribeSecretResponse {
|
|
|
881
881
|
* </li>
|
|
882
882
|
* </ul>
|
|
883
883
|
* <p>For more information about rotation and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
|
|
884
|
+
* @public
|
|
884
885
|
*/
|
|
885
886
|
VersionIdsToStages?: Record<string, string[]>;
|
|
886
887
|
/**
|
|
887
|
-
* @public
|
|
888
888
|
* <p>The ID of the service that created this secret. 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>
|
|
889
|
+
* @public
|
|
889
890
|
*/
|
|
890
891
|
OwningService?: string;
|
|
891
892
|
/**
|
|
892
|
-
* @public
|
|
893
893
|
* <p>The date the secret was created.</p>
|
|
894
|
+
* @public
|
|
894
895
|
*/
|
|
895
896
|
CreatedDate?: Date;
|
|
896
897
|
/**
|
|
897
|
-
* @public
|
|
898
898
|
* <p>The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in <code>ReplicationStatus</code>. </p>
|
|
899
|
+
* @public
|
|
899
900
|
*/
|
|
900
901
|
PrimaryRegion?: string;
|
|
901
902
|
/**
|
|
902
|
-
* @public
|
|
903
903
|
* <p>A list of the replicas of this secret and their status: </p>
|
|
904
904
|
* <ul>
|
|
905
905
|
* <li>
|
|
@@ -915,6 +915,7 @@ export interface DescribeSecretResponse {
|
|
|
915
915
|
* <code>InSync</code>, which indicates that the replica was created.</p>
|
|
916
916
|
* </li>
|
|
917
917
|
* </ul>
|
|
918
|
+
* @public
|
|
918
919
|
*/
|
|
919
920
|
ReplicationStatus?: ReplicationStatusType[];
|
|
920
921
|
}
|
|
@@ -923,51 +924,51 @@ export interface DescribeSecretResponse {
|
|
|
923
924
|
*/
|
|
924
925
|
export interface GetRandomPasswordRequest {
|
|
925
926
|
/**
|
|
926
|
-
* @public
|
|
927
927
|
* <p>The length of the password. If you don't include this parameter, the
|
|
928
928
|
* default length is 32 characters.</p>
|
|
929
|
+
* @public
|
|
929
930
|
*/
|
|
930
931
|
PasswordLength?: number;
|
|
931
932
|
/**
|
|
932
|
-
* @public
|
|
933
933
|
* <p>A string of the characters that you don't want in the password.</p>
|
|
934
|
+
* @public
|
|
934
935
|
*/
|
|
935
936
|
ExcludeCharacters?: string;
|
|
936
937
|
/**
|
|
937
|
-
* @public
|
|
938
938
|
* <p>Specifies whether to exclude numbers from the password. If you don't
|
|
939
939
|
* include this switch, the password can contain numbers.</p>
|
|
940
|
+
* @public
|
|
940
941
|
*/
|
|
941
942
|
ExcludeNumbers?: boolean;
|
|
942
943
|
/**
|
|
943
|
-
* @public
|
|
944
944
|
* <p>Specifies whether to exclude the following punctuation characters from the password:
|
|
945
945
|
* <code>! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` \{ | \} ~</code>.
|
|
946
946
|
* If you don't include this switch, the password can contain punctuation.</p>
|
|
947
|
+
* @public
|
|
947
948
|
*/
|
|
948
949
|
ExcludePunctuation?: boolean;
|
|
949
950
|
/**
|
|
950
|
-
* @public
|
|
951
951
|
* <p>Specifies whether to exclude uppercase letters from the password. If you
|
|
952
952
|
* don't include this switch, the password can contain uppercase letters.</p>
|
|
953
|
+
* @public
|
|
953
954
|
*/
|
|
954
955
|
ExcludeUppercase?: boolean;
|
|
955
956
|
/**
|
|
956
|
-
* @public
|
|
957
957
|
* <p>Specifies whether to exclude lowercase letters from the password. If
|
|
958
958
|
* you don't include this switch, the password can contain lowercase letters.</p>
|
|
959
|
+
* @public
|
|
959
960
|
*/
|
|
960
961
|
ExcludeLowercase?: boolean;
|
|
961
962
|
/**
|
|
962
|
-
* @public
|
|
963
963
|
* <p>Specifies whether to include the space character. If you
|
|
964
964
|
* include this switch, the password can contain space characters.</p>
|
|
965
|
+
* @public
|
|
965
966
|
*/
|
|
966
967
|
IncludeSpace?: boolean;
|
|
967
968
|
/**
|
|
968
|
-
* @public
|
|
969
969
|
* <p>Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
|
|
970
970
|
* If you don't include this switch, the password contains at least one of every character type.</p>
|
|
971
|
+
* @public
|
|
971
972
|
*/
|
|
972
973
|
RequireEachIncludedType?: boolean;
|
|
973
974
|
}
|
|
@@ -976,8 +977,8 @@ export interface GetRandomPasswordRequest {
|
|
|
976
977
|
*/
|
|
977
978
|
export interface GetRandomPasswordResponse {
|
|
978
979
|
/**
|
|
979
|
-
* @public
|
|
980
980
|
* <p>A string with the password.</p>
|
|
981
|
+
* @public
|
|
981
982
|
*/
|
|
982
983
|
RandomPassword?: string;
|
|
983
984
|
}
|
|
@@ -986,10 +987,10 @@ export interface GetRandomPasswordResponse {
|
|
|
986
987
|
*/
|
|
987
988
|
export interface GetResourcePolicyRequest {
|
|
988
989
|
/**
|
|
989
|
-
* @public
|
|
990
990
|
* <p>The ARN or name of the secret to retrieve the attached resource-based policy for.</p>
|
|
991
991
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
992
992
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
993
|
+
* @public
|
|
993
994
|
*/
|
|
994
995
|
SecretId: string | undefined;
|
|
995
996
|
}
|
|
@@ -998,20 +999,20 @@ export interface GetResourcePolicyRequest {
|
|
|
998
999
|
*/
|
|
999
1000
|
export interface GetResourcePolicyResponse {
|
|
1000
1001
|
/**
|
|
1001
|
-
* @public
|
|
1002
1002
|
* <p>The ARN of the secret that the resource-based policy was retrieved for.</p>
|
|
1003
|
+
* @public
|
|
1003
1004
|
*/
|
|
1004
1005
|
ARN?: string;
|
|
1005
1006
|
/**
|
|
1006
|
-
* @public
|
|
1007
1007
|
* <p>The name of the secret that the resource-based policy was retrieved for.</p>
|
|
1008
|
+
* @public
|
|
1008
1009
|
*/
|
|
1009
1010
|
Name?: string;
|
|
1010
1011
|
/**
|
|
1011
|
-
* @public
|
|
1012
1012
|
* <p>A JSON-formatted string that contains the permissions policy
|
|
1013
1013
|
* attached to the secret. For more information about permissions policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control for
|
|
1014
1014
|
* Secrets Manager</a>.</p>
|
|
1015
|
+
* @public
|
|
1015
1016
|
*/
|
|
1016
1017
|
ResourcePolicy?: string;
|
|
1017
1018
|
}
|
|
@@ -1020,29 +1021,29 @@ export interface GetResourcePolicyResponse {
|
|
|
1020
1021
|
*/
|
|
1021
1022
|
export interface GetSecretValueRequest {
|
|
1022
1023
|
/**
|
|
1023
|
-
* @public
|
|
1024
1024
|
* <p>The ARN or name of the secret to retrieve.</p>
|
|
1025
1025
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1026
1026
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1027
|
+
* @public
|
|
1027
1028
|
*/
|
|
1028
1029
|
SecretId: string | undefined;
|
|
1029
1030
|
/**
|
|
1030
|
-
* @public
|
|
1031
1031
|
* <p>The unique identifier of the version of the secret to retrieve. If
|
|
1032
1032
|
* you include both this parameter and <code>VersionStage</code>, the two parameters must refer
|
|
1033
1033
|
* to the same secret version. If you don't specify either a <code>VersionStage</code> or
|
|
1034
1034
|
* <code>VersionId</code>, then Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
|
|
1035
1035
|
* <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value with
|
|
1036
1036
|
* 32 hexadecimal digits.</p>
|
|
1037
|
+
* @public
|
|
1037
1038
|
*/
|
|
1038
1039
|
VersionId?: string;
|
|
1039
1040
|
/**
|
|
1040
|
-
* @public
|
|
1041
1041
|
* <p>The staging label of the version of the secret to retrieve. </p>
|
|
1042
1042
|
* <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process.
|
|
1043
1043
|
* If you include both this parameter and <code>VersionId</code>, the two parameters must refer
|
|
1044
1044
|
* to the same secret version. If you don't specify either a <code>VersionStage</code> or
|
|
1045
1045
|
* <code>VersionId</code>, Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
|
|
1046
|
+
* @public
|
|
1046
1047
|
*/
|
|
1047
1048
|
VersionStage?: string;
|
|
1048
1049
|
}
|
|
@@ -1051,48 +1052,48 @@ export interface GetSecretValueRequest {
|
|
|
1051
1052
|
*/
|
|
1052
1053
|
export interface GetSecretValueResponse {
|
|
1053
1054
|
/**
|
|
1054
|
-
* @public
|
|
1055
1055
|
* <p>The ARN of the secret.</p>
|
|
1056
|
+
* @public
|
|
1056
1057
|
*/
|
|
1057
1058
|
ARN?: string;
|
|
1058
1059
|
/**
|
|
1059
|
-
* @public
|
|
1060
1060
|
* <p>The friendly name of the secret.</p>
|
|
1061
|
+
* @public
|
|
1061
1062
|
*/
|
|
1062
1063
|
Name?: string;
|
|
1063
1064
|
/**
|
|
1064
|
-
* @public
|
|
1065
1065
|
* <p>The unique identifier of this version of the secret.</p>
|
|
1066
|
+
* @public
|
|
1066
1067
|
*/
|
|
1067
1068
|
VersionId?: string;
|
|
1068
1069
|
/**
|
|
1069
|
-
* @public
|
|
1070
1070
|
* <p>The decrypted secret value, if the secret value was originally provided as
|
|
1071
1071
|
* binary data in the form of a byte array. When you retrieve a <code>SecretBinary</code> using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.</p>
|
|
1072
1072
|
* <p>If the secret was created by using the Secrets Manager console, or if the secret value was
|
|
1073
1073
|
* originally provided as a string, then this field is omitted. The secret value appears in
|
|
1074
1074
|
* <code>SecretString</code> instead.</p>
|
|
1075
|
+
* @public
|
|
1075
1076
|
*/
|
|
1076
1077
|
SecretBinary?: Uint8Array;
|
|
1077
1078
|
/**
|
|
1078
|
-
* @public
|
|
1079
1079
|
* <p>The decrypted secret value, if the secret value was originally provided as a string or
|
|
1080
1080
|
* through the Secrets Manager console.</p>
|
|
1081
1081
|
* <p>If this secret was created by using the console, then Secrets Manager stores the information as a
|
|
1082
1082
|
* JSON structure of key/value pairs. </p>
|
|
1083
|
+
* @public
|
|
1083
1084
|
*/
|
|
1084
1085
|
SecretString?: string;
|
|
1085
1086
|
/**
|
|
1086
|
-
* @public
|
|
1087
1087
|
* <p>A list of all of the staging labels currently attached to this version of the
|
|
1088
1088
|
* secret.</p>
|
|
1089
|
+
* @public
|
|
1089
1090
|
*/
|
|
1090
1091
|
VersionStages?: string[];
|
|
1091
1092
|
/**
|
|
1092
|
-
* @public
|
|
1093
1093
|
* <p>The date and time that this version of the secret was created. If you don't specify
|
|
1094
1094
|
* which version in <code>VersionId</code> or <code>VersionStage</code>, then Secrets Manager uses the
|
|
1095
1095
|
* <code>AWSCURRENT</code> version.</p>
|
|
1096
|
+
* @public
|
|
1096
1097
|
*/
|
|
1097
1098
|
CreatedDate?: Date;
|
|
1098
1099
|
}
|
|
@@ -1113,114 +1114,113 @@ export type SortOrderType = (typeof SortOrderType)[keyof typeof SortOrderType];
|
|
|
1113
1114
|
*/
|
|
1114
1115
|
export interface ListSecretsRequest {
|
|
1115
1116
|
/**
|
|
1116
|
-
* @public
|
|
1117
1117
|
* <p>Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.</p>
|
|
1118
|
+
* @public
|
|
1118
1119
|
*/
|
|
1119
1120
|
IncludePlannedDeletion?: boolean;
|
|
1120
1121
|
/**
|
|
1121
|
-
* @public
|
|
1122
1122
|
* <p>The number of results to include in the response.</p>
|
|
1123
1123
|
* <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
|
|
1124
1124
|
* To get the next results, call <code>ListSecrets</code> again with the value from
|
|
1125
1125
|
* <code>NextToken</code>.</p>
|
|
1126
|
+
* @public
|
|
1126
1127
|
*/
|
|
1127
1128
|
MaxResults?: number;
|
|
1128
1129
|
/**
|
|
1129
|
-
* @public
|
|
1130
1130
|
* <p>A token that indicates where the output should continue from, if a
|
|
1131
1131
|
* previous call did not show all results. To get the next results, call <code>ListSecrets</code> again
|
|
1132
1132
|
* with this value.</p>
|
|
1133
|
+
* @public
|
|
1133
1134
|
*/
|
|
1134
1135
|
NextToken?: string;
|
|
1135
1136
|
/**
|
|
1136
|
-
* @public
|
|
1137
1137
|
* <p>The filters to apply to the list of secrets.</p>
|
|
1138
|
+
* @public
|
|
1138
1139
|
*/
|
|
1139
1140
|
Filters?: Filter[];
|
|
1140
1141
|
/**
|
|
1141
|
-
* @public
|
|
1142
1142
|
* <p>Secrets are listed by <code>CreatedDate</code>. </p>
|
|
1143
|
+
* @public
|
|
1143
1144
|
*/
|
|
1144
1145
|
SortOrder?: SortOrderType;
|
|
1145
1146
|
}
|
|
1146
1147
|
/**
|
|
1147
|
-
* @public
|
|
1148
1148
|
* <p>A structure that contains the details about a secret. It does not include the encrypted
|
|
1149
1149
|
* <code>SecretString</code> and <code>SecretBinary</code> values. To get those values, use
|
|
1150
1150
|
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html">GetSecretValue</a>
|
|
1151
1151
|
* .</p>
|
|
1152
|
+
* @public
|
|
1152
1153
|
*/
|
|
1153
1154
|
export interface SecretListEntry {
|
|
1154
1155
|
/**
|
|
1155
|
-
* @public
|
|
1156
1156
|
* <p>The Amazon Resource Name (ARN) of the secret.</p>
|
|
1157
|
+
* @public
|
|
1157
1158
|
*/
|
|
1158
1159
|
ARN?: string;
|
|
1159
1160
|
/**
|
|
1160
|
-
* @public
|
|
1161
1161
|
* <p>The friendly name of the secret. </p>
|
|
1162
|
+
* @public
|
|
1162
1163
|
*/
|
|
1163
1164
|
Name?: string;
|
|
1164
1165
|
/**
|
|
1165
|
-
* @public
|
|
1166
1166
|
* <p>The user-provided description of the secret.</p>
|
|
1167
|
+
* @public
|
|
1167
1168
|
*/
|
|
1168
1169
|
Description?: string;
|
|
1169
1170
|
/**
|
|
1170
|
-
* @public
|
|
1171
1171
|
* <p>The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with
|
|
1172
1172
|
* the Amazon Web Services managed key <code>aws/secretsmanager</code>, this field is omitted.</p>
|
|
1173
|
+
* @public
|
|
1173
1174
|
*/
|
|
1174
1175
|
KmsKeyId?: string;
|
|
1175
1176
|
/**
|
|
1176
|
-
* @public
|
|
1177
1177
|
* <p>Indicates whether automatic, scheduled rotation is enabled for this secret.</p>
|
|
1178
|
+
* @public
|
|
1178
1179
|
*/
|
|
1179
1180
|
RotationEnabled?: boolean;
|
|
1180
1181
|
/**
|
|
1181
|
-
* @public
|
|
1182
1182
|
* <p>The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the
|
|
1183
1183
|
* secret either automatically per the schedule or manually by a call to <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html">
|
|
1184
1184
|
* <code>RotateSecret</code>
|
|
1185
1185
|
* </a>.</p>
|
|
1186
|
+
* @public
|
|
1186
1187
|
*/
|
|
1187
1188
|
RotationLambdaARN?: string;
|
|
1188
1189
|
/**
|
|
1189
|
-
* @public
|
|
1190
1190
|
* <p>A structure that defines the rotation configuration for the secret.</p>
|
|
1191
|
+
* @public
|
|
1191
1192
|
*/
|
|
1192
1193
|
RotationRules?: RotationRulesType;
|
|
1193
1194
|
/**
|
|
1194
|
-
* @public
|
|
1195
1195
|
* <p>The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.</p>
|
|
1196
|
+
* @public
|
|
1196
1197
|
*/
|
|
1197
1198
|
LastRotatedDate?: Date;
|
|
1198
1199
|
/**
|
|
1199
|
-
* @public
|
|
1200
1200
|
* <p>The last date and time that this secret was modified in any way.</p>
|
|
1201
|
+
* @public
|
|
1201
1202
|
*/
|
|
1202
1203
|
LastChangedDate?: Date;
|
|
1203
1204
|
/**
|
|
1204
|
-
* @public
|
|
1205
1205
|
* <p>The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.</p>
|
|
1206
|
+
* @public
|
|
1206
1207
|
*/
|
|
1207
1208
|
LastAccessedDate?: Date;
|
|
1208
1209
|
/**
|
|
1209
|
-
* @public
|
|
1210
1210
|
* <p>The date and time the deletion of the secret occurred. Not present on active secrets. The
|
|
1211
1211
|
* secret can be recovered until the number of days in the recovery window has passed, as
|
|
1212
1212
|
* specified in the <code>RecoveryWindowInDays</code> parameter of the <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html">
|
|
1213
1213
|
* <code>DeleteSecret</code>
|
|
1214
1214
|
* </a> operation.</p>
|
|
1215
|
+
* @public
|
|
1215
1216
|
*/
|
|
1216
1217
|
DeletedDate?: Date;
|
|
1217
1218
|
/**
|
|
1218
|
-
* @public
|
|
1219
1219
|
* <p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.</p>
|
|
1220
|
+
* @public
|
|
1220
1221
|
*/
|
|
1221
1222
|
NextRotationDate?: Date;
|
|
1222
1223
|
/**
|
|
1223
|
-
* @public
|
|
1224
1224
|
* <p>The list of user-defined tags associated with the secret. To add tags to a
|
|
1225
1225
|
* secret, use <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html">
|
|
1226
1226
|
* <code>TagResource</code>
|
|
@@ -1228,10 +1228,10 @@ export interface SecretListEntry {
|
|
|
1228
1228
|
* To remove tags, use <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UntagResource.html">
|
|
1229
1229
|
* <code>UntagResource</code>
|
|
1230
1230
|
* </a>.</p>
|
|
1231
|
+
* @public
|
|
1231
1232
|
*/
|
|
1232
1233
|
Tags?: Tag[];
|
|
1233
1234
|
/**
|
|
1234
|
-
* @public
|
|
1235
1235
|
* <p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels and
|
|
1236
1236
|
* the <code>SecretVersionId</code> attached to each one. Staging labels are used to keep
|
|
1237
1237
|
* track of the different versions during the rotation process.</p>
|
|
@@ -1239,21 +1239,22 @@ export interface SecretListEntry {
|
|
|
1239
1239
|
* <p>A version that does not have any <code>SecretVersionStage</code> is considered
|
|
1240
1240
|
* deprecated and subject to deletion. Such versions are not included in this list.</p>
|
|
1241
1241
|
* </note>
|
|
1242
|
+
* @public
|
|
1242
1243
|
*/
|
|
1243
1244
|
SecretVersionsToStages?: Record<string, string[]>;
|
|
1244
1245
|
/**
|
|
1245
|
-
* @public
|
|
1246
1246
|
* <p>Returns the name of the service that created the secret.</p>
|
|
1247
|
+
* @public
|
|
1247
1248
|
*/
|
|
1248
1249
|
OwningService?: string;
|
|
1249
1250
|
/**
|
|
1250
|
-
* @public
|
|
1251
1251
|
* <p>The date and time when a secret was created.</p>
|
|
1252
|
+
* @public
|
|
1252
1253
|
*/
|
|
1253
1254
|
CreatedDate?: Date;
|
|
1254
1255
|
/**
|
|
1255
|
-
* @public
|
|
1256
1256
|
* <p>The Region where Secrets Manager originated the secret.</p>
|
|
1257
|
+
* @public
|
|
1257
1258
|
*/
|
|
1258
1259
|
PrimaryRegion?: string;
|
|
1259
1260
|
}
|
|
@@ -1262,17 +1263,17 @@ export interface SecretListEntry {
|
|
|
1262
1263
|
*/
|
|
1263
1264
|
export interface ListSecretsResponse {
|
|
1264
1265
|
/**
|
|
1265
|
-
* @public
|
|
1266
1266
|
* <p>A list of the secrets in the account.</p>
|
|
1267
|
+
* @public
|
|
1267
1268
|
*/
|
|
1268
1269
|
SecretList?: SecretListEntry[];
|
|
1269
1270
|
/**
|
|
1270
|
-
* @public
|
|
1271
1271
|
* <p>Secrets Manager includes this value if
|
|
1272
1272
|
* there's more output available than what is included in the current response. This can
|
|
1273
1273
|
* occur even when the response includes no values at all, such as when you ask for a filtered view
|
|
1274
1274
|
* of a long list. To get the next results, call <code>ListSecrets</code> again
|
|
1275
1275
|
* with this value.</p>
|
|
1276
|
+
* @public
|
|
1276
1277
|
*/
|
|
1277
1278
|
NextToken?: string;
|
|
1278
1279
|
}
|
|
@@ -1281,64 +1282,64 @@ export interface ListSecretsResponse {
|
|
|
1281
1282
|
*/
|
|
1282
1283
|
export interface ListSecretVersionIdsRequest {
|
|
1283
1284
|
/**
|
|
1284
|
-
* @public
|
|
1285
1285
|
* <p>The ARN or name of the secret whose versions you want to list.</p>
|
|
1286
1286
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1287
1287
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1288
|
+
* @public
|
|
1288
1289
|
*/
|
|
1289
1290
|
SecretId: string | undefined;
|
|
1290
1291
|
/**
|
|
1291
|
-
* @public
|
|
1292
1292
|
* <p>The number of results to include in the response.</p>
|
|
1293
1293
|
* <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
|
|
1294
1294
|
* To get the next results, call <code>ListSecretVersionIds</code> again with the value from <code>NextToken</code>. </p>
|
|
1295
|
+
* @public
|
|
1295
1296
|
*/
|
|
1296
1297
|
MaxResults?: number;
|
|
1297
1298
|
/**
|
|
1298
|
-
* @public
|
|
1299
1299
|
* <p>A token that indicates where the output should continue from, if a previous call
|
|
1300
1300
|
* did not show all results. To get the next results, call <code>ListSecretVersionIds</code> again with
|
|
1301
1301
|
* this value.</p>
|
|
1302
|
+
* @public
|
|
1302
1303
|
*/
|
|
1303
1304
|
NextToken?: string;
|
|
1304
1305
|
/**
|
|
1305
|
-
* @public
|
|
1306
1306
|
* <p>Specifies whether to include versions of secrets that don't have any
|
|
1307
1307
|
* staging labels attached to them. Versions without staging labels are considered deprecated and are subject to
|
|
1308
1308
|
* deletion by Secrets Manager. By default, versions without staging labels aren't included.</p>
|
|
1309
|
+
* @public
|
|
1309
1310
|
*/
|
|
1310
1311
|
IncludeDeprecated?: boolean;
|
|
1311
1312
|
}
|
|
1312
1313
|
/**
|
|
1313
|
-
* @public
|
|
1314
1314
|
* <p>A structure that contains information about one version of a secret.</p>
|
|
1315
|
+
* @public
|
|
1315
1316
|
*/
|
|
1316
1317
|
export interface SecretVersionsListEntry {
|
|
1317
1318
|
/**
|
|
1318
|
-
* @public
|
|
1319
1319
|
* <p>The unique version identifier of this version of the secret.</p>
|
|
1320
|
+
* @public
|
|
1320
1321
|
*/
|
|
1321
1322
|
VersionId?: string;
|
|
1322
1323
|
/**
|
|
1323
|
-
* @public
|
|
1324
1324
|
* <p>An array of staging labels that are currently associated with this version of the
|
|
1325
1325
|
* secret.</p>
|
|
1326
|
+
* @public
|
|
1326
1327
|
*/
|
|
1327
1328
|
VersionStages?: string[];
|
|
1328
1329
|
/**
|
|
1329
|
-
* @public
|
|
1330
1330
|
* <p>The date that this version of the secret was last accessed. Note that the resolution of
|
|
1331
1331
|
* this field is at the date level and does not include the time.</p>
|
|
1332
|
+
* @public
|
|
1332
1333
|
*/
|
|
1333
1334
|
LastAccessedDate?: Date;
|
|
1334
1335
|
/**
|
|
1335
|
-
* @public
|
|
1336
1336
|
* <p>The date and time this version of the secret was created.</p>
|
|
1337
|
+
* @public
|
|
1337
1338
|
*/
|
|
1338
1339
|
CreatedDate?: Date;
|
|
1339
1340
|
/**
|
|
1340
|
-
* @public
|
|
1341
1341
|
* <p>The KMS keys used to encrypt the secret version.</p>
|
|
1342
|
+
* @public
|
|
1342
1343
|
*/
|
|
1343
1344
|
KmsKeyIds?: string[];
|
|
1344
1345
|
}
|
|
@@ -1347,32 +1348,32 @@ export interface SecretVersionsListEntry {
|
|
|
1347
1348
|
*/
|
|
1348
1349
|
export interface ListSecretVersionIdsResponse {
|
|
1349
1350
|
/**
|
|
1350
|
-
* @public
|
|
1351
1351
|
* <p>A list of the versions of the secret.</p>
|
|
1352
|
+
* @public
|
|
1352
1353
|
*/
|
|
1353
1354
|
Versions?: SecretVersionsListEntry[];
|
|
1354
1355
|
/**
|
|
1355
|
-
* @public
|
|
1356
1356
|
* <p>Secrets Manager includes this value if there's more output available than what is included
|
|
1357
1357
|
* in the current response. This can occur even when the response includes no values at all,
|
|
1358
1358
|
* such as when you ask for a filtered view of a long list. To get the next results,
|
|
1359
1359
|
* call <code>ListSecretVersionIds</code> again with this value. </p>
|
|
1360
|
+
* @public
|
|
1360
1361
|
*/
|
|
1361
1362
|
NextToken?: string;
|
|
1362
1363
|
/**
|
|
1363
|
-
* @public
|
|
1364
1364
|
* <p>The ARN of the secret.</p>
|
|
1365
|
+
* @public
|
|
1365
1366
|
*/
|
|
1366
1367
|
ARN?: string;
|
|
1367
1368
|
/**
|
|
1368
|
-
* @public
|
|
1369
1369
|
* <p>The name of the secret.</p>
|
|
1370
|
+
* @public
|
|
1370
1371
|
*/
|
|
1371
1372
|
Name?: string;
|
|
1372
1373
|
}
|
|
1373
1374
|
/**
|
|
1374
|
-
* @public
|
|
1375
1375
|
* <p>The <code>BlockPublicPolicy</code> parameter is set to true, and the resource policy did not prevent broad access to the secret.</p>
|
|
1376
|
+
* @public
|
|
1376
1377
|
*/
|
|
1377
1378
|
export declare class PublicPolicyException extends __BaseException {
|
|
1378
1379
|
readonly name: "PublicPolicyException";
|
|
@@ -1388,22 +1389,22 @@ export declare class PublicPolicyException extends __BaseException {
|
|
|
1388
1389
|
*/
|
|
1389
1390
|
export interface PutResourcePolicyRequest {
|
|
1390
1391
|
/**
|
|
1391
|
-
* @public
|
|
1392
1392
|
* <p>The ARN or name of the secret to attach the resource-based policy.</p>
|
|
1393
1393
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1394
1394
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1395
|
+
* @public
|
|
1395
1396
|
*/
|
|
1396
1397
|
SecretId: string | undefined;
|
|
1397
1398
|
/**
|
|
1398
|
-
* @public
|
|
1399
1399
|
* <p>A JSON-formatted string for an Amazon Web Services
|
|
1400
1400
|
* resource-based policy. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions
|
|
1401
1401
|
* policy examples</a>.</p>
|
|
1402
|
+
* @public
|
|
1402
1403
|
*/
|
|
1403
1404
|
ResourcePolicy: string | undefined;
|
|
1404
1405
|
/**
|
|
1405
|
-
* @public
|
|
1406
1406
|
* <p>Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.</p>
|
|
1407
|
+
* @public
|
|
1407
1408
|
*/
|
|
1408
1409
|
BlockPublicPolicy?: boolean;
|
|
1409
1410
|
}
|
|
@@ -1412,13 +1413,13 @@ export interface PutResourcePolicyRequest {
|
|
|
1412
1413
|
*/
|
|
1413
1414
|
export interface PutResourcePolicyResponse {
|
|
1414
1415
|
/**
|
|
1415
|
-
* @public
|
|
1416
1416
|
* <p>The ARN of the secret.</p>
|
|
1417
|
+
* @public
|
|
1417
1418
|
*/
|
|
1418
1419
|
ARN?: string;
|
|
1419
1420
|
/**
|
|
1420
|
-
* @public
|
|
1421
1421
|
* <p>The name of the secret.</p>
|
|
1422
|
+
* @public
|
|
1422
1423
|
*/
|
|
1423
1424
|
Name?: string;
|
|
1424
1425
|
}
|
|
@@ -1427,15 +1428,14 @@ export interface PutResourcePolicyResponse {
|
|
|
1427
1428
|
*/
|
|
1428
1429
|
export interface PutSecretValueRequest {
|
|
1429
1430
|
/**
|
|
1430
|
-
* @public
|
|
1431
1431
|
* <p>The ARN or name of the secret to add a new version to.</p>
|
|
1432
1432
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1433
1433
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1434
1434
|
* <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
|
|
1435
|
+
* @public
|
|
1435
1436
|
*/
|
|
1436
1437
|
SecretId: string | undefined;
|
|
1437
1438
|
/**
|
|
1438
|
-
* @public
|
|
1439
1439
|
* <p>A unique identifier for the new version of the secret. </p>
|
|
1440
1440
|
* <note>
|
|
1441
1441
|
* <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. </p>
|
|
@@ -1460,27 +1460,27 @@ export interface PutSecretValueRequest {
|
|
|
1460
1460
|
* </li>
|
|
1461
1461
|
* </ul>
|
|
1462
1462
|
* <p>This value becomes the <code>VersionId</code> of the new version.</p>
|
|
1463
|
+
* @public
|
|
1463
1464
|
*/
|
|
1464
1465
|
ClientRequestToken?: string;
|
|
1465
1466
|
/**
|
|
1466
|
-
* @public
|
|
1467
1467
|
* <p>The binary data to encrypt and store in the new version of
|
|
1468
1468
|
* the secret. To use this parameter in the command-line tools, we recommend that you store your
|
|
1469
1469
|
* binary data in a file and then pass the
|
|
1470
1470
|
* contents of the file as a parameter. </p>
|
|
1471
1471
|
* <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
|
|
1472
1472
|
* <p>You can't access this value from the Secrets Manager console.</p>
|
|
1473
|
+
* @public
|
|
1473
1474
|
*/
|
|
1474
1475
|
SecretBinary?: Uint8Array;
|
|
1475
1476
|
/**
|
|
1476
|
-
* @public
|
|
1477
1477
|
* <p>The text to encrypt and store in the new version of the secret. </p>
|
|
1478
1478
|
* <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
|
|
1479
1479
|
* <p>We recommend you create the secret string as JSON key/value pairs, as shown in the example.</p>
|
|
1480
|
+
* @public
|
|
1480
1481
|
*/
|
|
1481
1482
|
SecretString?: string;
|
|
1482
1483
|
/**
|
|
1483
|
-
* @public
|
|
1484
1484
|
* <p>A list of staging labels to attach to this version of the
|
|
1485
1485
|
* secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
|
|
1486
1486
|
* <p>If you specify a staging
|
|
@@ -1491,6 +1491,7 @@ export interface PutSecretValueRequest {
|
|
|
1491
1491
|
* moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p>
|
|
1492
1492
|
* <p>If you don't include <code>VersionStages</code>, then Secrets Manager automatically
|
|
1493
1493
|
* moves the staging label <code>AWSCURRENT</code> to this version.</p>
|
|
1494
|
+
* @public
|
|
1494
1495
|
*/
|
|
1495
1496
|
VersionStages?: string[];
|
|
1496
1497
|
}
|
|
@@ -1499,25 +1500,25 @@ export interface PutSecretValueRequest {
|
|
|
1499
1500
|
*/
|
|
1500
1501
|
export interface PutSecretValueResponse {
|
|
1501
1502
|
/**
|
|
1502
|
-
* @public
|
|
1503
1503
|
* <p>The ARN of the secret.</p>
|
|
1504
|
+
* @public
|
|
1504
1505
|
*/
|
|
1505
1506
|
ARN?: string;
|
|
1506
1507
|
/**
|
|
1507
|
-
* @public
|
|
1508
1508
|
* <p>The name of the secret.</p>
|
|
1509
|
+
* @public
|
|
1509
1510
|
*/
|
|
1510
1511
|
Name?: string;
|
|
1511
1512
|
/**
|
|
1512
|
-
* @public
|
|
1513
1513
|
* <p>The unique identifier of the version of the secret.</p>
|
|
1514
|
+
* @public
|
|
1514
1515
|
*/
|
|
1515
1516
|
VersionId?: string;
|
|
1516
1517
|
/**
|
|
1517
|
-
* @public
|
|
1518
1518
|
* <p>The list of staging labels that are currently attached to this version of the secret.
|
|
1519
1519
|
* Secrets Manager uses staging labels to track a version as it progresses through the secret rotation
|
|
1520
1520
|
* process.</p>
|
|
1521
|
+
* @public
|
|
1521
1522
|
*/
|
|
1522
1523
|
VersionStages?: string[];
|
|
1523
1524
|
}
|
|
@@ -1526,13 +1527,13 @@ export interface PutSecretValueResponse {
|
|
|
1526
1527
|
*/
|
|
1527
1528
|
export interface RemoveRegionsFromReplicationRequest {
|
|
1528
1529
|
/**
|
|
1529
|
-
* @public
|
|
1530
1530
|
* <p>The ARN or name of the secret.</p>
|
|
1531
|
+
* @public
|
|
1531
1532
|
*/
|
|
1532
1533
|
SecretId: string | undefined;
|
|
1533
1534
|
/**
|
|
1534
|
-
* @public
|
|
1535
1535
|
* <p>The Regions of the replicas to remove.</p>
|
|
1536
|
+
* @public
|
|
1536
1537
|
*/
|
|
1537
1538
|
RemoveReplicaRegions: string[] | undefined;
|
|
1538
1539
|
}
|
|
@@ -1541,13 +1542,13 @@ export interface RemoveRegionsFromReplicationRequest {
|
|
|
1541
1542
|
*/
|
|
1542
1543
|
export interface RemoveRegionsFromReplicationResponse {
|
|
1543
1544
|
/**
|
|
1544
|
-
* @public
|
|
1545
1545
|
* <p>The ARN of the primary secret.</p>
|
|
1546
|
+
* @public
|
|
1546
1547
|
*/
|
|
1547
1548
|
ARN?: string;
|
|
1548
1549
|
/**
|
|
1549
|
-
* @public
|
|
1550
1550
|
* <p>The status of replicas for this secret after you remove Regions.</p>
|
|
1551
|
+
* @public
|
|
1551
1552
|
*/
|
|
1552
1553
|
ReplicationStatus?: ReplicationStatusType[];
|
|
1553
1554
|
}
|
|
@@ -1556,18 +1557,18 @@ export interface RemoveRegionsFromReplicationResponse {
|
|
|
1556
1557
|
*/
|
|
1557
1558
|
export interface ReplicateSecretToRegionsRequest {
|
|
1558
1559
|
/**
|
|
1559
|
-
* @public
|
|
1560
1560
|
* <p>The ARN or name of the secret to replicate.</p>
|
|
1561
|
+
* @public
|
|
1561
1562
|
*/
|
|
1562
1563
|
SecretId: string | undefined;
|
|
1563
1564
|
/**
|
|
1564
|
-
* @public
|
|
1565
1565
|
* <p>A list of Regions in which to replicate the secret.</p>
|
|
1566
|
+
* @public
|
|
1566
1567
|
*/
|
|
1567
1568
|
AddReplicaRegions: ReplicaRegionType[] | undefined;
|
|
1568
1569
|
/**
|
|
1569
|
-
* @public
|
|
1570
1570
|
* <p>Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.</p>
|
|
1571
|
+
* @public
|
|
1571
1572
|
*/
|
|
1572
1573
|
ForceOverwriteReplicaSecret?: boolean;
|
|
1573
1574
|
}
|
|
@@ -1576,13 +1577,13 @@ export interface ReplicateSecretToRegionsRequest {
|
|
|
1576
1577
|
*/
|
|
1577
1578
|
export interface ReplicateSecretToRegionsResponse {
|
|
1578
1579
|
/**
|
|
1579
|
-
* @public
|
|
1580
1580
|
* <p>The ARN of the primary secret.</p>
|
|
1581
|
+
* @public
|
|
1581
1582
|
*/
|
|
1582
1583
|
ARN?: string;
|
|
1583
1584
|
/**
|
|
1584
|
-
* @public
|
|
1585
1585
|
* <p>The status of replication.</p>
|
|
1586
|
+
* @public
|
|
1586
1587
|
*/
|
|
1587
1588
|
ReplicationStatus?: ReplicationStatusType[];
|
|
1588
1589
|
}
|
|
@@ -1591,10 +1592,10 @@ export interface ReplicateSecretToRegionsResponse {
|
|
|
1591
1592
|
*/
|
|
1592
1593
|
export interface RestoreSecretRequest {
|
|
1593
1594
|
/**
|
|
1594
|
-
* @public
|
|
1595
1595
|
* <p>The ARN or name of the secret to restore.</p>
|
|
1596
1596
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1597
1597
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1598
|
+
* @public
|
|
1598
1599
|
*/
|
|
1599
1600
|
SecretId: string | undefined;
|
|
1600
1601
|
}
|
|
@@ -1603,13 +1604,13 @@ export interface RestoreSecretRequest {
|
|
|
1603
1604
|
*/
|
|
1604
1605
|
export interface RestoreSecretResponse {
|
|
1605
1606
|
/**
|
|
1606
|
-
* @public
|
|
1607
1607
|
* <p>The ARN of the secret that was restored.</p>
|
|
1608
|
+
* @public
|
|
1608
1609
|
*/
|
|
1609
1610
|
ARN?: string;
|
|
1610
1611
|
/**
|
|
1611
|
-
* @public
|
|
1612
1612
|
* <p>The name of the secret that was restored.</p>
|
|
1613
|
+
* @public
|
|
1613
1614
|
*/
|
|
1614
1615
|
Name?: string;
|
|
1615
1616
|
}
|
|
@@ -1618,14 +1619,13 @@ export interface RestoreSecretResponse {
|
|
|
1618
1619
|
*/
|
|
1619
1620
|
export interface RotateSecretRequest {
|
|
1620
1621
|
/**
|
|
1621
|
-
* @public
|
|
1622
1622
|
* <p>The ARN or name of the secret to rotate.</p>
|
|
1623
1623
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1624
1624
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1625
|
+
* @public
|
|
1625
1626
|
*/
|
|
1626
1627
|
SecretId: string | undefined;
|
|
1627
1628
|
/**
|
|
1628
|
-
* @public
|
|
1629
1629
|
* <p>A unique identifier for the new version of the secret. You only need to specify this value if you implement your own retry logic and you want to
|
|
1630
1630
|
* ensure that Secrets Manager doesn't attempt to create a secret version twice.</p>
|
|
1631
1631
|
* <note>
|
|
@@ -1633,21 +1633,21 @@ export interface RotateSecretRequest {
|
|
|
1633
1633
|
* </note>
|
|
1634
1634
|
* <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
|
|
1635
1635
|
* <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p>
|
|
1636
|
+
* @public
|
|
1636
1637
|
*/
|
|
1637
1638
|
ClientRequestToken?: string;
|
|
1638
1639
|
/**
|
|
1639
|
-
* @public
|
|
1640
1640
|
* <p>For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function. </p>
|
|
1641
1641
|
* <p>For secrets that use <i>managed rotation</i>, omit this field. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html">Managed rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
|
|
1642
|
+
* @public
|
|
1642
1643
|
*/
|
|
1643
1644
|
RotationLambdaARN?: string;
|
|
1644
1645
|
/**
|
|
1645
|
-
* @public
|
|
1646
1646
|
* <p>A structure that defines the rotation configuration for this secret.</p>
|
|
1647
|
+
* @public
|
|
1647
1648
|
*/
|
|
1648
1649
|
RotationRules?: RotationRulesType;
|
|
1649
1650
|
/**
|
|
1650
|
-
* @public
|
|
1651
1651
|
* <p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
|
|
1652
1652
|
* The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>
|
|
1653
1653
|
* <p>For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
|
|
@@ -1655,6 +1655,7 @@ export interface RotateSecretRequest {
|
|
|
1655
1655
|
* <code>testSecret</code>
|
|
1656
1656
|
* step</a> of the Lambda rotation function. The test creates an <code>AWSPENDING</code> version of the secret and then removes it.</p>
|
|
1657
1657
|
* <p>By default, Secrets Manager rotates the secret immediately.</p>
|
|
1658
|
+
* @public
|
|
1658
1659
|
*/
|
|
1659
1660
|
RotateImmediately?: boolean;
|
|
1660
1661
|
}
|
|
@@ -1663,18 +1664,18 @@ export interface RotateSecretRequest {
|
|
|
1663
1664
|
*/
|
|
1664
1665
|
export interface RotateSecretResponse {
|
|
1665
1666
|
/**
|
|
1666
|
-
* @public
|
|
1667
1667
|
* <p>The ARN of the secret.</p>
|
|
1668
|
+
* @public
|
|
1668
1669
|
*/
|
|
1669
1670
|
ARN?: string;
|
|
1670
1671
|
/**
|
|
1671
|
-
* @public
|
|
1672
1672
|
* <p>The name of the secret.</p>
|
|
1673
|
+
* @public
|
|
1673
1674
|
*/
|
|
1674
1675
|
Name?: string;
|
|
1675
1676
|
/**
|
|
1676
|
-
* @public
|
|
1677
1677
|
* <p>The ID of the new version of the secret.</p>
|
|
1678
|
+
* @public
|
|
1678
1679
|
*/
|
|
1679
1680
|
VersionId?: string;
|
|
1680
1681
|
}
|
|
@@ -1683,8 +1684,8 @@ export interface RotateSecretResponse {
|
|
|
1683
1684
|
*/
|
|
1684
1685
|
export interface StopReplicationToReplicaRequest {
|
|
1685
1686
|
/**
|
|
1686
|
-
* @public
|
|
1687
1687
|
* <p>The ARN of the primary secret. </p>
|
|
1688
|
+
* @public
|
|
1688
1689
|
*/
|
|
1689
1690
|
SecretId: string | undefined;
|
|
1690
1691
|
}
|
|
@@ -1693,8 +1694,8 @@ export interface StopReplicationToReplicaRequest {
|
|
|
1693
1694
|
*/
|
|
1694
1695
|
export interface StopReplicationToReplicaResponse {
|
|
1695
1696
|
/**
|
|
1696
|
-
* @public
|
|
1697
1697
|
* <p>The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.</p>
|
|
1698
|
+
* @public
|
|
1698
1699
|
*/
|
|
1699
1700
|
ARN?: string;
|
|
1700
1701
|
}
|
|
@@ -1703,20 +1704,20 @@ export interface StopReplicationToReplicaResponse {
|
|
|
1703
1704
|
*/
|
|
1704
1705
|
export interface TagResourceRequest {
|
|
1705
1706
|
/**
|
|
1706
|
-
* @public
|
|
1707
1707
|
* <p>The identifier for the secret to attach tags to. You can specify either the
|
|
1708
1708
|
* Amazon Resource Name (ARN) or the friendly name of the secret.</p>
|
|
1709
1709
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1710
1710
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1711
|
+
* @public
|
|
1711
1712
|
*/
|
|
1712
1713
|
SecretId: string | undefined;
|
|
1713
1714
|
/**
|
|
1714
|
-
* @public
|
|
1715
1715
|
* <p>The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a <code>Key</code>
|
|
1716
1716
|
* and a <code>Value</code>.</p>
|
|
1717
1717
|
* <p>For storing multiple values, we recommend that you use a JSON text
|
|
1718
1718
|
* string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
|
|
1719
1719
|
* in the Amazon Web Services CLI User Guide.</p>
|
|
1720
|
+
* @public
|
|
1720
1721
|
*/
|
|
1721
1722
|
Tags: Tag[] | undefined;
|
|
1722
1723
|
}
|
|
@@ -1725,20 +1726,20 @@ export interface TagResourceRequest {
|
|
|
1725
1726
|
*/
|
|
1726
1727
|
export interface UntagResourceRequest {
|
|
1727
1728
|
/**
|
|
1728
|
-
* @public
|
|
1729
1729
|
* <p>The ARN or name of the secret.</p>
|
|
1730
1730
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1731
1731
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1732
|
+
* @public
|
|
1732
1733
|
*/
|
|
1733
1734
|
SecretId: string | undefined;
|
|
1734
1735
|
/**
|
|
1735
|
-
* @public
|
|
1736
1736
|
* <p>A list of tag key names to remove from the secret. You don't specify the value. Both the
|
|
1737
1737
|
* key and its associated value are removed.</p>
|
|
1738
1738
|
* <p>This parameter requires a JSON text string argument.</p>
|
|
1739
1739
|
* <p>For storing multiple values, we recommend that you use a JSON text
|
|
1740
1740
|
* string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
|
|
1741
1741
|
* in the Amazon Web Services CLI User Guide.</p>
|
|
1742
|
+
* @public
|
|
1742
1743
|
*/
|
|
1743
1744
|
TagKeys: string[] | undefined;
|
|
1744
1745
|
}
|
|
@@ -1747,14 +1748,13 @@ export interface UntagResourceRequest {
|
|
|
1747
1748
|
*/
|
|
1748
1749
|
export interface UpdateSecretRequest {
|
|
1749
1750
|
/**
|
|
1750
|
-
* @public
|
|
1751
1751
|
* <p>The ARN or name of the secret.</p>
|
|
1752
1752
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1753
1753
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1754
|
+
* @public
|
|
1754
1755
|
*/
|
|
1755
1756
|
SecretId: string | undefined;
|
|
1756
1757
|
/**
|
|
1757
|
-
* @public
|
|
1758
1758
|
* <p>If you include <code>SecretString</code> or <code>SecretBinary</code>, then Secrets Manager creates
|
|
1759
1759
|
* a new version for the secret, and this parameter specifies the unique identifier for the new
|
|
1760
1760
|
* version.</p>
|
|
@@ -1763,15 +1763,15 @@ export interface UpdateSecretRequest {
|
|
|
1763
1763
|
* </note>
|
|
1764
1764
|
* <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
|
|
1765
1765
|
* <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p>
|
|
1766
|
+
* @public
|
|
1766
1767
|
*/
|
|
1767
1768
|
ClientRequestToken?: string;
|
|
1768
1769
|
/**
|
|
1769
|
-
* @public
|
|
1770
1770
|
* <p>The description of the secret.</p>
|
|
1771
|
+
* @public
|
|
1771
1772
|
*/
|
|
1772
1773
|
Description?: string;
|
|
1773
1774
|
/**
|
|
1774
|
-
* @public
|
|
1775
1775
|
* <p>The ARN, key ID, or alias of the KMS key that Secrets Manager
|
|
1776
1776
|
* uses to encrypt new secret versions as well as any existing versions with the staging labels
|
|
1777
1777
|
* <code>AWSCURRENT</code>, <code>AWSPENDING</code>, or <code>AWSPREVIOUS</code>. If you don't have <code>kms:Encrypt</code> permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. 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>
|
|
@@ -1789,10 +1789,10 @@ export interface UpdateSecretRequest {
|
|
|
1789
1789
|
* this field. The user making the call must have permissions to both the secret and the KMS key in
|
|
1790
1790
|
* their respective accounts.</p>
|
|
1791
1791
|
* </important>
|
|
1792
|
+
* @public
|
|
1792
1793
|
*/
|
|
1793
1794
|
KmsKeyId?: string;
|
|
1794
1795
|
/**
|
|
1795
|
-
* @public
|
|
1796
1796
|
* <p>The binary data to encrypt and store in the new
|
|
1797
1797
|
* version of the secret. We recommend that you
|
|
1798
1798
|
* store your binary data in a file and then pass
|
|
@@ -1800,14 +1800,15 @@ export interface UpdateSecretRequest {
|
|
|
1800
1800
|
* <p>Either <code>SecretBinary</code> or
|
|
1801
1801
|
* <code>SecretString</code> must have a value, but not both.</p>
|
|
1802
1802
|
* <p>You can't access this parameter in the Secrets Manager console.</p>
|
|
1803
|
+
* @public
|
|
1803
1804
|
*/
|
|
1804
1805
|
SecretBinary?: Uint8Array;
|
|
1805
1806
|
/**
|
|
1806
|
-
* @public
|
|
1807
1807
|
* <p>The text data to encrypt and store in the new
|
|
1808
1808
|
* version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value. </p>
|
|
1809
1809
|
* <p>Either <code>SecretBinary</code> or <code>SecretString</code> must have
|
|
1810
1810
|
* a value, but not both. </p>
|
|
1811
|
+
* @public
|
|
1811
1812
|
*/
|
|
1812
1813
|
SecretString?: string;
|
|
1813
1814
|
}
|
|
@@ -1816,19 +1817,19 @@ export interface UpdateSecretRequest {
|
|
|
1816
1817
|
*/
|
|
1817
1818
|
export interface UpdateSecretResponse {
|
|
1818
1819
|
/**
|
|
1819
|
-
* @public
|
|
1820
1820
|
* <p>The ARN of the secret that was updated.</p>
|
|
1821
|
+
* @public
|
|
1821
1822
|
*/
|
|
1822
1823
|
ARN?: string;
|
|
1823
1824
|
/**
|
|
1824
|
-
* @public
|
|
1825
1825
|
* <p>The name of the secret that was updated.</p>
|
|
1826
|
+
* @public
|
|
1826
1827
|
*/
|
|
1827
1828
|
Name?: string;
|
|
1828
1829
|
/**
|
|
1829
|
-
* @public
|
|
1830
1830
|
* <p>If Secrets Manager created a new version of the secret during this operation, then <code>VersionId</code>
|
|
1831
1831
|
* contains the unique identifier of the new version.</p>
|
|
1832
|
+
* @public
|
|
1832
1833
|
*/
|
|
1833
1834
|
VersionId?: string;
|
|
1834
1835
|
}
|
|
@@ -1837,32 +1838,32 @@ export interface UpdateSecretResponse {
|
|
|
1837
1838
|
*/
|
|
1838
1839
|
export interface UpdateSecretVersionStageRequest {
|
|
1839
1840
|
/**
|
|
1840
|
-
* @public
|
|
1841
1841
|
* <p>The ARN or the name of the secret with the version and staging labelsto modify.</p>
|
|
1842
1842
|
* <p>For an ARN, we recommend that you specify a complete ARN rather
|
|
1843
1843
|
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
|
|
1844
|
+
* @public
|
|
1844
1845
|
*/
|
|
1845
1846
|
SecretId: string | undefined;
|
|
1846
1847
|
/**
|
|
1847
|
-
* @public
|
|
1848
1848
|
* <p>The staging label to add to this version.</p>
|
|
1849
|
+
* @public
|
|
1849
1850
|
*/
|
|
1850
1851
|
VersionStage: string | undefined;
|
|
1851
1852
|
/**
|
|
1852
|
-
* @public
|
|
1853
1853
|
* <p>The ID of the version that the staging label is to be removed
|
|
1854
1854
|
* from. If the staging label you are trying to attach to one version is already attached to a
|
|
1855
1855
|
* different version, then you must include this parameter and specify the version that the label
|
|
1856
1856
|
* is to be removed from. If the label is attached and you either do not specify this parameter,
|
|
1857
1857
|
* or the version ID does not match, then the operation fails.</p>
|
|
1858
|
+
* @public
|
|
1858
1859
|
*/
|
|
1859
1860
|
RemoveFromVersionId?: string;
|
|
1860
1861
|
/**
|
|
1861
|
-
* @public
|
|
1862
1862
|
* <p>The ID of the version to add the staging label to. To
|
|
1863
1863
|
* remove a label from a version, then do not specify this parameter.</p>
|
|
1864
1864
|
* <p>If the staging label is already attached to a different version of the secret, then you
|
|
1865
1865
|
* must also specify the <code>RemoveFromVersionId</code> parameter. </p>
|
|
1866
|
+
* @public
|
|
1866
1867
|
*/
|
|
1867
1868
|
MoveToVersionId?: string;
|
|
1868
1869
|
}
|
|
@@ -1871,13 +1872,13 @@ export interface UpdateSecretVersionStageRequest {
|
|
|
1871
1872
|
*/
|
|
1872
1873
|
export interface UpdateSecretVersionStageResponse {
|
|
1873
1874
|
/**
|
|
1874
|
-
* @public
|
|
1875
1875
|
* <p>The ARN of the secret that was updated.</p>
|
|
1876
|
+
* @public
|
|
1876
1877
|
*/
|
|
1877
1878
|
ARN?: string;
|
|
1878
1879
|
/**
|
|
1879
|
-
* @public
|
|
1880
1880
|
* <p>The name of the secret that was updated.</p>
|
|
1881
|
+
* @public
|
|
1881
1882
|
*/
|
|
1882
1883
|
Name?: string;
|
|
1883
1884
|
}
|
|
@@ -1886,31 +1887,31 @@ export interface UpdateSecretVersionStageResponse {
|
|
|
1886
1887
|
*/
|
|
1887
1888
|
export interface ValidateResourcePolicyRequest {
|
|
1888
1889
|
/**
|
|
1889
|
-
* @public
|
|
1890
1890
|
* <p>This field is reserved for internal use.</p>
|
|
1891
|
+
* @public
|
|
1891
1892
|
*/
|
|
1892
1893
|
SecretId?: string;
|
|
1893
1894
|
/**
|
|
1894
|
-
* @public
|
|
1895
1895
|
* <p>A JSON-formatted string that contains an Amazon Web Services
|
|
1896
1896
|
* resource-based policy. The policy in the string identifies who can access or manage this
|
|
1897
1897
|
* secret and its versions. For example policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
|
|
1898
|
+
* @public
|
|
1898
1899
|
*/
|
|
1899
1900
|
ResourcePolicy: string | undefined;
|
|
1900
1901
|
}
|
|
1901
1902
|
/**
|
|
1902
|
-
* @public
|
|
1903
1903
|
* <p>Displays errors that occurred during validation of the resource policy.</p>
|
|
1904
|
+
* @public
|
|
1904
1905
|
*/
|
|
1905
1906
|
export interface ValidationErrorsEntry {
|
|
1906
1907
|
/**
|
|
1907
|
-
* @public
|
|
1908
1908
|
* <p>Checks the name of the policy.</p>
|
|
1909
|
+
* @public
|
|
1909
1910
|
*/
|
|
1910
1911
|
CheckName?: string;
|
|
1911
1912
|
/**
|
|
1912
|
-
* @public
|
|
1913
1913
|
* <p>Displays error messages if validation encounters problems during validation of the resource policy.</p>
|
|
1914
|
+
* @public
|
|
1914
1915
|
*/
|
|
1915
1916
|
ErrorMessage?: string;
|
|
1916
1917
|
}
|
|
@@ -1919,13 +1920,13 @@ export interface ValidationErrorsEntry {
|
|
|
1919
1920
|
*/
|
|
1920
1921
|
export interface ValidateResourcePolicyResponse {
|
|
1921
1922
|
/**
|
|
1922
|
-
* @public
|
|
1923
1923
|
* <p>True if your policy passes validation, otherwise false.</p>
|
|
1924
|
+
* @public
|
|
1924
1925
|
*/
|
|
1925
1926
|
PolicyValidationPassed?: boolean;
|
|
1926
1927
|
/**
|
|
1927
|
-
* @public
|
|
1928
1928
|
* <p>Validation errors if your policy didn't pass validation.</p>
|
|
1929
|
+
* @public
|
|
1929
1930
|
*/
|
|
1930
1931
|
ValidationErrors?: ValidationErrorsEntry[];
|
|
1931
1932
|
}
|