@aws-sdk/client-secrets-manager 3.686.0 → 3.691.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.
@@ -9,12 +9,12 @@ export interface ReplicaRegionType {
9
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
10
  * @public
11
11
  */
12
- Region?: string;
12
+ Region?: string | undefined;
13
13
  /**
14
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
15
  * @public
16
16
  */
17
- KmsKeyId?: string;
17
+ KmsKeyId?: string | undefined;
18
18
  }
19
19
  /**
20
20
  * <p>The error Secrets Manager encountered while retrieving an individual secret as part of <a>BatchGetSecretValue</a>.</p>
@@ -25,17 +25,17 @@ export interface APIErrorType {
25
25
  * <p>The ARN or name of the secret.</p>
26
26
  * @public
27
27
  */
28
- SecretId?: string;
28
+ SecretId?: string | undefined;
29
29
  /**
30
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
31
  * @public
32
32
  */
33
- ErrorCode?: string;
33
+ ErrorCode?: string | undefined;
34
34
  /**
35
35
  * <p>A message describing the error.</p>
36
36
  * @public
37
37
  */
38
- Message?: string;
38
+ Message?: string | undefined;
39
39
  }
40
40
  /**
41
41
  * @public
@@ -93,13 +93,13 @@ export interface Filter {
93
93
  * </ul>
94
94
  * @public
95
95
  */
96
- Key?: FilterNameStringType;
96
+ Key?: FilterNameStringType | undefined;
97
97
  /**
98
98
  * <p>The keyword to filter for.</p>
99
99
  * <p>You can prefix your search value with an exclamation mark (<code>!</code>) in order to perform negation filters. </p>
100
100
  * @public
101
101
  */
102
- Values?: string[];
102
+ Values?: string[] | undefined;
103
103
  }
104
104
  /**
105
105
  * @public
@@ -109,12 +109,12 @@ export interface BatchGetSecretValueRequest {
109
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
110
  * @public
111
111
  */
112
- SecretIdList?: string[];
112
+ SecretIdList?: string[] | undefined;
113
113
  /**
114
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
115
  * @public
116
116
  */
117
- Filters?: Filter[];
117
+ Filters?: Filter[] | undefined;
118
118
  /**
119
119
  * <p>The number of results to include in the response.</p>
120
120
  * <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
@@ -122,14 +122,14 @@ export interface BatchGetSecretValueRequest {
122
122
  * <code>NextToken</code>. To use this parameter, you must also use the <code>Filters</code> parameter.</p>
123
123
  * @public
124
124
  */
125
- MaxResults?: number;
125
+ MaxResults?: number | undefined;
126
126
  /**
127
127
  * <p>A token that indicates where the output should continue from, if a
128
128
  * previous call did not show all results. To get the next results, call <code>BatchGetSecretValue</code> again
129
129
  * with this value.</p>
130
130
  * @public
131
131
  */
132
- NextToken?: string;
132
+ NextToken?: string | undefined;
133
133
  }
134
134
  /**
135
135
  * <p>A structure that contains the secret value and other details for a secret.</p>
@@ -140,17 +140,17 @@ export interface SecretValueEntry {
140
140
  * <p>The Amazon Resource Name (ARN) of the secret.</p>
141
141
  * @public
142
142
  */
143
- ARN?: string;
143
+ ARN?: string | undefined;
144
144
  /**
145
145
  * <p>The friendly name of the secret. </p>
146
146
  * @public
147
147
  */
148
- Name?: string;
148
+ Name?: string | undefined;
149
149
  /**
150
150
  * <p>The unique version identifier of this version of the secret.</p>
151
151
  * @public
152
152
  */
153
- VersionId?: string;
153
+ VersionId?: string | undefined;
154
154
  /**
155
155
  * <p>The decrypted secret value, if the secret value was originally provided as
156
156
  * binary data in the form of a byte array. The parameter represents the binary data as
@@ -158,24 +158,24 @@ export interface SecretValueEntry {
158
158
  * string.</p>
159
159
  * @public
160
160
  */
161
- SecretBinary?: Uint8Array;
161
+ SecretBinary?: Uint8Array | undefined;
162
162
  /**
163
163
  * <p>The decrypted secret value, if the secret value was originally provided as a string or
164
164
  * through the Secrets Manager console.</p>
165
165
  * @public
166
166
  */
167
- SecretString?: string;
167
+ SecretString?: string | undefined;
168
168
  /**
169
169
  * <p>A list of all of the staging labels currently attached to this version of the
170
170
  * secret.</p>
171
171
  * @public
172
172
  */
173
- VersionStages?: string[];
173
+ VersionStages?: string[] | undefined;
174
174
  /**
175
175
  * <p>The date the secret was created.</p>
176
176
  * @public
177
177
  */
178
- CreatedDate?: Date;
178
+ CreatedDate?: Date | undefined;
179
179
  }
180
180
  /**
181
181
  * @public
@@ -185,7 +185,7 @@ export interface BatchGetSecretValueResponse {
185
185
  * <p>A list of secret values.</p>
186
186
  * @public
187
187
  */
188
- SecretValues?: SecretValueEntry[];
188
+ SecretValues?: SecretValueEntry[] | undefined;
189
189
  /**
190
190
  * <p>Secrets Manager includes this value if
191
191
  * there's more output available than what is included in the current response. This can
@@ -194,12 +194,12 @@ export interface BatchGetSecretValueResponse {
194
194
  * with this value.</p>
195
195
  * @public
196
196
  */
197
- NextToken?: string;
197
+ NextToken?: string | undefined;
198
198
  /**
199
199
  * <p>A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.</p>
200
200
  * @public
201
201
  */
202
- Errors?: APIErrorType[];
202
+ Errors?: APIErrorType[] | undefined;
203
203
  }
204
204
  /**
205
205
  * <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
@@ -208,7 +208,7 @@ export interface BatchGetSecretValueResponse {
208
208
  export declare class DecryptionFailure extends __BaseException {
209
209
  readonly name: "DecryptionFailure";
210
210
  readonly $fault: "client";
211
- Message?: string;
211
+ Message?: string | undefined;
212
212
  /**
213
213
  * @internal
214
214
  */
