forked from aws/aws-sdk-js-v3
/
models_0.ts
3636 lines (3189 loc) · 99.7 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { MetadataBearer as $MetadataBearer } from "@aws-sdk/types";
import { AccessAnalyzerServiceException as __BaseException } from "./AccessAnalyzerServiceException";
/**
* <p>You do not have sufficient access to perform this action.</p>
*/
export class AccessDeniedException extends __BaseException {
readonly name: "AccessDeniedException" = "AccessDeniedException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>) {
super({
name: "AccessDeniedException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AccessDeniedException.prototype);
}
}
/**
* <p>A conflict exception error.</p>
*/
export class ConflictException extends __BaseException {
readonly name: "ConflictException" = "ConflictException";
readonly $fault: "client" = "client";
/**
* <p>The ID of the resource.</p>
*/
resourceId: string | undefined;
/**
* <p>The resource type.</p>
*/
resourceType: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>) {
super({
name: "ConflictException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ConflictException.prototype);
this.resourceId = opts.resourceId;
this.resourceType = opts.resourceType;
}
}
/**
* <p>The criteria to use in the filter that defines the archive rule.</p>
*/
export interface Criterion {
/**
* <p>An "equals" operator to match for the filter used to create the rule.</p>
*/
eq?: string[];
/**
* <p>A "not equals" operator to match for the filter used to create the rule.</p>
*/
neq?: string[];
/**
* <p>A "contains" operator to match for the filter used to create the rule.</p>
*/
contains?: string[];
/**
* <p>An "exists" operator to match for the filter used to create the rule. </p>
*/
exists?: boolean;
}
export namespace Criterion {
/**
* @internal
*/
export const filterSensitiveLog = (obj: Criterion): any => ({
...obj,
});
}
/**
* <p>Creates an archive rule.</p>
*/
export interface CreateArchiveRuleRequest {
/**
* <p>The name of the created analyzer.</p>
*/
analyzerName: string | undefined;
/**
* <p>The name of the rule to create.</p>
*/
ruleName: string | undefined;
/**
* <p>The criteria for the rule.</p>
*/
filter: { [key: string]: Criterion } | undefined;
/**
* <p>A client token.</p>
*/
clientToken?: string;
}
export namespace CreateArchiveRuleRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CreateArchiveRuleRequest): any => ({
...obj,
});
}
/**
* <p>Internal server error.</p>
*/
export class InternalServerException extends __BaseException {
readonly name: "InternalServerException" = "InternalServerException";
readonly $fault: "server" = "server";
$retryable = {};
/**
* <p>The seconds to wait to retry.</p>
*/
retryAfterSeconds?: number;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>) {
super({
name: "InternalServerException",
$fault: "server",
...opts,
});
Object.setPrototypeOf(this, InternalServerException.prototype);
this.retryAfterSeconds = opts.retryAfterSeconds;
}
}
/**
* <p>The specified resource could not be found.</p>
*/
export class ResourceNotFoundException extends __BaseException {
readonly name: "ResourceNotFoundException" = "ResourceNotFoundException";
readonly $fault: "client" = "client";
/**
* <p>The ID of the resource.</p>
*/
resourceId: string | undefined;
/**
* <p>The type of the resource.</p>
*/
resourceType: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>) {
super({
name: "ResourceNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
this.resourceId = opts.resourceId;
this.resourceType = opts.resourceType;
}
}
/**
* <p>Service quote met error.</p>
*/
export class ServiceQuotaExceededException extends __BaseException {
readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException";
readonly $fault: "client" = "client";
/**
* <p>The resource ID.</p>
*/
resourceId: string | undefined;
/**
* <p>The resource type.</p>
*/
resourceType: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) {
super({
name: "ServiceQuotaExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
this.resourceId = opts.resourceId;
this.resourceType = opts.resourceType;
}
}
/**
* <p>Throttling limit exceeded error.</p>
*/
export class ThrottlingException extends __BaseException {
readonly name: "ThrottlingException" = "ThrottlingException";
readonly $fault: "client" = "client";
$retryable = {
throttling: true,
};
/**
* <p>The seconds to wait to retry.</p>
*/
retryAfterSeconds?: number;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>) {
super({
name: "ThrottlingException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ThrottlingException.prototype);
this.retryAfterSeconds = opts.retryAfterSeconds;
}
}
/**
* <p>Contains information about a validation exception.</p>
*/
export interface ValidationExceptionField {
/**
* <p>The name of the validation exception.</p>
*/
name: string | undefined;
/**
* <p>A message about the validation exception.</p>
*/
message: string | undefined;
}
export namespace ValidationExceptionField {
/**
* @internal
*/
export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({
...obj,
});
}
export enum ValidationExceptionReason {
CANNOT_PARSE = "cannotParse",
FIELD_VALIDATION_FAILED = "fieldValidationFailed",
OTHER = "other",
UNKNOWN_OPERATION = "unknownOperation",
}
/**
* <p>Validation exception error.</p>
*/
export class ValidationException extends __BaseException {
readonly name: "ValidationException" = "ValidationException";
readonly $fault: "client" = "client";
/**
* <p>The reason for the exception.</p>
*/
reason: ValidationExceptionReason | string | undefined;
/**
* <p>A list of fields that didn't validate.</p>
*/
fieldList?: ValidationExceptionField[];
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>) {
super({
name: "ValidationException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ValidationException.prototype);
this.reason = opts.reason;
this.fieldList = opts.fieldList;
}
}
/**
* <p>Deletes an archive rule.</p>
*/
export interface DeleteArchiveRuleRequest {
/**
* <p>The name of the analyzer that associated with the archive rule to delete.</p>
*/
analyzerName: string | undefined;
/**
* <p>The name of the rule to delete.</p>
*/
ruleName: string | undefined;
/**
* <p>A client token.</p>
*/
clientToken?: string;
}
export namespace DeleteArchiveRuleRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: DeleteArchiveRuleRequest): any => ({
...obj,
});
}
/**
* <p>Retrieves an archive rule.</p>
*/
export interface GetArchiveRuleRequest {
/**
* <p>The name of the analyzer to retrieve rules from.</p>
*/
analyzerName: string | undefined;
/**
* <p>The name of the rule to retrieve.</p>
*/
ruleName: string | undefined;
}
export namespace GetArchiveRuleRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: GetArchiveRuleRequest): any => ({
...obj,
});
}
/**
* <p>Contains information about an archive rule.</p>
*/
export interface ArchiveRuleSummary {
/**
* <p>The name of the archive rule.</p>
*/
ruleName: string | undefined;
/**
* <p>A filter used to define the archive rule.</p>
*/
filter: { [key: string]: Criterion } | undefined;
/**
* <p>The time at which the archive rule was created.</p>
*/
createdAt: Date | undefined;
/**
* <p>The time at which the archive rule was last updated.</p>
*/
updatedAt: Date | undefined;
}
export namespace ArchiveRuleSummary {
/**
* @internal
*/
export const filterSensitiveLog = (obj: ArchiveRuleSummary): any => ({
...obj,
});
}
/**
* <p>The response to the request.</p>
*/
export interface GetArchiveRuleResponse {
/**
* <p>Contains information about an archive rule.</p>
*/
archiveRule: ArchiveRuleSummary | undefined;
}
export namespace GetArchiveRuleResponse {
/**
* @internal
*/
export const filterSensitiveLog = (obj: GetArchiveRuleResponse): any => ({
...obj,
});
}
/**
* <p>Retrieves a list of archive rules created for the specified analyzer.</p>
*/
export interface ListArchiveRulesRequest {
/**
* <p>The name of the analyzer to retrieve rules from.</p>
*/
analyzerName: string | undefined;
/**
* <p>A token used for pagination of results returned.</p>
*/
nextToken?: string;
/**
* <p>The maximum number of results to return in the request.</p>
*/
maxResults?: number;
}
export namespace ListArchiveRulesRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: ListArchiveRulesRequest): any => ({
...obj,
});
}
/**
* <p>The response to the request.</p>
*/
export interface ListArchiveRulesResponse {
/**
* <p>A list of archive rules created for the specified analyzer.</p>
*/
archiveRules: ArchiveRuleSummary[] | undefined;
/**
* <p>A token used for pagination of results returned.</p>
*/
nextToken?: string;
}
export namespace ListArchiveRulesResponse {
/**
* @internal
*/
export const filterSensitiveLog = (obj: ListArchiveRulesResponse): any => ({
...obj,
});
}
/**
* <p>Updates the specified archive rule.</p>
*/
export interface UpdateArchiveRuleRequest {
/**
* <p>The name of the analyzer to update the archive rules for.</p>
*/
analyzerName: string | undefined;
/**
* <p>The name of the rule to update.</p>
*/
ruleName: string | undefined;
/**
* <p>A filter to match for the rules to update. Only rules that match the filter are
* updated.</p>
*/
filter: { [key: string]: Criterion } | undefined;
/**
* <p>A client token.</p>
*/
clientToken?: string;
}
export namespace UpdateArchiveRuleRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: UpdateArchiveRuleRequest): any => ({
...obj,
});
}
/**
* <p>An criterion statement in an archive rule. Each archive rule may have multiple
* criteria.</p>
*/
export interface InlineArchiveRule {
/**
* <p>The name of the rule.</p>
*/
ruleName: string | undefined;
/**
* <p>The condition and values for a criterion.</p>
*/
filter: { [key: string]: Criterion } | undefined;
}
export namespace InlineArchiveRule {
/**
* @internal
*/
export const filterSensitiveLog = (obj: InlineArchiveRule): any => ({
...obj,
});
}
export type Type = "ACCOUNT" | "ORGANIZATION";
/**
* <p>Creates an analyzer.</p>
*/
export interface CreateAnalyzerRequest {
/**
* <p>The name of the analyzer to create.</p>
*/
analyzerName: string | undefined;
/**
* <p>The type of analyzer to create. Only ACCOUNT and ORGANIZATION analyzers are supported.
* You can create only one analyzer per account per Region. You can create up to 5 analyzers
* per organization per Region.</p>
*/
type: Type | string | undefined;
/**
* <p>Specifies the archive rules to add for the analyzer. Archive rules automatically archive
* findings that meet the criteria you define for the rule.</p>
*/
archiveRules?: InlineArchiveRule[];
/**
* <p>The tags to apply to the analyzer.</p>
*/
tags?: { [key: string]: string };
/**
* <p>A client token.</p>
*/
clientToken?: string;
}
export namespace CreateAnalyzerRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CreateAnalyzerRequest): any => ({
...obj,
});
}
/**
* <p>The response to the request to create an analyzer.</p>
*/
export interface CreateAnalyzerResponse {
/**
* <p>The ARN of the analyzer that was created by the request.</p>
*/
arn?: string;
}
export namespace CreateAnalyzerResponse {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CreateAnalyzerResponse): any => ({
...obj,
});
}
/**
* <p>Deletes an analyzer.</p>
*/
export interface DeleteAnalyzerRequest {
/**
* <p>The name of the analyzer to delete.</p>
*/
analyzerName: string | undefined;
/**
* <p>A client token.</p>
*/
clientToken?: string;
}
export namespace DeleteAnalyzerRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: DeleteAnalyzerRequest): any => ({
...obj,
});
}
/**
* <p>Retrieves an analyzer.</p>
*/
export interface GetAnalyzerRequest {
/**
* <p>The name of the analyzer retrieved.</p>
*/
analyzerName: string | undefined;
}
export namespace GetAnalyzerRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: GetAnalyzerRequest): any => ({
...obj,
});
}
export type AnalyzerStatus = "ACTIVE" | "CREATING" | "DISABLED" | "FAILED";
export type ReasonCode =
| "AWS_SERVICE_ACCESS_DISABLED"
| "DELEGATED_ADMINISTRATOR_DEREGISTERED"
| "ORGANIZATION_DELETED"
| "SERVICE_LINKED_ROLE_CREATION_FAILED";
/**
* <p>Provides more details about the current status of the analyzer. For example, if the
* creation for the analyzer fails, a <code>Failed</code> status is returned. For an analyzer
* with organization as the type, this failure can be due to an issue with creating the
* service-linked roles required in the member accounts of the Amazon Web Services organization.</p>
*/
export interface StatusReason {
/**
* <p>The reason code for the current status of the analyzer.</p>
*/
code: ReasonCode | string | undefined;
}
export namespace StatusReason {
/**
* @internal
*/
export const filterSensitiveLog = (obj: StatusReason): any => ({
...obj,
});
}
/**
* <p>Contains information about the analyzer.</p>
*/
export interface AnalyzerSummary {
/**
* <p>The ARN of the analyzer.</p>
*/
arn: string | undefined;
/**
* <p>The name of the analyzer.</p>
*/
name: string | undefined;
/**
* <p>The type of analyzer, which corresponds to the zone of trust chosen for the
* analyzer.</p>
*/
type: Type | string | undefined;
/**
* <p>A timestamp for the time at which the analyzer was created.</p>
*/
createdAt: Date | undefined;
/**
* <p>The resource that was most recently analyzed by the analyzer.</p>
*/
lastResourceAnalyzed?: string;
/**
* <p>The time at which the most recently analyzed resource was analyzed.</p>
*/
lastResourceAnalyzedAt?: Date;
/**
* <p>The tags added to the analyzer.</p>
*/
tags?: { [key: string]: string };
/**
* <p>The status of the analyzer. An <code>Active</code> analyzer successfully monitors
* supported resources and generates new findings. The analyzer is <code>Disabled</code> when
* a user action, such as removing trusted access for Identity and Access Management Access Analyzer from Organizations, causes
* the analyzer to stop generating new findings. The status is <code>Creating</code> when the
* analyzer creation is in progress and <code>Failed</code> when the analyzer creation has
* failed. </p>
*/
status: AnalyzerStatus | string | undefined;
/**
* <p>The <code>statusReason</code> provides more details about the current status of the
* analyzer. For example, if the creation for the analyzer fails, a <code>Failed</code> status
* is returned. For an analyzer with organization as the type, this failure can be due to an
* issue with creating the service-linked roles required in the member accounts of the Amazon Web Services
* organization.</p>
*/
statusReason?: StatusReason;
}
export namespace AnalyzerSummary {
/**
* @internal
*/
export const filterSensitiveLog = (obj: AnalyzerSummary): any => ({
...obj,
});
}
/**
* <p>The response to the request.</p>
*/
export interface GetAnalyzerResponse {
/**
* <p>An <code>AnalyzerSummary</code> object that contains information about the
* analyzer.</p>
*/
analyzer: AnalyzerSummary | undefined;
}
export namespace GetAnalyzerResponse {
/**
* @internal
*/
export const filterSensitiveLog = (obj: GetAnalyzerResponse): any => ({
...obj,
});
}
/**
* <p>Retrieves a list of analyzers.</p>
*/
export interface ListAnalyzersRequest {
/**
* <p>A token used for pagination of results returned.</p>
*/
nextToken?: string;
/**
* <p>The maximum number of results to return in the response.</p>
*/
maxResults?: number;
/**
* <p>The type of analyzer.</p>
*/
type?: Type | string;
}
export namespace ListAnalyzersRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: ListAnalyzersRequest): any => ({
...obj,
});
}
/**
* <p>The response to the request.</p>
*/
export interface ListAnalyzersResponse {
/**
* <p>The analyzers retrieved.</p>
*/
analyzers: AnalyzerSummary[] | undefined;
/**
* <p>A token used for pagination of results returned.</p>
*/
nextToken?: string;
}
export namespace ListAnalyzersResponse {
/**
* @internal
*/
export const filterSensitiveLog = (obj: ListAnalyzersResponse): any => ({
...obj,
});
}
/**
* <p>Retroactively applies an archive rule.</p>
*/
export interface ApplyArchiveRuleRequest {
/**
* <p>The Amazon resource name (ARN) of the analyzer.</p>
*/
analyzerArn: string | undefined;
/**
* <p>The name of the rule to apply.</p>
*/
ruleName: string | undefined;
/**
* <p>A client token.</p>
*/
clientToken?: string;
}
export namespace ApplyArchiveRuleRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: ApplyArchiveRuleRequest): any => ({
...obj,
});
}
export interface CancelPolicyGenerationRequest {
/**
* <p>The <code>JobId</code> that is returned by the <code>StartPolicyGeneration</code>
* operation. The <code>JobId</code> can be used with <code>GetGeneratedPolicy</code> to
* retrieve the generated policies or used with <code>CancelPolicyGeneration</code> to cancel
* the policy generation request.</p>
*/
jobId: string | undefined;
}
export namespace CancelPolicyGenerationRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CancelPolicyGenerationRequest): any => ({
...obj,
});
}
export interface CancelPolicyGenerationResponse {}
export namespace CancelPolicyGenerationResponse {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CancelPolicyGenerationResponse): any => ({
...obj,
});
}
/**
* <p>The proposed access control configuration for an IAM role. You can propose a
* configuration for a new IAM role or an existing IAM role that you own by specifying the
* trust policy. If the configuration is for a new IAM role, you must specify the trust
* policy. If the configuration is for an existing IAM role that you own and you do not
* propose the trust policy, the access preview uses the existing trust policy for the role.
* The proposed trust policy cannot be an empty string. For more information about role trust
* policy limits, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS
* quotas</a>.</p>
*/
export interface IamRoleConfiguration {
/**
* <p>The proposed trust policy for the IAM role.</p>
*/
trustPolicy?: string;
}
export namespace IamRoleConfiguration {
/**
* @internal
*/
export const filterSensitiveLog = (obj: IamRoleConfiguration): any => ({
...obj,
});
}
/**
* <p>Use this structure to propose allowing <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
* operations</a> in the grant only when the operation request includes the specified
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption
* context</a>. You can specify only one type of encryption context. An empty map is
* treated as not specified. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html">GrantConstraints</a>.</p>
*/
export interface KmsGrantConstraints {
/**
* <p>A list of key-value pairs that must match the encryption context in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
* operation</a> request. The grant allows the operation only when the encryption
* context in the request is the same as the encryption context specified in this
* constraint.</p>
*/
encryptionContextEquals?: { [key: string]: string };
/**
* <p>A list of key-value pairs that must be included in the encryption context of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
* operation</a> request. The grant allows the cryptographic operation only when the
* encryption context in the request includes the key-value pairs specified in this
* constraint, although it can include additional key-value pairs.</p>
*/
encryptionContextSubset?: { [key: string]: string };
}
export namespace KmsGrantConstraints {
/**
* @internal
*/
export const filterSensitiveLog = (obj: KmsGrantConstraints): any => ({
...obj,
});
}
export enum KmsGrantOperation {
CREATE_GRANT = "CreateGrant",
DECRYPT = "Decrypt",
DESCRIBE_KEY = "DescribeKey",
ENCRYPT = "Encrypt",
GENERATE_DATA_KEY = "GenerateDataKey",
GENERATE_DATA_KEY_PAIR = "GenerateDataKeyPair",
GENERATE_DATA_KEY_PAIR_WITHOUT_PLAINTEXT = "GenerateDataKeyPairWithoutPlaintext",
GENERATE_DATA_KEY_WITHOUT_PLAINTEXT = "GenerateDataKeyWithoutPlaintext",
GET_PUBLIC_KEY = "GetPublicKey",
REENCRYPT_FROM = "ReEncryptFrom",
REENCRYPT_TO = "ReEncryptTo",
RETIRE_GRANT = "RetireGrant",
SIGN = "Sign",
VERIFY = "Verify",
}
/**
* <p>A proposed grant configuration for a KMS key. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html">CreateGrant</a>.</p>
*/
export interface KmsGrantConfiguration {
/**
* <p>A list of operations that the grant permits.</p>
*/
operations: (KmsGrantOperation | string)[] | undefined;
/**
* <p>The principal that is given permission to perform the operations that the grant
* permits.</p>
*/
granteePrincipal: string | undefined;
/**
* <p>The principal that is given permission to retire the grant by using <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html">RetireGrant</a> operation.</p>
*/
retiringPrincipal?: string;
/**
* <p>Use this structure to propose allowing <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic
* operations</a> in the grant only when the operation request includes the specified
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption
* context</a>.</p>
*/
constraints?: KmsGrantConstraints;
/**
* <p> The Amazon Web Services account under which the grant was issued. The account is used to propose
* KMS grants issued by accounts other than the owner of the key.</p>
*/
issuingAccount: string | undefined;
}
export namespace KmsGrantConfiguration {
/**
* @internal
*/
export const filterSensitiveLog = (obj: KmsGrantConfiguration): any => ({
...obj,
});
}
/**
* <p>Proposed access control configuration for a KMS key. You can propose a configuration
* for a new KMS key or an existing KMS key that you own by specifying the key policy and
* KMS grant configuration. If the configuration is for an existing key and you do not
* specify the key policy, the access preview uses the existing policy for the key. If the
* access preview is for a new resource and you do not specify the key policy, then the access
* preview uses the default key policy. The proposed key policy cannot be an empty string. For
* more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default">Default key
* policy</a>. For more information about key policy limits, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
* quotas</a>.</p>
* <p/>
*/
export interface KmsKeyConfiguration {
/**
* <p>Resource policy configuration for the KMS key. The only valid value for the name of
* the key policy is <code>default</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default">Default key
* policy</a>.</p>
*/
keyPolicies?: { [key: string]: string };
/**
* <p>A list of proposed grant configurations for the KMS key. If the proposed grant