@@ -221,7 +221,7 @@ export declare class DecryptionFailure extends __BaseException {
221
221
  export declare class InternalServiceError extends __BaseException {
222
222
  readonly name: "InternalServiceError";
223
223
  readonly $fault: "server";
224
- Message?: string;
224
+ Message?: string | undefined;
225
225
  /**
226
226
  * @internal
227
227
  */
@@ -234,7 +234,7 @@ export declare class InternalServiceError extends __BaseException {
234
234
  export declare class InvalidNextTokenException extends __BaseException {
235
235
  readonly name: "InvalidNextTokenException";
236
236
  readonly $fault: "client";
237
- Message?: string;
237
+ Message?: string | undefined;
238
238
  /**
239
239
  * @internal
240
240
  */
@@ -247,7 +247,7 @@ export declare class InvalidNextTokenException extends __BaseException {
247
247
  export declare class InvalidParameterException extends __BaseException {
248
248
  readonly name: "InvalidParameterException";
249
249
  readonly $fault: "client";
250
- Message?: string;
250
+ Message?: string | undefined;
251
251
  /**
252
252
  * @internal
253
253
  */
@@ -275,7 +275,7 @@ export declare class InvalidParameterException extends __BaseException {
275
275
  export declare class InvalidRequestException extends __BaseException {
276
276
  readonly name: "InvalidRequestException";
277
277
  readonly $fault: "client";
278
- Message?: string;
278
+ Message?: string | undefined;
279
279
  /**
280
280
  * @internal
281
281
  */
@@ -288,7 +288,7 @@ export declare class InvalidRequestException extends __BaseException {
288
288
  export declare class ResourceNotFoundException extends __BaseException {
289
289
  readonly name: "ResourceNotFoundException";
290
290
  readonly $fault: "client";
291
- Message?: string;
291
+ Message?: string | undefined;
292
292
  /**
293
293
  * @internal
294
294
  */
@@ -314,12 +314,12 @@ export interface CancelRotateSecretResponse {
314
314
  * <p>The ARN of the secret.</p>
315
315
  * @public
316
316
  */
317
- ARN?: string;
317
+ ARN?: string | undefined;
318
318
  /**
319
319
  * <p>The name of the secret.</p>
320
320
  * @public
321
321
  */
322
- Name?: string;
322
+ Name?: string | undefined;
323
323
  /**
324
324
  * <p>The unique identifier of the version of the secret created during the rotation. This
325
325
  * version might not be complete, and should be evaluated for possible deletion. We recommend
@@ -328,7 +328,7 @@ export interface CancelRotateSecretResponse {
328
328
  * starting future rotations.</p>
329
329
  * @public
330
330
  */
331
- VersionId?: string;
331
+ VersionId?: string | undefined;
332
332
  }
333
333
  /**
334
334
  * <p>A structure that contains information about a tag.</p>
@@ -339,12 +339,12 @@ export interface Tag {
339
339
  * <p>The key identifier, or name, of the tag.</p>
340
340
  * @public
341
341
  */
342
- Key?: string;
342
+ Key?: string | undefined;
343
343
  /**
344
344
  * <p>The string value associated with the key of the tag.</p>
345
345
  * @public
346
346
  */
347
- Value?: string;
347
+ Value?: string | undefined;
348
348
  }
349
349
  /**
350
350
  * @public
@@ -389,12 +389,12 @@ export interface CreateSecretRequest {
389
389
  * <p>This value becomes the <code>VersionId</code> of the new version.</p>
390
390
  * @public
391
391
  */
392
- ClientRequestToken?: string;
392
+ ClientRequestToken?: string | undefined;
393
393
  /**
394
394
  * <p>The description of the secret.</p>
395
395
  * @public
396
396
  */
397
- Description?: string;
397
+ Description?: string | undefined;
398
398
  /**
399
399
  * <p>The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
400
400
  * encrypt the secret value in the secret. An alias is always prefixed by <code>alias/</code>,
@@ -408,7 +408,7 @@ export interface CreateSecretRequest {
408
408
  * and use a customer managed KMS key. </p>
409
409
  * @public
410
410
  */
411
- KmsKeyId?: string;
411
+ KmsKeyId?: string | undefined;
412
412
  /**
413
413
  * <p>The binary data to encrypt and store in the new version of
414
414
  * the secret. We recommend that you store your binary data in a file and then pass the
@@ -419,7 +419,7 @@ export interface CreateSecretRequest {
419
419
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
420
420
  * @public
421
421
  */
422
- SecretBinary?: Uint8Array;
422
+ SecretBinary?: Uint8Array | undefined;
423
423
  /**
424
424
  * <p>The text data to encrypt and store in this new version of
425
425
  * the secret. We recommend you use a JSON structure of key/value pairs for your secret value.</p>
@@ -431,7 +431,7 @@ export interface CreateSecretRequest {
431
431
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
432
432
  * @public
433
433
  */
434
- SecretString?: string;
434
+ SecretString?: string | undefined;
435
435
  /**
436
436
  * <p>A list of tags to attach to the secret. Each tag
437
437
  * is a key and value pair of strings in a JSON text string, for example:</p>
@@ -454,18 +454,18 @@ export interface CreateSecretRequest {
454
454
  * Reference guide</i>.</p>
455
455
  * @public
456
456
  */
457
- Tags?: Tag[];
457
+ Tags?: Tag[] | undefined;
458
458
  /**
459
459
  * <p>A list of Regions and KMS keys to replicate secrets.</p>
460
460
  * @public
461
461
  */
462
- AddReplicaRegions?: ReplicaRegionType[];
462
+ AddReplicaRegions?: ReplicaRegionType[] | undefined;
463
463
  /**
464
464
  * <p>Specifies whether to overwrite a secret with the same name in the
465
465
  * destination Region. By default, secrets aren't overwritten.</p>
466
466
  * @public
467
467
  */
468
- ForceOverwriteReplicaSecret?: boolean;
468
+ ForceOverwriteReplicaSecret?: boolean | undefined;
469
469
  }
470
470
  /**
471
471
  * @public
@@ -489,28 +489,28 @@ export interface ReplicationStatusType {
489
489
  * <p>The Region where replication occurs.</p>
490
490
  * @public
491
491
  */
492
- Region?: string;
492
+ Region?: string | undefined;
493
493
  /**
494
494
  * <p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>
495
495
  * @public
496
496
  */
497
- KmsKeyId?: string;
497
+ KmsKeyId?: string | undefined;
498
498
  /**
499
499
  * <p>The status can be <code>InProgress</code>, <code>Failed</code>, or <code>InSync</code>.</p>
500
500
  * @public
501
501
  */
502
- Status?: StatusType;
502
+ Status?: StatusType | undefined;
503
503
  /**
504
504
  * <p>Status message such as "<i>Secret with this name already exists in this
505
505
  * region</i>".</p>
506
506
  * @public
507
507
  */
508
- StatusMessage?: string;
508
+ StatusMessage?: string | undefined;
509
509
  /**
510
510
  * <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>
511
511
  * @public
512
512
  */
513
- LastAccessedDate?: Date;
513
+ LastAccessedDate?: Date | undefined;
514
514
  }
515
515
  /**
516
516
  * @public
@@ -523,17 +523,17 @@ export interface CreateSecretResponse {
523
523
  * are different.</p>
524
524
  * @public
525
525
  */
526
- ARN?: string;
526
+ ARN?: string | undefined;
527
527
  /**
528
528
  * <p>The name of the new secret.</p>
529
529
  * @public
530
530
  */
531
- Name?: string;
531
+ Name?: string | undefined;
532
532
  /**
533
533
  * <p>The unique identifier associated with the version of the new secret.</p>
534
534
  * @public
535
535
  */
536
- VersionId?: string;
536
+ VersionId?: string | undefined;
537
537
  /**
538
538
  * <p>A list of the replicas of this secret and their status:</p>
539
539
  * <ul>
@@ -552,7 +552,7 @@ export interface CreateSecretResponse {
552
552
  * </ul>
553
553
  * @public
554
554
  */
555
- ReplicationStatus?: ReplicationStatusType[];
555
+ ReplicationStatus?: ReplicationStatusType[] | undefined;
556
556
  }
557
557
  /**
558
558
  * <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
@@ -563,7 +563,7 @@ export interface CreateSecretResponse {
563
563
  export declare class EncryptionFailure extends __BaseException {
564
564
  readonly name: "EncryptionFailure";
565
565
  readonly $fault: "client";
566
- Message?: string;
566
+ Message?: string | undefined;
567
567
  /**
568
568
  * @internal
569
569
  */
@@ -576,7 +576,7 @@ export declare class EncryptionFailure extends __BaseException {
576
576
  export declare class LimitExceededException extends __BaseException {
577
577
  readonly name: "LimitExceededException";
578
578
  readonly $fault: "client";
579
- Message?: string;
579
+ Message?: string | undefined;
580
580
  /**
581
581
  * @internal
582
582
  */
@@ -589,7 +589,7 @@ export declare class LimitExceededException extends __BaseException {
589
589
  export declare class MalformedPolicyDocumentException extends __BaseException {
590
590
  readonly name: "MalformedPolicyDocumentException";
591
591
  readonly $fault: "client";
592
- Message?: string;
592
+ Message?: string | undefined;
593
593
  /**
594
594
  * @internal
595
595
  */
@@ -602,7 +602,7 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
602
602
  export declare class PreconditionNotMetException extends __BaseException {
603
603
  readonly name: "PreconditionNotMetException";
604
604
  readonly $fault: "client";
605
- Message?: string;
605
+ Message?: string | undefined;
606
606
  /**
607
607
  * @internal
608
608
  */
@@ -615,7 +615,7 @@ export declare class PreconditionNotMetException extends __BaseException {
615
615
  export declare class ResourceExistsException extends __BaseException {
616
616
  readonly name: "ResourceExistsException";
617
617
  readonly $fault: "client";
618
- Message?: string;
618
+ Message?: string | undefined;
619
619
  /**
620
620
  * @internal
621
621
  */
@@ -641,12 +641,12 @@ export interface DeleteResourcePolicyResponse {
641
641
  * <p>The ARN of the secret that the resource-based policy was deleted for.</p>
642
642
  * @public
643
643
  */
644
- ARN?: string;
644
+ ARN?: string | undefined;
645
645
  /**
646
646
  * <p>The name of the secret that the resource-based policy was deleted for.</p>
647
647
  * @public
648
648
  */
649
- Name?: string;
649
+ Name?: string | undefined;
650
650
  }
651
651
  /**
652
652
  * @public
@@ -665,7 +665,7 @@ export interface DeleteSecretRequest {
665
665
  * in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.</p>
666
666
  * @public
667
667
  */
668
- RecoveryWindowInDays?: number;
668
+ RecoveryWindowInDays?: number | undefined;
669
669
  /**
670
670
  * <p>Specifies whether to delete the secret without any recovery window. You
671
671
  * can't use both this parameter and <code>RecoveryWindowInDays</code> in the same
@@ -683,7 +683,7 @@ export interface DeleteSecretRequest {
683
683
  * </important>
684
684
  * @public
685
685
  */
686
- ForceDeleteWithoutRecovery?: boolean;
686
+ ForceDeleteWithoutRecovery?: boolean | undefined;
687
687
  }
688
688
  /**
689
689
  * @public
@@ -693,19 +693,19 @@ export interface DeleteSecretResponse {
693
693
  * <p>The ARN of the secret.</p>
694
694
  * @public
695
695
  */
696
- ARN?: string;
696
+ ARN?: string | undefined;
697
697
  /**
698
698
  * <p>The name of the secret.</p>
699
699
  * @public
700
700
  */
701
- Name?: string;
701
+ Name?: string | undefined;
702
702
  /**
703
703
  * <p>The date and time after which this secret Secrets Manager can permanently delete this secret,
704
704
  * and it can no longer be restored. This value is the date and time of the delete request
705
705
  * plus the number of days in <code>RecoveryWindowInDays</code>.</p>
706
706
  * @public
707
707
  */
708
- DeletionDate?: Date;
708
+ DeletionDate?: Date | undefined;
709
709
  }
710
710
  /**
711
711
  * @public
@@ -737,7 +737,7 @@ export interface RotationRulesType {
737
737
  * <code>ScheduleExpression</code>.</p>
738
738
  * @public
739
739
  */
740
- AutomaticallyAfterDays?: number;
740
+ AutomaticallyAfterDays?: number | undefined;
741
741
  /**
742
742
  * <p>The length of the rotation window in hours, for example <code>3h</code> for a three
743
743
  * hour window. Secrets Manager rotates your secret at any time during this window. The window must not
@@ -749,7 +749,7 @@ export interface RotationRulesType {
749
749
  * in Secrets Manager rotation</a> in the <i>Secrets Manager Users Guide</i>.</p>
750
750
  * @public
751
751
  */
752
- Duration?: string;
752
+ Duration?: string | undefined;
753
753
  /**
754
754
  * <p>A <code>cron()</code> or <code>rate()</code> expression that defines the schedule for
755
755
  * rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.</p>
@@ -771,7 +771,7 @@ export interface RotationRulesType {
771
771
  * rotation window must not extend into the next UTC day or into the next rotation window.</p>
772
772
  * @public
773
773
  */
774
- ScheduleExpression?: string;
774
+ ScheduleExpression?: string | undefined;
775
775
  }
776
776
  /**
777
777
  * @public
@@ -781,60 +781,60 @@ export interface DescribeSecretResponse {
781
781
  * <p>The ARN of the secret.</p>
782
782
  * @public
783
783
  */
784
- ARN?: string;
784
+ ARN?: string | undefined;
785
785
  /**
786
786
  * <p>The name of the secret.</p>
787
787
  * @public
788
788
  */
789
- Name?: string;
789
+ Name?: string | undefined;
790
790
  /**
791
791
  * <p>The description of the secret.</p>
792
792
  * @public
793
793
  */
794
- Description?: string;
794
+ Description?: string | undefined;
795
795
  /**
796
796
  * <p>The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
797
797
  * If the secret is encrypted with the Amazon Web Services managed key <code>aws/secretsmanager</code>,
798
798
  * this field is omitted. Secrets created using the console use an KMS key ID.</p>
799
799
  * @public
800
800
  */
801
- KmsKeyId?: string;
801
+ KmsKeyId?: string | undefined;
802
802
  /**
803
803
  * <p>Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.</p>
804
804
  * <p>To turn on rotation, use <a>RotateSecret</a>. To turn off
805
805
  * rotation, use <a>CancelRotateSecret</a>.</p>
806
806
  * @public
807
807
  */
808
- RotationEnabled?: boolean;
808
+ RotationEnabled?: boolean | undefined;
809
809
  /**
810
810
  * <p>The ARN of the Lambda function that Secrets Manager invokes to rotate the
811
811
  * secret. </p>
812
812
  * @public
813
813
  */
814
- RotationLambdaARN?: string;
814
+ RotationLambdaARN?: string | undefined;
815
815
  /**
816
816
  * <p>The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but
817
817
  * it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had
818
818
  * rotation turned on, this field is omitted.</p>
819
819
  * @public
820
820
  */
821
- RotationRules?: RotationRulesType;
821
+ RotationRules?: RotationRulesType | undefined;
822
822
  /**
823
823
  * <p>The last date and time that Secrets Manager rotated the secret.
824
824
  * If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.</p>
825
825
  * @public
826
826
  */
827
- LastRotatedDate?: Date;
827
+ LastRotatedDate?: Date | undefined;
828
828
  /**
829
829
  * <p>The last date and time that this secret was modified in any way.</p>
830
830
  * @public
831
831
  */
832
- LastChangedDate?: Date;
832
+ LastChangedDate?: Date | undefined;
833
833
  /**
834
834
  * <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>
835
835
  * @public
836
836
  */
837
- LastAccessedDate?: Date;
837
+ LastAccessedDate?: Date | undefined;
838
838
  /**
839
839
  * <p>The date the secret is scheduled for deletion. If it is not scheduled for deletion, this
840
840
  * field is omitted. When you delete a secret, Secrets Manager requires a
@@ -844,19 +844,19 @@ export interface DescribeSecretResponse {
844
844
  * value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use <a>RestoreSecret</a>.</p>
845
845
  * @public
846
846
  */
847
- DeletedDate?: Date;
847
+ DeletedDate?: Date | undefined;
848
848
  /**
849
849
  * <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>
850
850
  * <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>
851
851
  * @public
852
852
  */
853
- NextRotationDate?: Date;
853
+ NextRotationDate?: Date | undefined;
854
854
  /**
855
855
  * <p>The list of tags attached to the secret. To add tags to a
856
856
  * secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>
857
857
  * @public
858
858
  */
859
- Tags?: Tag[];
859
+ Tags?: Tag[] | undefined;
860
860
  /**
861
861
  * <p>A list of the versions of the secret that have staging labels attached.
862
862
  * Versions that don't have staging labels are considered deprecated and Secrets Manager
@@ -885,22 +885,22 @@ export interface DescribeSecretResponse {
885
885
  * <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>
886
886
  * @public
887
887
  */
888
- VersionIdsToStages?: Record<string, string[]>;
888
+ VersionIdsToStages?: Record<string, string[]> | undefined;
889
889
  /**
890
890
  * <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>
891
891
  * @public
892
892
  */
893
- OwningService?: string;
893
+ OwningService?: string | undefined;
894
894
  /**
895
895
  * <p>The date the secret was created.</p>
896
896
  * @public
897
897
  */
898
- CreatedDate?: Date;
898
+ CreatedDate?: Date | undefined;
899
899
  /**
900
900
  * <p>The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in <code>ReplicationStatus</code>. </p>
901
901
  * @public
902
902
  */
903
- PrimaryRegion?: string;
903
+ PrimaryRegion?: string | undefined;
904
904
  /**
905
905
  * <p>A list of the replicas of this secret and their status: </p>
906
906
  * <ul>
@@ -919,7 +919,7 @@ export interface DescribeSecretResponse {
919
919
  * </ul>
920
920
  * @public
921
921
  */
922
- ReplicationStatus?: ReplicationStatusType[];
922
+ ReplicationStatus?: ReplicationStatusType[] | undefined;
923
923
  }
924
924
  /**
925
925
  * @public
@@ -930,49 +930,49 @@ export interface GetRandomPasswordRequest {
930
930
  * default length is 32 characters.</p>
931
931
  * @public
932
932
  */
933
- PasswordLength?: number;
933
+ PasswordLength?: number | undefined;
934
934
  /**
935
935
  * <p>A string of the characters that you don't want in the password.</p>
936
936
  * @public
937
937
  */
938
- ExcludeCharacters?: string;
938
+ ExcludeCharacters?: string | undefined;
939
939
  /**
940
940
  * <p>Specifies whether to exclude numbers from the password. If you don't
941
941
  * include this switch, the password can contain numbers.</p>
942
942
  * @public
943
943
  */
944
- ExcludeNumbers?: boolean;
944
+ ExcludeNumbers?: boolean | undefined;
945
945
  /**
946
946
  * <p>Specifies whether to exclude the following punctuation characters from the password:
947
947
  * <code>! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` \{ | \} ~</code>.
948
948
  * If you don't include this switch, the password can contain punctuation.</p>
949
949
  * @public
950
950
  */
951
- ExcludePunctuation?: boolean;
951
+ ExcludePunctuation?: boolean | undefined;
952
952
  /**
953
953
  * <p>Specifies whether to exclude uppercase letters from the password. If you
954
954
  * don't include this switch, the password can contain uppercase letters.</p>
955
955
  * @public
956
956
  */
957
- ExcludeUppercase?: boolean;
957
+ ExcludeUppercase?: boolean | undefined;
958
958
  /**
959
959
  * <p>Specifies whether to exclude lowercase letters from the password. If
960
960
  * you don't include this switch, the password can contain lowercase letters.</p>
961
961
  * @public
962
962
  */
963
- ExcludeLowercase?: boolean;
963
+ ExcludeLowercase?: boolean | undefined;
964
964
  /**
965
965
  * <p>Specifies whether to include the space character. If you
966
966
  * include this switch, the password can contain space characters.</p>
967
967
  * @public
968
968
  */
969
- IncludeSpace?: boolean;
969
+ IncludeSpace?: boolean | undefined;
970
970
  /**
971
971
  * <p>Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
972
972
  * If you don't include this switch, the password contains at least one of every character type.</p>
973
973
  * @public
974
974
  */
975
- RequireEachIncludedType?: boolean;
975
+ RequireEachIncludedType?: boolean | undefined;
976
976
  }
977
977
  /**
978
978
  * @public
@@ -982,7 +982,7 @@ export interface GetRandomPasswordResponse {
982
982
  * <p>A string with the password.</p>
983
983
  * @public
984
984
  */
985
- RandomPassword?: string;
985
+ RandomPassword?: string | undefined;
986
986
  }
987
987
  /**
988
988
  * @public
@@ -1004,19 +1004,19 @@ export interface GetResourcePolicyResponse {
1004
1004
  * <p>The ARN of the secret that the resource-based policy was retrieved for.</p>
1005
1005
  * @public
1006
1006
  */
1007
- ARN?: string;
1007
+ ARN?: string | undefined;
1008
1008
  /**
1009
1009
  * <p>The name of the secret that the resource-based policy was retrieved for.</p>
1010
1010
  * @public
1011
1011
  */
1012
- Name?: string;
1012
+ Name?: string | undefined;
1013
1013
  /**
1014
1014
  * <p>A JSON-formatted string that contains the permissions policy
1015
1015
  * 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
1016
1016
  * Secrets Manager</a>.</p>
1017
1017
  * @public
1018
1018
  */
1019
- ResourcePolicy?: string;
1019
+ ResourcePolicy?: string | undefined;
1020
1020
  }
1021
1021
  /**
1022
1022
  * @public
@@ -1038,7 +1038,7 @@ export interface GetSecretValueRequest {
1038
1038
  * 32 hexadecimal digits.</p>
1039
1039
  * @public
1040
1040
  */
1041
- VersionId?: string;
1041
+ VersionId?: string | undefined;
1042
1042
  /**
1043
1043
  * <p>The staging label of the version of the secret to retrieve. </p>
1044
1044
  * <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process.
@@ -1047,7 +1047,7 @@ export interface GetSecretValueRequest {
1047
1047
  * <code>VersionId</code>, Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
1048
1048
  * @public
1049
1049
  */
1050
- VersionStage?: string;
1050
+ VersionStage?: string | undefined;
1051
1051
  }
1052
1052
  /**
1053
1053
  * @public
@@ -1057,17 +1057,17 @@ export interface GetSecretValueResponse {
1057
1057
  * <p>The ARN of the secret.</p>
1058
1058
  * @public
1059
1059
  */
1060
- ARN?: string;
1060
+ ARN?: string | undefined;
1061
1061
  /**
1062
1062
  * <p>The friendly name of the secret.</p>
1063
1063
  * @public
1064
1064
  */
1065
- Name?: string;
1065
+ Name?: string | undefined;
1066
1066
  /**
1067
1067
  * <p>The unique identifier of this version of the secret.</p>
1068
1068
  * @public
1069
1069
  */
1070
- VersionId?: string;
1070
+ VersionId?: string | undefined;
1071
1071
  /**
1072
1072
  * <p>The decrypted secret value, if the secret value was originally provided as
1073
1073
  * 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>
@@ -1077,7 +1077,7 @@ export interface GetSecretValueResponse {
1077
1077
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1078
1078
  * @public
1079
1079
  */
1080
- SecretBinary?: Uint8Array;
1080
+ SecretBinary?: Uint8Array | undefined;
1081
1081
  /**
1082
1082
  * <p>The decrypted secret value, if the secret value was originally provided as a string or
1083
1083
  * through the Secrets Manager console.</p>
@@ -1086,20 +1086,20 @@ export interface GetSecretValueResponse {
1086
1086
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1087
1087
  * @public
1088
1088
  */
1089
- SecretString?: string;
1089
+ SecretString?: string | undefined;
1090
1090
  /**
1091
1091
  * <p>A list of all of the staging labels currently attached to this version of the
1092
1092
  * secret.</p>
1093
1093
  * @public
1094
1094
  */
1095
- VersionStages?: string[];
1095
+ VersionStages?: string[] | undefined;
1096
1096
  /**
1097
1097
  * <p>The date and time that this version of the secret was created. If you don't specify
1098
1098
  * which version in <code>VersionId</code> or <code>VersionStage</code>, then Secrets Manager uses the
1099
1099
  * <code>AWSCURRENT</code> version.</p>
1100
1100
  * @public
1101
1101
  */
1102
- CreatedDate?: Date;
1102
+ CreatedDate?: Date | undefined;
1103
1103
  }
1104
1104
  /**
1105
1105
  * @public
@@ -1121,7 +1121,7 @@ export interface ListSecretsRequest {
1121
1121
  * <p>Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.</p>
1122
1122
  * @public
1123
1123
  */
1124
- IncludePlannedDeletion?: boolean;
1124
+ IncludePlannedDeletion?: boolean | undefined;
1125
1125
  /**
1126
1126
  * <p>The number of results to include in the response.</p>
1127
1127
  * <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
@@ -1129,24 +1129,24 @@ export interface ListSecretsRequest {
1129
1129
  * <code>NextToken</code>.</p>
1130
1130
  * @public
1131
1131
  */
1132
- MaxResults?: number;
1132
+ MaxResults?: number | undefined;
1133
1133
  /**
1134
1134
  * <p>A token that indicates where the output should continue from, if a
1135
1135
  * previous call did not show all results. To get the next results, call <code>ListSecrets</code> again
1136
1136
  * with this value.</p>
1137
1137
  * @public
1138
1138
  */
1139
- NextToken?: string;
1139
+ NextToken?: string | undefined;
1140
1140
  /**
1141
1141
  * <p>The filters to apply to the list of secrets.</p>
1142
1142
  * @public
1143
1143
  */
1144
- Filters?: Filter[];
1144
+ Filters?: Filter[] | undefined;
1145
1145
  /**
1146
1146
  * <p>Secrets are listed by <code>CreatedDate</code>. </p>
1147
1147
  * @public
1148
1148
  */
1149
- SortOrder?: SortOrderType;
1149
+ SortOrder?: SortOrderType | undefined;
1150
1150
  }
1151
1151
  /**
1152
1152
  * <p>A structure that contains the details about a secret. It does not include the encrypted
@@ -1160,28 +1160,28 @@ export interface SecretListEntry {
1160
1160
  * <p>The Amazon Resource Name (ARN) of the secret.</p>
1161
1161
  * @public
1162
1162
  */
1163
- ARN?: string;
1163
+ ARN?: string | undefined;
1164
1164
  /**
1165
1165
  * <p>The friendly name of the secret. </p>
1166
1166
  * @public
1167
1167
  */
1168
- Name?: string;
1168
+ Name?: string | undefined;
1169
1169
  /**
1170
1170
  * <p>The user-provided description of the secret.</p>
1171
1171
  * @public
1172
1172
  */
1173
- Description?: string;
1173
+ Description?: string | undefined;
1174
1174
  /**
1175
1175
  * <p>The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with
1176
1176
  * the Amazon Web Services managed key <code>aws/secretsmanager</code>, this field is omitted.</p>
1177
1177
  * @public
1178
1178
  */
1179
- KmsKeyId?: string;
1179
+ KmsKeyId?: string | undefined;
1180
1180
  /**
1181
1181
  * <p>Indicates whether automatic, scheduled rotation is enabled for this secret.</p>
1182
1182
  * @public
1183
1183
  */
1184
- RotationEnabled?: boolean;
1184
+ RotationEnabled?: boolean | undefined;
1185
1185
  /**
1186
1186
  * <p>The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the
1187
1187
  * 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">
@@ -1189,27 +1189,27 @@ export interface SecretListEntry {
1189
1189
  * </a>.</p>
1190
1190
  * @public
1191
1191
  */
1192
- RotationLambdaARN?: string;
1192
+ RotationLambdaARN?: string | undefined;
1193
1193
  /**
1194
1194
  * <p>A structure that defines the rotation configuration for the secret.</p>
1195
1195
  * @public
1196
1196
  */
1197
- RotationRules?: RotationRulesType;
1197
+ RotationRules?: RotationRulesType | undefined;
1198
1198
  /**
1199
1199
  * <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>
1200
1200
  * @public
1201
1201
  */
1202
- LastRotatedDate?: Date;
1202
+ LastRotatedDate?: Date | undefined;
1203
1203
  /**
1204
1204
  * <p>The last date and time that this secret was modified in any way.</p>
1205
1205
  * @public
1206
1206
  */
1207
- LastChangedDate?: Date;
1207
+ LastChangedDate?: Date | undefined;
1208
1208
  /**
1209
1209
  * <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>
1210
1210
  * @public
1211
1211
  */
1212
- LastAccessedDate?: Date;
1212
+ LastAccessedDate?: Date | undefined;
1213
1213
  /**
1214
1214
  * <p>The date and time the deletion of the secret occurred. Not present on active secrets. The
1215
1215
  * secret can be recovered until the number of days in the recovery window has passed, as
@@ -1218,12 +1218,12 @@ export interface SecretListEntry {
1218
1218
  * </a> operation.</p>
1219
1219
  * @public
1220
1220
  */
1221
- DeletedDate?: Date;
1221
+ DeletedDate?: Date | undefined;
1222
1222
  /**
1223
1223
  * <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>
1224
1224
  * @public
1225
1225
  */
1226
- NextRotationDate?: Date;
1226
+ NextRotationDate?: Date | undefined;
1227
1227
  /**
1228
1228
  * <p>The list of user-defined tags associated with the secret. To add tags to a
1229
1229
  * secret, use <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html">
@@ -1234,7 +1234,7 @@ export interface SecretListEntry {
1234
1234
  * </a>.</p>
1235
1235
  * @public
1236
1236
  */
1237
- Tags?: Tag[];
1237
+ Tags?: Tag[] | undefined;
1238
1238
  /**
1239
1239
  * <p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels and
1240
1240
  * the <code>SecretVersionId</code> attached to each one. Staging labels are used to keep
@@ -1245,22 +1245,22 @@ export interface SecretListEntry {
1245
1245
  * </note>
1246
1246
  * @public
1247
1247
  */
1248
- SecretVersionsToStages?: Record<string, string[]>;
1248
+ SecretVersionsToStages?: Record<string, string[]> | undefined;
1249
1249
  /**
1250
1250
  * <p>Returns the name of the service that created the secret.</p>
1251
1251
  * @public
1252
1252
  */
1253
- OwningService?: string;
1253
+ OwningService?: string | undefined;
1254
1254
  /**
1255
1255
  * <p>The date and time when a secret was created.</p>
1256
1256
  * @public
1257
1257
  */
1258
- CreatedDate?: Date;
1258
+ CreatedDate?: Date | undefined;
1259
1259
  /**
1260
1260
  * <p>The Region where Secrets Manager originated the secret.</p>
1261
1261
  * @public
1262
1262
  */
1263
- PrimaryRegion?: string;
1263
+ PrimaryRegion?: string | undefined;
1264
1264
  }
1265
1265
  /**
1266
1266
  * @public
@@ -1270,7 +1270,7 @@ export interface ListSecretsResponse {
1270
1270
  * <p>A list of the secrets in the account.</p>
1271
1271
  * @public
1272
1272
  */
1273
- SecretList?: SecretListEntry[];
1273
+ SecretList?: SecretListEntry[] | undefined;
1274
1274
  /**
1275
1275
  * <p>Secrets Manager includes this value if
1276
1276
  * there's more output available than what is included in the current response. This can
@@ -1279,7 +1279,7 @@ export interface ListSecretsResponse {
1279
1279
  * with this value.</p>
1280
1280
  * @public
1281
1281
  */
1282
- NextToken?: string;
1282
+ NextToken?: string | undefined;
1283
1283
  }
1284
1284
  /**
1285
1285
  * @public
@@ -1298,21 +1298,21 @@ export interface ListSecretVersionIdsRequest {
1298
1298
  * To get the next results, call <code>ListSecretVersionIds</code> again with the value from <code>NextToken</code>. </p>
1299
1299
  * @public
1300
1300
  */
1301
- MaxResults?: number;
1301
+ MaxResults?: number | undefined;
1302
1302
  /**
1303
1303
  * <p>A token that indicates where the output should continue from, if a previous call
1304
1304
  * did not show all results. To get the next results, call <code>ListSecretVersionIds</code> again with
1305
1305
  * this value.</p>
1306
1306
  * @public
1307
1307
  */
1308
- NextToken?: string;
1308
+ NextToken?: string | undefined;
1309
1309
  /**
1310
1310
  * <p>Specifies whether to include versions of secrets that don't have any
1311
1311
  * staging labels attached to them. Versions without staging labels are considered deprecated and are subject to
1312
1312
  * deletion by Secrets Manager. By default, versions without staging labels aren't included.</p>
1313
1313
  * @public
1314
1314
  */
1315
- IncludeDeprecated?: boolean;
1315
+ IncludeDeprecated?: boolean | undefined;
1316
1316
  }
1317
1317
  /**
1318
1318
  * <p>A structure that contains information about one version of a secret.</p>
@@ -1323,29 +1323,29 @@ export interface SecretVersionsListEntry {
1323
1323
  * <p>The unique version identifier of this version of the secret.</p>
1324
1324
  * @public
1325
1325
  */
1326
- VersionId?: string;
1326
+ VersionId?: string | undefined;
1327
1327
  /**
1328
1328
  * <p>An array of staging labels that are currently associated with this version of the
1329
1329
  * secret.</p>
1330
1330
  * @public
1331
1331
  */
1332
- VersionStages?: string[];
1332
+ VersionStages?: string[] | undefined;
1333
1333
  /**
1334
1334
  * <p>The date that this version of the secret was last accessed. Note that the resolution of
1335
1335
  * this field is at the date level and does not include the time.</p>
1336
1336
  * @public
1337
1337
  */
1338
- LastAccessedDate?: Date;
1338
+ LastAccessedDate?: Date | undefined;
1339
1339
  /**
1340
1340
  * <p>The date and time this version of the secret was created.</p>
1341
1341
  * @public
1342
1342
  */
1343
- CreatedDate?: Date;
1343
+ CreatedDate?: Date | undefined;
1344
1344
  /**
1345
1345
  * <p>The KMS keys used to encrypt the secret version.</p>
1346
1346
  * @public
1347
1347
  */
1348
- KmsKeyIds?: string[];
1348
+ KmsKeyIds?: string[] | undefined;
1349
1349
  }
1350
1350
  /**
1351
1351
  * @public
@@ -1355,7 +1355,7 @@ export interface ListSecretVersionIdsResponse {
1355
1355
  * <p>A list of the versions of the secret.</p>
1356
1356
  * @public
1357
1357
  */
1358
- Versions?: SecretVersionsListEntry[];
1358
+ Versions?: SecretVersionsListEntry[] | undefined;
1359
1359
  /**
1360
1360
  * <p>Secrets Manager includes this value if there's more output available than what is included
1361
1361
  * in the current response. This can occur even when the response includes no values at all,
@@ -1363,17 +1363,17 @@ export interface ListSecretVersionIdsResponse {
1363
1363
  * call <code>ListSecretVersionIds</code> again with this value. </p>
1364
1364
  * @public
1365
1365
  */
1366
- NextToken?: string;
1366
+ NextToken?: string | undefined;
1367
1367
  /**
1368
1368
  * <p>The ARN of the secret.</p>
1369
1369
  * @public
1370
1370
  */
1371
- ARN?: string;
1371
+ ARN?: string | undefined;
1372
1372
  /**
1373
1373
  * <p>The name of the secret.</p>
1374
1374
  * @public
1375
1375
  */
1376
- Name?: string;
1376
+ Name?: string | undefined;
1377
1377
  }
1378
1378
  /**
1379
1379
  * <p>The <code>BlockPublicPolicy</code> parameter is set to true, and the resource policy did not prevent broad access to the secret.</p>
@@ -1382,7 +1382,7 @@ export interface ListSecretVersionIdsResponse {
1382
1382
  export declare class PublicPolicyException extends __BaseException {
1383
1383
  readonly name: "PublicPolicyException";
1384
1384
  readonly $fault: "client";
1385
- Message?: string;
1385
+ Message?: string | undefined;
1386
1386
  /**
1387
1387
  * @internal
1388
1388
  */
@@ -1422,7 +1422,7 @@ export interface PutResourcePolicyRequest {
1422
1422
  * </important>
1423
1423
  * @public
1424
1424
  */
1425
- BlockPublicPolicy?: boolean;
1425
+ BlockPublicPolicy?: boolean | undefined;
1426
1426
  }
1427
1427
  /**
1428
1428
  * @public
@@ -1432,12 +1432,12 @@ export interface PutResourcePolicyResponse {
1432
1432
  * <p>The ARN of the secret.</p>
1433
1433
  * @public
1434
1434
  */
1435
- ARN?: string;
1435
+ ARN?: string | undefined;
1436
1436
  /**
1437
1437
  * <p>The name of the secret.</p>
1438
1438
  * @public
1439
1439
  */
1440
- Name?: string;
1440
+ Name?: string | undefined;
1441
1441
  }
1442
1442
  /**
1443
1443
  * @public
@@ -1478,7 +1478,7 @@ export interface PutSecretValueRequest {
1478
1478
  * <p>This value becomes the <code>VersionId</code> of the new version.</p>
1479
1479
  * @public
1480
1480
  */
1481
- ClientRequestToken?: string;
1481
+ ClientRequestToken?: string | undefined;
1482
1482
  /**
1483
1483
  * <p>The binary data to encrypt and store in the new version of
1484
1484
  * the secret. To use this parameter in the command-line tools, we recommend that you store your
@@ -1489,7 +1489,7 @@ export interface PutSecretValueRequest {
1489
1489
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1490
1490
  * @public
1491
1491
  */
1492
- SecretBinary?: Uint8Array;
1492
+ SecretBinary?: Uint8Array | undefined;
1493
1493
  /**
1494
1494
  * <p>The text to encrypt and store in the new version of the secret. </p>
1495
1495
  * <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
@@ -1497,7 +1497,7 @@ export interface PutSecretValueRequest {
1497
1497
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1498
1498
  * @public
1499
1499
  */
1500
- SecretString?: string;
1500
+ SecretString?: string | undefined;
1501
1501
  /**
1502
1502
  * <p>A list of staging labels to attach to this version of the
1503
1503
  * secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
@@ -1511,13 +1511,13 @@ export interface PutSecretValueRequest {
1511
1511
  * moves the staging label <code>AWSCURRENT</code> to this version.</p>
1512
1512
  * @public
1513
1513
  */
1514
- VersionStages?: string[];
1514
+ VersionStages?: string[] | undefined;
1515
1515
  /**
1516
1516
  * <p>A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">How rotation works</a>.</p>
1517
1517
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1518
1518
  * @public
1519
1519
  */
1520
- RotationToken?: string;
1520
+ RotationToken?: string | undefined;
1521
1521
  }
1522
1522
  /**
1523
1523
  * @public
@@ -1527,24 +1527,24 @@ export interface PutSecretValueResponse {
1527
1527
  * <p>The ARN of the secret.</p>
1528
1528
  * @public
1529
1529
  */
1530
- ARN?: string;
1530
+ ARN?: string | undefined;
1531
1531
  /**
1532
1532
  * <p>The name of the secret.</p>
1533
1533
  * @public
1534
1534
  */
1535
- Name?: string;
1535
+ Name?: string | undefined;
1536
1536
  /**
1537
1537
  * <p>The unique identifier of the version of the secret.</p>
1538
1538
  * @public
1539
1539
  */
1540
- VersionId?: string;
1540
+ VersionId?: string | undefined;
1541
1541
  /**
1542
1542
  * <p>The list of staging labels that are currently attached to this version of the secret.
1543
1543
  * Secrets Manager uses staging labels to track a version as it progresses through the secret rotation
1544
1544
  * process.</p>
1545
1545
  * @public
1546
1546
  */
1547
- VersionStages?: string[];
1547
+ VersionStages?: string[] | undefined;
1548
1548
  }
1549
1549
  /**
1550
1550
  * @public
@@ -1569,12 +1569,12 @@ export interface RemoveRegionsFromReplicationResponse {
1569
1569
  * <p>The ARN of the primary secret.</p>
1570
1570
  * @public
1571
1571
  */
1572
- ARN?: string;
1572
+ ARN?: string | undefined;
1573
1573
  /**
1574
1574
  * <p>The status of replicas for this secret after you remove Regions.</p>
1575
1575
  * @public
1576
1576
  */
1577
- ReplicationStatus?: ReplicationStatusType[];
1577
+ ReplicationStatus?: ReplicationStatusType[] | undefined;
1578
1578
  }
1579
1579
  /**
1580
1580
  * @public
@@ -1594,7 +1594,7 @@ export interface ReplicateSecretToRegionsRequest {
1594
1594
  * <p>Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.</p>
1595
1595
  * @public
1596
1596
  */
1597
- ForceOverwriteReplicaSecret?: boolean;
1597
+ ForceOverwriteReplicaSecret?: boolean | undefined;
1598
1598
  }
1599
1599
  /**
1600
1600
  * @public
@@ -1604,12 +1604,12 @@ export interface ReplicateSecretToRegionsResponse {
1604
1604
  * <p>The ARN of the primary secret.</p>
1605
1605
  * @public
1606
1606
  */
1607
- ARN?: string;
1607
+ ARN?: string | undefined;
1608
1608
  /**
1609
1609
  * <p>The status of replication.</p>
1610
1610
  * @public
1611
1611
  */
1612
- ReplicationStatus?: ReplicationStatusType[];
1612
+ ReplicationStatus?: ReplicationStatusType[] | undefined;
1613
1613
  }
1614
1614
  /**
1615
1615
  * @public
@@ -1631,12 +1631,12 @@ export interface RestoreSecretResponse {
1631
1631
  * <p>The ARN of the secret that was restored.</p>
1632
1632
  * @public
1633
1633
  */
1634
- ARN?: string;
1634
+ ARN?: string | undefined;
1635
1635
  /**
1636
1636
  * <p>The name of the secret that was restored.</p>
1637
1637
  * @public
1638
1638
  */
1639
- Name?: string;
1639
+ Name?: string | undefined;
1640
1640
  }
1641
1641
  /**
1642
1642
  * @public
@@ -1659,18 +1659,18 @@ export interface RotateSecretRequest {
1659
1659
  * <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>
1660
1660
  * @public
1661
1661
  */
1662
- ClientRequestToken?: string;
1662
+ ClientRequestToken?: string | undefined;
1663
1663
  /**
1664
1664
  * <p>For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function. </p>
1665
1665
  * <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>
1666
1666
  * @public
1667
1667
  */
1668
- RotationLambdaARN?: string;
1668
+ RotationLambdaARN?: string | undefined;
1669
1669
  /**
1670
1670
  * <p>A structure that defines the rotation configuration for this secret.</p>
1671
1671
  * @public
1672
1672
  */
1673
- RotationRules?: RotationRulesType;
1673
+ RotationRules?: RotationRulesType | undefined;
1674
1674
  /**
1675
1675
  * <p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
1676
1676
  * The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>
@@ -1681,7 +1681,7 @@ export interface RotateSecretRequest {
1681
1681
  * <p>By default, Secrets Manager rotates the secret immediately.</p>
1682
1682
  * @public
1683
1683
  */
1684
- RotateImmediately?: boolean;
1684
+ RotateImmediately?: boolean | undefined;
1685
1685
  }
1686
1686
  /**
1687
1687
  * @public
@@ -1691,17 +1691,17 @@ export interface RotateSecretResponse {
1691
1691
  * <p>The ARN of the secret.</p>
1692
1692
  * @public
1693
1693
  */
1694
- ARN?: string;
1694
+ ARN?: string | undefined;
1695
1695
  /**
1696
1696
  * <p>The name of the secret.</p>
1697
1697
  * @public
1698
1698
  */
1699
- Name?: string;
1699
+ Name?: string | undefined;
1700
1700
  /**
1701
1701
  * <p>The ID of the new version of the secret.</p>
1702
1702
  * @public
1703
1703
  */
1704
- VersionId?: string;
1704
+ VersionId?: string | undefined;
1705
1705
  }
1706
1706
  /**
1707
1707
  * @public
@@ -1721,7 +1721,7 @@ export interface StopReplicationToReplicaResponse {
1721
1721
  * <p>The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.</p>
1722
1722
  * @public
1723
1723
  */
1724
- ARN?: string;
1724
+ ARN?: string | undefined;
1725
1725
  }
1726
1726
  /**
1727
1727
  * @public
@@ -1789,12 +1789,12 @@ export interface UpdateSecretRequest {
1789
1789
  * <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>
1790
1790
  * @public
1791
1791
  */
1792
- ClientRequestToken?: string;
1792
+ ClientRequestToken?: string | undefined;
1793
1793
  /**
1794
1794
  * <p>The description of the secret.</p>
1795
1795
  * @public
1796
1796
  */
1797
- Description?: string;
1797
+ Description?: string | undefined;
1798
1798
  /**
1799
1799
  * <p>The ARN, key ID, or alias of the KMS key that Secrets Manager
1800
1800
  * uses to encrypt new secret versions as well as any existing versions with the staging labels
@@ -1815,7 +1815,7 @@ export interface UpdateSecretRequest {
1815
1815
  * </important>
1816
1816
  * @public
1817
1817
  */
1818
- KmsKeyId?: string;
1818
+ KmsKeyId?: string | undefined;
1819
1819
  /**
1820
1820
  * <p>The binary data to encrypt and store in the new
1821
1821
  * version of the secret. We recommend that you
@@ -1827,7 +1827,7 @@ export interface UpdateSecretRequest {
1827
1827
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1828
1828
  * @public
1829
1829
  */
1830
- SecretBinary?: Uint8Array;
1830
+ SecretBinary?: Uint8Array | undefined;
1831
1831
  /**
1832
1832
  * <p>The text data to encrypt and store in the new
1833
1833
  * version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value. </p>
@@ -1836,7 +1836,7 @@ export interface UpdateSecretRequest {
1836
1836
  * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1837
1837
  * @public
1838
1838
  */
1839
- SecretString?: string;
1839
+ SecretString?: string | undefined;
1840
1840
  }
1841
1841
  /**
1842
1842
  * @public
@@ -1846,18 +1846,18 @@ export interface UpdateSecretResponse {
1846
1846
  * <p>The ARN of the secret that was updated.</p>
1847
1847
  * @public
1848
1848
  */
1849
- ARN?: string;
1849
+ ARN?: string | undefined;
1850
1850
  /**
1851
1851
  * <p>The name of the secret that was updated.</p>
1852
1852
  * @public
1853
1853
  */
1854
- Name?: string;
1854
+ Name?: string | undefined;
1855
1855
  /**
1856
1856
  * <p>If Secrets Manager created a new version of the secret during this operation, then <code>VersionId</code>
1857
1857
  * contains the unique identifier of the new version.</p>
1858
1858
  * @public
1859
1859
  */
1860
- VersionId?: string;
1860
+ VersionId?: string | undefined;
1861
1861
  }
1862
1862
  /**
1863
1863
  * @public
@@ -1883,7 +1883,7 @@ export interface UpdateSecretVersionStageRequest {
1883
1883
  * or the version ID does not match, then the operation fails.</p>
1884
1884
  * @public
1885
1885
  */
1886
- RemoveFromVersionId?: string;
1886
+ RemoveFromVersionId?: string | undefined;
1887
1887
  /**
1888
1888
  * <p>The ID of the version to add the staging label to. To
1889
1889
  * remove a label from a version, then do not specify this parameter.</p>
@@ -1891,7 +1891,7 @@ export interface UpdateSecretVersionStageRequest {
1891
1891
  * must also specify the <code>RemoveFromVersionId</code> parameter. </p>
1892
1892
  * @public
1893
1893
  */
1894
- MoveToVersionId?: string;
1894
+ MoveToVersionId?: string | undefined;
1895
1895
  }
1896
1896
  /**
1897
1897
  * @public
@@ -1901,12 +1901,12 @@ export interface UpdateSecretVersionStageResponse {
1901
1901
  * <p>The ARN of the secret that was updated.</p>
1902
1902
  * @public
1903
1903
  */
1904
- ARN?: string;
1904
+ ARN?: string | undefined;
1905
1905
  /**
1906
1906
  * <p>The name of the secret that was updated.</p>
1907
1907
  * @public
1908
1908
  */
1909
- Name?: string;
1909
+ Name?: string | undefined;
1910
1910
  }
1911
1911
  /**
1912
1912
  * @public
@@ -1916,7 +1916,7 @@ export interface ValidateResourcePolicyRequest {
1916
1916
  * <p>The ARN or name of the secret with the resource-based policy you want to validate.</p>
1917
1917
  * @public
1918
1918
  */
1919
- SecretId?: string;
1919
+ SecretId?: string | undefined;
1920
1920
  /**
1921
1921
  * <p>A JSON-formatted string that contains an Amazon Web Services
1922
1922
  * resource-based policy. The policy in the string identifies who can access or manage this
@@ -1934,12 +1934,12 @@ export interface ValidationErrorsEntry {
1934
1934
  * <p>Checks the name of the policy.</p>
1935
1935
  * @public
1936
1936
  */
1937
- CheckName?: string;
1937
+ CheckName?: string | undefined;
1938
1938
  /**
1939
1939
  * <p>Displays error messages if validation encounters problems during validation of the resource policy.</p>
1940
1940
  * @public
1941
1941
  */
1942
- ErrorMessage?: string;
1942
+ ErrorMessage?: string | undefined;
1943
1943
  }
1944
1944
  /**
1945
1945
  * @public
@@ -1949,12 +1949,12 @@ export interface ValidateResourcePolicyResponse {
1949
1949
  * <p>True if your policy passes validation, otherwise false.</p>
1950
1950
  * @public
1951
1951
  */
1952
- PolicyValidationPassed?: boolean;
1952
+ PolicyValidationPassed?: boolean | undefined;
1953
1953
  /**
1954
1954
  * <p>Validation errors if your policy didn't pass validation.</p>
1955
1955
  * @public
1956
1956
  */
1957
- ValidationErrors?: ValidationErrorsEntry[];
1957
+ ValidationErrors?: ValidationErrorsEntry[] | undefined;
1958
1958
  }
1959
1959
  /**
1960
1960
  * @internal