@aws-sdk/client-config-service 3.378.0 → 3.382.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.
|
@@ -6,16 +6,19 @@ import { ConfigServiceServiceException as __BaseException } from "./ConfigServic
|
|
|
6
6
|
*/
|
|
7
7
|
export interface AccountAggregationSource {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>The 12-digit account ID of the account being aggregated.
|
|
10
11
|
* </p>
|
|
11
12
|
*/
|
|
12
13
|
AccountIds: string[] | undefined;
|
|
13
14
|
/**
|
|
15
|
+
* @public
|
|
14
16
|
* <p>If true, aggregate existing Config regions and future
|
|
15
17
|
* regions.</p>
|
|
16
18
|
*/
|
|
17
19
|
AllAwsRegions?: boolean;
|
|
18
20
|
/**
|
|
21
|
+
* @public
|
|
19
22
|
* <p>The source regions being aggregated.</p>
|
|
20
23
|
*/
|
|
21
24
|
AwsRegions?: string[];
|
|
@@ -28,11 +31,13 @@ export interface AccountAggregationSource {
|
|
|
28
31
|
*/
|
|
29
32
|
export interface ComplianceContributorCount {
|
|
30
33
|
/**
|
|
34
|
+
* @public
|
|
31
35
|
* <p>The number of Amazon Web Services resources or Config rules responsible for
|
|
32
36
|
* the current compliance of the item.</p>
|
|
33
37
|
*/
|
|
34
38
|
CappedCount?: number;
|
|
35
39
|
/**
|
|
40
|
+
* @public
|
|
36
41
|
* <p>Indicates whether the maximum count is reached.</p>
|
|
37
42
|
*/
|
|
38
43
|
CapExceeded?: boolean;
|
|
@@ -59,6 +64,7 @@ export type ComplianceType = (typeof ComplianceType)[keyof typeof ComplianceType
|
|
|
59
64
|
*/
|
|
60
65
|
export interface Compliance {
|
|
61
66
|
/**
|
|
67
|
+
* @public
|
|
62
68
|
* <p>Indicates whether an Amazon Web Services resource or Config rule is
|
|
63
69
|
* compliant.</p>
|
|
64
70
|
* <p>A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does
|
|
@@ -76,6 +82,7 @@ export interface Compliance {
|
|
|
76
82
|
*/
|
|
77
83
|
ComplianceType?: ComplianceType | string;
|
|
78
84
|
/**
|
|
85
|
+
* @public
|
|
79
86
|
* <p>The number of Amazon Web Services resources or Config rules that cause a
|
|
80
87
|
* result of <code>NON_COMPLIANT</code>, up to a maximum
|
|
81
88
|
* number.</p>
|
|
@@ -92,20 +99,24 @@ export interface Compliance {
|
|
|
92
99
|
*/
|
|
93
100
|
export interface AggregateComplianceByConfigRule {
|
|
94
101
|
/**
|
|
102
|
+
* @public
|
|
95
103
|
* <p>The name of the Config rule.</p>
|
|
96
104
|
*/
|
|
97
105
|
ConfigRuleName?: string;
|
|
98
106
|
/**
|
|
107
|
+
* @public
|
|
99
108
|
* <p>Indicates whether an Amazon Web Services resource or Config rule is
|
|
100
109
|
* compliant and provides the number of contributors that affect the
|
|
101
110
|
* compliance.</p>
|
|
102
111
|
*/
|
|
103
112
|
Compliance?: Compliance;
|
|
104
113
|
/**
|
|
114
|
+
* @public
|
|
105
115
|
* <p>The 12-digit account ID of the source account.</p>
|
|
106
116
|
*/
|
|
107
117
|
AccountId?: string;
|
|
108
118
|
/**
|
|
119
|
+
* @public
|
|
109
120
|
* <p>The source region from where the data is aggregated.</p>
|
|
110
121
|
*/
|
|
111
122
|
AwsRegion?: string;
|
|
@@ -133,18 +144,22 @@ export type ConformancePackComplianceType = (typeof ConformancePackComplianceTyp
|
|
|
133
144
|
*/
|
|
134
145
|
export interface AggregateConformancePackCompliance {
|
|
135
146
|
/**
|
|
147
|
+
* @public
|
|
136
148
|
* <p>The compliance status of the conformance pack.</p>
|
|
137
149
|
*/
|
|
138
150
|
ComplianceType?: ConformancePackComplianceType | string;
|
|
139
151
|
/**
|
|
152
|
+
* @public
|
|
140
153
|
* <p>The number of compliant Config Rules.</p>
|
|
141
154
|
*/
|
|
142
155
|
CompliantRuleCount?: number;
|
|
143
156
|
/**
|
|
157
|
+
* @public
|
|
144
158
|
* <p>The number of noncompliant Config Rules.</p>
|
|
145
159
|
*/
|
|
146
160
|
NonCompliantRuleCount?: number;
|
|
147
161
|
/**
|
|
162
|
+
* @public
|
|
148
163
|
* <p>Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.</p>
|
|
149
164
|
*/
|
|
150
165
|
TotalRuleCount?: number;
|
|
@@ -159,18 +174,22 @@ export interface AggregateConformancePackCompliance {
|
|
|
159
174
|
*/
|
|
160
175
|
export interface AggregateComplianceByConformancePack {
|
|
161
176
|
/**
|
|
177
|
+
* @public
|
|
162
178
|
* <p>The name of the conformance pack.</p>
|
|
163
179
|
*/
|
|
164
180
|
ConformancePackName?: string;
|
|
165
181
|
/**
|
|
182
|
+
* @public
|
|
166
183
|
* <p>The compliance status of the conformance pack.</p>
|
|
167
184
|
*/
|
|
168
185
|
Compliance?: AggregateConformancePackCompliance;
|
|
169
186
|
/**
|
|
187
|
+
* @public
|
|
170
188
|
* <p>The 12-digit Amazon Web Services account ID of the source account.</p>
|
|
171
189
|
*/
|
|
172
190
|
AccountId?: string;
|
|
173
191
|
/**
|
|
192
|
+
* @public
|
|
174
193
|
* <p>The source Amazon Web Services Region from where the data is aggregated.</p>
|
|
175
194
|
*/
|
|
176
195
|
AwsRegion?: string;
|
|
@@ -182,18 +201,21 @@ export interface AggregateComplianceByConformancePack {
|
|
|
182
201
|
*/
|
|
183
202
|
export interface ComplianceSummary {
|
|
184
203
|
/**
|
|
204
|
+
* @public
|
|
185
205
|
* <p>The number of Config rules or Amazon Web Services resources that are
|
|
186
206
|
* compliant, up to a maximum of 25 for rules and 100 for
|
|
187
207
|
* resources.</p>
|
|
188
208
|
*/
|
|
189
209
|
CompliantResourceCount?: ComplianceContributorCount;
|
|
190
210
|
/**
|
|
211
|
+
* @public
|
|
191
212
|
* <p>The number of Config rules or Amazon Web Services resources that are
|
|
192
213
|
* noncompliant, up to a maximum of 25 for rules and 100 for
|
|
193
214
|
* resources.</p>
|
|
194
215
|
*/
|
|
195
216
|
NonCompliantResourceCount?: ComplianceContributorCount;
|
|
196
217
|
/**
|
|
218
|
+
* @public
|
|
197
219
|
* <p>The time that Config created the compliance
|
|
198
220
|
* summary.</p>
|
|
199
221
|
*/
|
|
@@ -206,11 +228,13 @@ export interface ComplianceSummary {
|
|
|
206
228
|
*/
|
|
207
229
|
export interface AggregateComplianceCount {
|
|
208
230
|
/**
|
|
231
|
+
* @public
|
|
209
232
|
* <p>The 12-digit account ID or region based on the GroupByKey
|
|
210
233
|
* value.</p>
|
|
211
234
|
*/
|
|
212
235
|
GroupName?: string;
|
|
213
236
|
/**
|
|
237
|
+
* @public
|
|
214
238
|
* <p>The number of compliant and noncompliant Config
|
|
215
239
|
* rules.</p>
|
|
216
240
|
*/
|
|
@@ -222,10 +246,12 @@ export interface AggregateComplianceCount {
|
|
|
222
246
|
*/
|
|
223
247
|
export interface AggregateConformancePackComplianceCount {
|
|
224
248
|
/**
|
|
249
|
+
* @public
|
|
225
250
|
* <p>Number of compliant conformance packs.</p>
|
|
226
251
|
*/
|
|
227
252
|
CompliantConformancePackCount?: number;
|
|
228
253
|
/**
|
|
254
|
+
* @public
|
|
229
255
|
* <p>Number of noncompliant conformance packs.</p>
|
|
230
256
|
*/
|
|
231
257
|
NonCompliantConformancePackCount?: number;
|
|
@@ -236,18 +262,22 @@ export interface AggregateConformancePackComplianceCount {
|
|
|
236
262
|
*/
|
|
237
263
|
export interface AggregateConformancePackComplianceFilters {
|
|
238
264
|
/**
|
|
265
|
+
* @public
|
|
239
266
|
* <p>The name of the conformance pack.</p>
|
|
240
267
|
*/
|
|
241
268
|
ConformancePackName?: string;
|
|
242
269
|
/**
|
|
270
|
+
* @public
|
|
243
271
|
* <p>The compliance status of the conformance pack.</p>
|
|
244
272
|
*/
|
|
245
273
|
ComplianceType?: ConformancePackComplianceType | string;
|
|
246
274
|
/**
|
|
275
|
+
* @public
|
|
247
276
|
* <p>The 12-digit Amazon Web Services account ID of the source account.</p>
|
|
248
277
|
*/
|
|
249
278
|
AccountId?: string;
|
|
250
279
|
/**
|
|
280
|
+
* @public
|
|
251
281
|
* <p>The source Amazon Web Services Region from where the data is aggregated.</p>
|
|
252
282
|
*/
|
|
253
283
|
AwsRegion?: string;
|
|
@@ -258,10 +288,12 @@ export interface AggregateConformancePackComplianceFilters {
|
|
|
258
288
|
*/
|
|
259
289
|
export interface AggregateConformancePackComplianceSummary {
|
|
260
290
|
/**
|
|
291
|
+
* @public
|
|
261
292
|
* <p>Returns an <code>AggregateConformancePackComplianceCount</code> object. </p>
|
|
262
293
|
*/
|
|
263
294
|
ComplianceSummary?: AggregateConformancePackComplianceCount;
|
|
264
295
|
/**
|
|
296
|
+
* @public
|
|
265
297
|
* <p>Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.</p>
|
|
266
298
|
*/
|
|
267
299
|
GroupName?: string;
|
|
@@ -272,10 +304,12 @@ export interface AggregateConformancePackComplianceSummary {
|
|
|
272
304
|
*/
|
|
273
305
|
export interface AggregateConformancePackComplianceSummaryFilters {
|
|
274
306
|
/**
|
|
307
|
+
* @public
|
|
275
308
|
* <p>The 12-digit Amazon Web Services account ID of the source account.</p>
|
|
276
309
|
*/
|
|
277
310
|
AccountId?: string;
|
|
278
311
|
/**
|
|
312
|
+
* @public
|
|
279
313
|
* <p>The source Amazon Web Services Region from where the data is aggregated.</p>
|
|
280
314
|
*/
|
|
281
315
|
AwsRegion?: string;
|
|
@@ -324,18 +358,22 @@ export type AggregatedSourceType = (typeof AggregatedSourceType)[keyof typeof Ag
|
|
|
324
358
|
*/
|
|
325
359
|
export interface AggregatedSourceStatus {
|
|
326
360
|
/**
|
|
361
|
+
* @public
|
|
327
362
|
* <p>The source account ID or an organization.</p>
|
|
328
363
|
*/
|
|
329
364
|
SourceId?: string;
|
|
330
365
|
/**
|
|
366
|
+
* @public
|
|
331
367
|
* <p>The source account or an organization.</p>
|
|
332
368
|
*/
|
|
333
369
|
SourceType?: AggregatedSourceType | string;
|
|
334
370
|
/**
|
|
371
|
+
* @public
|
|
335
372
|
* <p>The region authorized to collect aggregated data.</p>
|
|
336
373
|
*/
|
|
337
374
|
AwsRegion?: string;
|
|
338
375
|
/**
|
|
376
|
+
* @public
|
|
339
377
|
* <p>Filters the last updated status type.</p>
|
|
340
378
|
* <ul>
|
|
341
379
|
* <li>
|
|
@@ -354,15 +392,18 @@ export interface AggregatedSourceStatus {
|
|
|
354
392
|
*/
|
|
355
393
|
LastUpdateStatus?: AggregatedSourceStatusType | string;
|
|
356
394
|
/**
|
|
395
|
+
* @public
|
|
357
396
|
* <p>The time of the last update.</p>
|
|
358
397
|
*/
|
|
359
398
|
LastUpdateTime?: Date;
|
|
360
399
|
/**
|
|
400
|
+
* @public
|
|
361
401
|
* <p>The error code that Config returned when the source account
|
|
362
402
|
* aggregation last failed.</p>
|
|
363
403
|
*/
|
|
364
404
|
LastErrorCode?: string;
|
|
365
405
|
/**
|
|
406
|
+
* @public
|
|
366
407
|
* <p>The message indicating that the source account aggregation
|
|
367
408
|
* failed due to an error.</p>
|
|
368
409
|
*/
|
|
@@ -388,19 +429,23 @@ export type EvaluationMode = (typeof EvaluationMode)[keyof typeof EvaluationMode
|
|
|
388
429
|
*/
|
|
389
430
|
export interface EvaluationResultQualifier {
|
|
390
431
|
/**
|
|
432
|
+
* @public
|
|
391
433
|
* <p>The name of the Config rule that was used in the
|
|
392
434
|
* evaluation.</p>
|
|
393
435
|
*/
|
|
394
436
|
ConfigRuleName?: string;
|
|
395
437
|
/**
|
|
438
|
+
* @public
|
|
396
439
|
* <p>The type of Amazon Web Services resource that was evaluated.</p>
|
|
397
440
|
*/
|
|
398
441
|
ResourceType?: string;
|
|
399
442
|
/**
|
|
443
|
+
* @public
|
|
400
444
|
* <p>The ID of the evaluated Amazon Web Services resource.</p>
|
|
401
445
|
*/
|
|
402
446
|
ResourceId?: string;
|
|
403
447
|
/**
|
|
448
|
+
* @public
|
|
404
449
|
* <p>The mode of an evaluation. The valid values are Detective or Proactive.</p>
|
|
405
450
|
*/
|
|
406
451
|
EvaluationMode?: EvaluationMode | string;
|
|
@@ -411,11 +456,13 @@ export interface EvaluationResultQualifier {
|
|
|
411
456
|
*/
|
|
412
457
|
export interface EvaluationResultIdentifier {
|
|
413
458
|
/**
|
|
459
|
+
* @public
|
|
414
460
|
* <p>Identifies an Config rule used to evaluate an Amazon Web Services resource,
|
|
415
461
|
* and provides the type and ID of the evaluated resource.</p>
|
|
416
462
|
*/
|
|
417
463
|
EvaluationResultQualifier?: EvaluationResultQualifier;
|
|
418
464
|
/**
|
|
465
|
+
* @public
|
|
419
466
|
* <p>The time of the event that triggered the evaluation of your Amazon Web Services
|
|
420
467
|
* resources. The time can indicate when Config delivered a
|
|
421
468
|
* configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which
|
|
@@ -423,6 +470,7 @@ export interface EvaluationResultIdentifier {
|
|
|
423
470
|
*/
|
|
424
471
|
OrderingTimestamp?: Date;
|
|
425
472
|
/**
|
|
473
|
+
* @public
|
|
426
474
|
* <p>A Unique ID for an evaluation result.</p>
|
|
427
475
|
*/
|
|
428
476
|
ResourceEvaluationId?: string;
|
|
@@ -436,10 +484,12 @@ export interface EvaluationResultIdentifier {
|
|
|
436
484
|
*/
|
|
437
485
|
export interface AggregateEvaluationResult {
|
|
438
486
|
/**
|
|
487
|
+
* @public
|
|
439
488
|
* <p>Uniquely identifies the evaluation result.</p>
|
|
440
489
|
*/
|
|
441
490
|
EvaluationResultIdentifier?: EvaluationResultIdentifier;
|
|
442
491
|
/**
|
|
492
|
+
* @public
|
|
443
493
|
* <p>The resource compliance status.</p>
|
|
444
494
|
* <p>For the <code>AggregationEvaluationResult</code> data type, Config supports only the <code>COMPLIANT</code> and
|
|
445
495
|
* <code>NON_COMPLIANT</code>. Config does not support the
|
|
@@ -448,25 +498,30 @@ export interface AggregateEvaluationResult {
|
|
|
448
498
|
*/
|
|
449
499
|
ComplianceType?: ComplianceType | string;
|
|
450
500
|
/**
|
|
501
|
+
* @public
|
|
451
502
|
* <p>The time when Config recorded the aggregate evaluation
|
|
452
503
|
* result.</p>
|
|
453
504
|
*/
|
|
454
505
|
ResultRecordedTime?: Date;
|
|
455
506
|
/**
|
|
507
|
+
* @public
|
|
456
508
|
* <p>The time when the Config rule evaluated the Amazon Web Services
|
|
457
509
|
* resource.</p>
|
|
458
510
|
*/
|
|
459
511
|
ConfigRuleInvokedTime?: Date;
|
|
460
512
|
/**
|
|
513
|
+
* @public
|
|
461
514
|
* <p>Supplementary information about how the agrregate evaluation
|
|
462
515
|
* determined the compliance.</p>
|
|
463
516
|
*/
|
|
464
517
|
Annotation?: string;
|
|
465
518
|
/**
|
|
519
|
+
* @public
|
|
466
520
|
* <p>The 12-digit account ID of the source account.</p>
|
|
467
521
|
*/
|
|
468
522
|
AccountId?: string;
|
|
469
523
|
/**
|
|
524
|
+
* @public
|
|
470
525
|
* <p>The source region from where the data is aggregated.</p>
|
|
471
526
|
*/
|
|
472
527
|
AwsRegion?: string;
|
|
@@ -805,22 +860,27 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
|
805
860
|
*/
|
|
806
861
|
export interface AggregateResourceIdentifier {
|
|
807
862
|
/**
|
|
863
|
+
* @public
|
|
808
864
|
* <p>The 12-digit account ID of the source account.</p>
|
|
809
865
|
*/
|
|
810
866
|
SourceAccountId: string | undefined;
|
|
811
867
|
/**
|
|
868
|
+
* @public
|
|
812
869
|
* <p>The source region where data is aggregated.</p>
|
|
813
870
|
*/
|
|
814
871
|
SourceRegion: string | undefined;
|
|
815
872
|
/**
|
|
873
|
+
* @public
|
|
816
874
|
* <p>The ID of the Amazon Web Services resource.</p>
|
|
817
875
|
*/
|
|
818
876
|
ResourceId: string | undefined;
|
|
819
877
|
/**
|
|
878
|
+
* @public
|
|
820
879
|
* <p>The type of the Amazon Web Services resource.</p>
|
|
821
880
|
*/
|
|
822
881
|
ResourceType: ResourceType | string | undefined;
|
|
823
882
|
/**
|
|
883
|
+
* @public
|
|
824
884
|
* <p>The name of the Amazon Web Services resource.</p>
|
|
825
885
|
*/
|
|
826
886
|
ResourceName?: string;
|
|
@@ -832,20 +892,24 @@ export interface AggregateResourceIdentifier {
|
|
|
832
892
|
*/
|
|
833
893
|
export interface AggregationAuthorization {
|
|
834
894
|
/**
|
|
895
|
+
* @public
|
|
835
896
|
* <p>The Amazon Resource Name (ARN) of the aggregation
|
|
836
897
|
* object.</p>
|
|
837
898
|
*/
|
|
838
899
|
AggregationAuthorizationArn?: string;
|
|
839
900
|
/**
|
|
901
|
+
* @public
|
|
840
902
|
* <p>The 12-digit account ID of the account authorized to aggregate
|
|
841
903
|
* data.</p>
|
|
842
904
|
*/
|
|
843
905
|
AuthorizedAccountId?: string;
|
|
844
906
|
/**
|
|
907
|
+
* @public
|
|
845
908
|
* <p>The region authorized to collect aggregated data.</p>
|
|
846
909
|
*/
|
|
847
910
|
AuthorizedAwsRegion?: string;
|
|
848
911
|
/**
|
|
912
|
+
* @public
|
|
849
913
|
* <p>The time stamp when the aggregation authorization was
|
|
850
914
|
* created.</p>
|
|
851
915
|
*/
|
|
@@ -872,18 +936,22 @@ export type ConfigurationItemStatus = (typeof ConfigurationItemStatus)[keyof typ
|
|
|
872
936
|
*/
|
|
873
937
|
export interface BaseConfigurationItem {
|
|
874
938
|
/**
|
|
939
|
+
* @public
|
|
875
940
|
* <p>The version number of the resource configuration.</p>
|
|
876
941
|
*/
|
|
877
942
|
version?: string;
|
|
878
943
|
/**
|
|
944
|
+
* @public
|
|
879
945
|
* <p>The 12-digit Amazon Web Services account ID associated with the resource.</p>
|
|
880
946
|
*/
|
|
881
947
|
accountId?: string;
|
|
882
948
|
/**
|
|
949
|
+
* @public
|
|
883
950
|
* <p>The time when the configuration recording was initiated.</p>
|
|
884
951
|
*/
|
|
885
952
|
configurationItemCaptureTime?: Date;
|
|
886
953
|
/**
|
|
954
|
+
* @public
|
|
887
955
|
* <p>The configuration item status. The valid values are:</p>
|
|
888
956
|
* <ul>
|
|
889
957
|
* <li>
|
|
@@ -908,43 +976,53 @@ export interface BaseConfigurationItem {
|
|
|
908
976
|
*/
|
|
909
977
|
configurationItemStatus?: ConfigurationItemStatus | string;
|
|
910
978
|
/**
|
|
979
|
+
* @public
|
|
911
980
|
* <p>An identifier that indicates the ordering of the configuration
|
|
912
981
|
* items of a resource.</p>
|
|
913
982
|
*/
|
|
914
983
|
configurationStateId?: string;
|
|
915
984
|
/**
|
|
985
|
+
* @public
|
|
916
986
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
917
987
|
*/
|
|
918
988
|
arn?: string;
|
|
919
989
|
/**
|
|
990
|
+
* @public
|
|
920
991
|
* <p>The type of Amazon Web Services resource.</p>
|
|
921
992
|
*/
|
|
922
993
|
resourceType?: ResourceType | string;
|
|
923
994
|
/**
|
|
995
|
+
* @public
|
|
924
996
|
* <p>The ID of the resource (for example., sg-xxxxxx).</p>
|
|
925
997
|
*/
|
|
926
998
|
resourceId?: string;
|
|
927
999
|
/**
|
|
1000
|
+
* @public
|
|
928
1001
|
* <p>The custom name of the resource, if available.</p>
|
|
929
1002
|
*/
|
|
930
1003
|
resourceName?: string;
|
|
931
1004
|
/**
|
|
1005
|
+
* @public
|
|
932
1006
|
* <p>The region where the resource resides.</p>
|
|
933
1007
|
*/
|
|
934
1008
|
awsRegion?: string;
|
|
935
1009
|
/**
|
|
1010
|
+
* @public
|
|
936
1011
|
* <p>The Availability Zone associated with the resource.</p>
|
|
937
1012
|
*/
|
|
938
1013
|
availabilityZone?: string;
|
|
939
1014
|
/**
|
|
1015
|
+
* @public
|
|
940
1016
|
* <p>The time stamp when the resource was created.</p>
|
|
941
1017
|
*/
|
|
942
1018
|
resourceCreationTime?: Date;
|
|
943
1019
|
/**
|
|
1020
|
+
* @public
|
|
944
1021
|
* <p>The description of the resource configuration.</p>
|
|
945
1022
|
*/
|
|
946
1023
|
configuration?: string;
|
|
947
1024
|
/**
|
|
1025
|
+
* @public
|
|
948
1026
|
* <p>Configuration attributes that Config returns for certain
|
|
949
1027
|
* resource types to supplement the information returned for the
|
|
950
1028
|
* configuration parameter.</p>
|
|
@@ -956,10 +1034,12 @@ export interface BaseConfigurationItem {
|
|
|
956
1034
|
*/
|
|
957
1035
|
export interface BatchGetAggregateResourceConfigRequest {
|
|
958
1036
|
/**
|
|
1037
|
+
* @public
|
|
959
1038
|
* <p>The name of the configuration aggregator.</p>
|
|
960
1039
|
*/
|
|
961
1040
|
ConfigurationAggregatorName: string | undefined;
|
|
962
1041
|
/**
|
|
1042
|
+
* @public
|
|
963
1043
|
* <p>A list of aggregate ResourceIdentifiers objects. </p>
|
|
964
1044
|
*/
|
|
965
1045
|
ResourceIdentifiers: AggregateResourceIdentifier[] | undefined;
|
|
@@ -969,10 +1049,12 @@ export interface BatchGetAggregateResourceConfigRequest {
|
|
|
969
1049
|
*/
|
|
970
1050
|
export interface BatchGetAggregateResourceConfigResponse {
|
|
971
1051
|
/**
|
|
1052
|
+
* @public
|
|
972
1053
|
* <p>A list that contains the current configuration of one or more resources.</p>
|
|
973
1054
|
*/
|
|
974
1055
|
BaseConfigurationItems?: BaseConfigurationItem[];
|
|
975
1056
|
/**
|
|
1057
|
+
* @public
|
|
976
1058
|
* <p>A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.</p>
|
|
977
1059
|
*/
|
|
978
1060
|
UnprocessedResourceIdentifiers?: AggregateResourceIdentifier[];
|
|
@@ -1010,10 +1092,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
1010
1092
|
*/
|
|
1011
1093
|
export interface ResourceKey {
|
|
1012
1094
|
/**
|
|
1095
|
+
* @public
|
|
1013
1096
|
* <p>The resource type.</p>
|
|
1014
1097
|
*/
|
|
1015
1098
|
resourceType: ResourceType | string | undefined;
|
|
1016
1099
|
/**
|
|
1100
|
+
* @public
|
|
1017
1101
|
* <p>The ID of the resource (for example., sg-xxxxxx). </p>
|
|
1018
1102
|
*/
|
|
1019
1103
|
resourceId: string | undefined;
|
|
@@ -1023,6 +1107,7 @@ export interface ResourceKey {
|
|
|
1023
1107
|
*/
|
|
1024
1108
|
export interface BatchGetResourceConfigRequest {
|
|
1025
1109
|
/**
|
|
1110
|
+
* @public
|
|
1026
1111
|
* <p>A list of resource keys to be processed with the current
|
|
1027
1112
|
* request. Each element in the list consists of the resource type and
|
|
1028
1113
|
* resource ID.</p>
|
|
@@ -1034,11 +1119,13 @@ export interface BatchGetResourceConfigRequest {
|
|
|
1034
1119
|
*/
|
|
1035
1120
|
export interface BatchGetResourceConfigResponse {
|
|
1036
1121
|
/**
|
|
1122
|
+
* @public
|
|
1037
1123
|
* <p>A list that contains the current configuration of one or more
|
|
1038
1124
|
* resources.</p>
|
|
1039
1125
|
*/
|
|
1040
1126
|
baseConfigurationItems?: BaseConfigurationItem[];
|
|
1041
1127
|
/**
|
|
1128
|
+
* @public
|
|
1042
1129
|
* <p>A list of resource keys that were not processed with the
|
|
1043
1130
|
* current response. The unprocessesResourceKeys value is in the same
|
|
1044
1131
|
* form as ResourceKeys, so the value can be directly provided to a
|
|
@@ -1084,10 +1171,12 @@ export type ChronologicalOrder = (typeof ChronologicalOrder)[keyof typeof Chrono
|
|
|
1084
1171
|
*/
|
|
1085
1172
|
export interface ComplianceByConfigRule {
|
|
1086
1173
|
/**
|
|
1174
|
+
* @public
|
|
1087
1175
|
* <p>The name of the Config rule.</p>
|
|
1088
1176
|
*/
|
|
1089
1177
|
ConfigRuleName?: string;
|
|
1090
1178
|
/**
|
|
1179
|
+
* @public
|
|
1091
1180
|
* <p>Indicates whether the Config rule is compliant.</p>
|
|
1092
1181
|
*/
|
|
1093
1182
|
Compliance?: Compliance;
|
|
@@ -1102,14 +1191,17 @@ export interface ComplianceByConfigRule {
|
|
|
1102
1191
|
*/
|
|
1103
1192
|
export interface ComplianceByResource {
|
|
1104
1193
|
/**
|
|
1194
|
+
* @public
|
|
1105
1195
|
* <p>The type of the Amazon Web Services resource that was evaluated.</p>
|
|
1106
1196
|
*/
|
|
1107
1197
|
ResourceType?: string;
|
|
1108
1198
|
/**
|
|
1199
|
+
* @public
|
|
1109
1200
|
* <p>The ID of the Amazon Web Services resource that was evaluated.</p>
|
|
1110
1201
|
*/
|
|
1111
1202
|
ResourceId?: string;
|
|
1112
1203
|
/**
|
|
1204
|
+
* @public
|
|
1113
1205
|
* <p>Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.</p>
|
|
1114
1206
|
*/
|
|
1115
1207
|
Compliance?: Compliance;
|
|
@@ -1122,10 +1214,12 @@ export interface ComplianceByResource {
|
|
|
1122
1214
|
*/
|
|
1123
1215
|
export interface ComplianceSummaryByResourceType {
|
|
1124
1216
|
/**
|
|
1217
|
+
* @public
|
|
1125
1218
|
* <p>The type of Amazon Web Services resource.</p>
|
|
1126
1219
|
*/
|
|
1127
1220
|
ResourceType?: string;
|
|
1128
1221
|
/**
|
|
1222
|
+
* @public
|
|
1129
1223
|
* <p>The number of Amazon Web Services resources that are compliant or noncompliant,
|
|
1130
1224
|
* up to a maximum of 100 for each.</p>
|
|
1131
1225
|
*/
|
|
@@ -1153,26 +1247,32 @@ export type DeliveryStatus = (typeof DeliveryStatus)[keyof typeof DeliveryStatus
|
|
|
1153
1247
|
*/
|
|
1154
1248
|
export interface ConfigExportDeliveryInfo {
|
|
1155
1249
|
/**
|
|
1250
|
+
* @public
|
|
1156
1251
|
* <p>Status of the last attempted delivery.</p>
|
|
1157
1252
|
*/
|
|
1158
1253
|
lastStatus?: DeliveryStatus | string;
|
|
1159
1254
|
/**
|
|
1255
|
+
* @public
|
|
1160
1256
|
* <p>The error code from the last attempted delivery.</p>
|
|
1161
1257
|
*/
|
|
1162
1258
|
lastErrorCode?: string;
|
|
1163
1259
|
/**
|
|
1260
|
+
* @public
|
|
1164
1261
|
* <p>The error message from the last attempted delivery.</p>
|
|
1165
1262
|
*/
|
|
1166
1263
|
lastErrorMessage?: string;
|
|
1167
1264
|
/**
|
|
1265
|
+
* @public
|
|
1168
1266
|
* <p>The time of the last attempted delivery.</p>
|
|
1169
1267
|
*/
|
|
1170
1268
|
lastAttemptTime?: Date;
|
|
1171
1269
|
/**
|
|
1270
|
+
* @public
|
|
1172
1271
|
* <p>The time of the last successful delivery.</p>
|
|
1173
1272
|
*/
|
|
1174
1273
|
lastSuccessfulTime?: Date;
|
|
1175
1274
|
/**
|
|
1275
|
+
* @public
|
|
1176
1276
|
* <p>The time that the next delivery occurs.</p>
|
|
1177
1277
|
*/
|
|
1178
1278
|
nextDeliveryTime?: Date;
|
|
@@ -1197,6 +1297,7 @@ export type ConfigRuleState = (typeof ConfigRuleState)[keyof typeof ConfigRuleSt
|
|
|
1197
1297
|
*/
|
|
1198
1298
|
export interface EvaluationModeConfiguration {
|
|
1199
1299
|
/**
|
|
1300
|
+
* @public
|
|
1200
1301
|
* <p>The mode of an evaluation. The valid values are Detective or Proactive.</p>
|
|
1201
1302
|
*/
|
|
1202
1303
|
Mode?: EvaluationMode | string;
|
|
@@ -1228,6 +1329,7 @@ export type MaximumExecutionFrequency = (typeof MaximumExecutionFrequency)[keyof
|
|
|
1228
1329
|
*/
|
|
1229
1330
|
export interface Scope {
|
|
1230
1331
|
/**
|
|
1332
|
+
* @public
|
|
1231
1333
|
* <p>The resource types of only those Amazon Web Services resources that you want to
|
|
1232
1334
|
* trigger an evaluation for the rule. You can only specify one type if
|
|
1233
1335
|
* you also specify a resource ID for
|
|
@@ -1235,11 +1337,13 @@ export interface Scope {
|
|
|
1235
1337
|
*/
|
|
1236
1338
|
ComplianceResourceTypes?: string[];
|
|
1237
1339
|
/**
|
|
1340
|
+
* @public
|
|
1238
1341
|
* <p>The tag key that is applied to only those Amazon Web Services resources that
|
|
1239
1342
|
* you want to trigger an evaluation for the rule.</p>
|
|
1240
1343
|
*/
|
|
1241
1344
|
TagKey?: string;
|
|
1242
1345
|
/**
|
|
1346
|
+
* @public
|
|
1243
1347
|
* <p>The tag value applied to only those Amazon Web Services resources that you want
|
|
1244
1348
|
* to trigger an evaluation for the rule. If you specify a value for
|
|
1245
1349
|
* <code>TagValue</code>, you must also specify a value for
|
|
@@ -1247,6 +1351,7 @@ export interface Scope {
|
|
|
1247
1351
|
*/
|
|
1248
1352
|
TagValue?: string;
|
|
1249
1353
|
/**
|
|
1354
|
+
* @public
|
|
1250
1355
|
* <p>The ID of the only Amazon Web Services resource that you want to trigger an
|
|
1251
1356
|
* evaluation for the rule. If you specify a resource ID, you must
|
|
1252
1357
|
* specify one resource type for
|
|
@@ -1263,15 +1368,18 @@ export interface Scope {
|
|
|
1263
1368
|
*/
|
|
1264
1369
|
export interface CustomPolicyDetails {
|
|
1265
1370
|
/**
|
|
1371
|
+
* @public
|
|
1266
1372
|
* <p>The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the <a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
|
|
1267
1373
|
* Repository</a>.</p>
|
|
1268
1374
|
*/
|
|
1269
1375
|
PolicyRuntime: string | undefined;
|
|
1270
1376
|
/**
|
|
1377
|
+
* @public
|
|
1271
1378
|
* <p>The policy definition containing the logic for your Config Custom Policy rule.</p>
|
|
1272
1379
|
*/
|
|
1273
1380
|
PolicyText: string | undefined;
|
|
1274
1381
|
/**
|
|
1382
|
+
* @public
|
|
1275
1383
|
* <p>The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is <code>false</code>.</p>
|
|
1276
1384
|
*/
|
|
1277
1385
|
EnableDebugLogDelivery?: boolean;
|
|
@@ -1324,11 +1432,13 @@ export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
|
1324
1432
|
*/
|
|
1325
1433
|
export interface SourceDetail {
|
|
1326
1434
|
/**
|
|
1435
|
+
* @public
|
|
1327
1436
|
* <p>The source of the event, such as an Amazon Web Services service, that triggers
|
|
1328
1437
|
* Config to evaluate your Amazon Web Services resources.</p>
|
|
1329
1438
|
*/
|
|
1330
1439
|
EventSource?: EventSource | string;
|
|
1331
1440
|
/**
|
|
1441
|
+
* @public
|
|
1332
1442
|
* <p>The type of notification that triggers Config to run an
|
|
1333
1443
|
* evaluation for a rule. You can specify the following notification
|
|
1334
1444
|
* types:</p>
|
|
@@ -1368,6 +1478,7 @@ export interface SourceDetail {
|
|
|
1368
1478
|
*/
|
|
1369
1479
|
MessageType?: MessageType | string;
|
|
1370
1480
|
/**
|
|
1481
|
+
* @public
|
|
1371
1482
|
* <p>The frequency at which you want Config to run evaluations
|
|
1372
1483
|
* for a custom rule with a periodic trigger. If you specify a value
|
|
1373
1484
|
* for <code>MaximumExecutionFrequency</code>, then
|
|
@@ -1395,12 +1506,14 @@ export interface SourceDetail {
|
|
|
1395
1506
|
*/
|
|
1396
1507
|
export interface Source {
|
|
1397
1508
|
/**
|
|
1509
|
+
* @public
|
|
1398
1510
|
* <p>Indicates whether Amazon Web Services or the customer owns and manages the Config rule.</p>
|
|
1399
1511
|
* <p>Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Config Managed Rules</a> in the <i>Config developer guide</i>.</p>
|
|
1400
1512
|
* <p>Config Custom Rules are rules that you can develop either with Guard (<code>CUSTOM_POLICY</code>) or Lambda (<code>CUSTOM_LAMBDA</code>). For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html">Config Custom Rules </a> in the <i>Config developer guide</i>.</p>
|
|
1401
1513
|
*/
|
|
1402
1514
|
Owner: Owner | string | undefined;
|
|
1403
1515
|
/**
|
|
1516
|
+
* @public
|
|
1404
1517
|
* <p>For Config Managed rules, a predefined identifier from a
|
|
1405
1518
|
* list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed
|
|
1406
1519
|
* rule. To reference a managed rule, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config Managed Rules</a>.</p>
|
|
@@ -1411,11 +1524,13 @@ export interface Source {
|
|
|
1411
1524
|
*/
|
|
1412
1525
|
SourceIdentifier?: string;
|
|
1413
1526
|
/**
|
|
1527
|
+
* @public
|
|
1414
1528
|
* <p>Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.</p>
|
|
1415
1529
|
* <p>If the owner is set to <code>CUSTOM_POLICY</code>, the only acceptable values for the Config rule trigger message type are <code>ConfigurationItemChangeNotification</code> and <code>OversizedConfigurationItemChangeNotification</code>.</p>
|
|
1416
1530
|
*/
|
|
1417
1531
|
SourceDetails?: SourceDetail[];
|
|
1418
1532
|
/**
|
|
1533
|
+
* @public
|
|
1419
1534
|
* <p>Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to <code>CUSTOM_POLICY</code>.</p>
|
|
1420
1535
|
*/
|
|
1421
1536
|
CustomPolicyDetails?: CustomPolicyDetails;
|
|
@@ -1447,25 +1562,30 @@ export interface Source {
|
|
|
1447
1562
|
*/
|
|
1448
1563
|
export interface ConfigRule {
|
|
1449
1564
|
/**
|
|
1565
|
+
* @public
|
|
1450
1566
|
* <p>The name that you assign to the Config rule. The name is
|
|
1451
1567
|
* required if you are adding a new rule.</p>
|
|
1452
1568
|
*/
|
|
1453
1569
|
ConfigRuleName?: string;
|
|
1454
1570
|
/**
|
|
1571
|
+
* @public
|
|
1455
1572
|
* <p>The Amazon Resource Name (ARN) of the Config
|
|
1456
1573
|
* rule.</p>
|
|
1457
1574
|
*/
|
|
1458
1575
|
ConfigRuleArn?: string;
|
|
1459
1576
|
/**
|
|
1577
|
+
* @public
|
|
1460
1578
|
* <p>The ID of the Config rule.</p>
|
|
1461
1579
|
*/
|
|
1462
1580
|
ConfigRuleId?: string;
|
|
1463
1581
|
/**
|
|
1582
|
+
* @public
|
|
1464
1583
|
* <p>The description that you provide for the Config
|
|
1465
1584
|
* rule.</p>
|
|
1466
1585
|
*/
|
|
1467
1586
|
Description?: string;
|
|
1468
1587
|
/**
|
|
1588
|
+
* @public
|
|
1469
1589
|
* <p>Defines which resources can trigger an evaluation for the rule.
|
|
1470
1590
|
* The scope can include one or more resource types, a combination of
|
|
1471
1591
|
* one resource type and one resource ID, or a combination of a tag key
|
|
@@ -1479,17 +1599,20 @@ export interface ConfigRule {
|
|
|
1479
1599
|
*/
|
|
1480
1600
|
Scope?: Scope;
|
|
1481
1601
|
/**
|
|
1602
|
+
* @public
|
|
1482
1603
|
* <p>Provides the rule owner (<code>Amazon Web Services</code> for managed rules, <code>CUSTOM_POLICY</code> for Custom Policy rules, and <code>CUSTOM_LAMBDA</code> for Custom Lambda rules), the rule identifier,
|
|
1483
1604
|
* and the notifications that cause the function to evaluate your Amazon Web Services
|
|
1484
1605
|
* resources.</p>
|
|
1485
1606
|
*/
|
|
1486
1607
|
Source: Source | undefined;
|
|
1487
1608
|
/**
|
|
1609
|
+
* @public
|
|
1488
1610
|
* <p>A string, in JSON format, that is passed to the Config rule
|
|
1489
1611
|
* Lambda function.</p>
|
|
1490
1612
|
*/
|
|
1491
1613
|
InputParameters?: string;
|
|
1492
1614
|
/**
|
|
1615
|
+
* @public
|
|
1493
1616
|
* <p>The maximum frequency with which Config runs evaluations
|
|
1494
1617
|
* for a rule. You can specify a value for
|
|
1495
1618
|
* <code>MaximumExecutionFrequency</code> when:</p>
|
|
@@ -1512,6 +1635,7 @@ export interface ConfigRule {
|
|
|
1512
1635
|
*/
|
|
1513
1636
|
MaximumExecutionFrequency?: MaximumExecutionFrequency | string;
|
|
1514
1637
|
/**
|
|
1638
|
+
* @public
|
|
1515
1639
|
* <p>Indicates whether the Config rule is active or is currently
|
|
1516
1640
|
* being deleted by Config. It can also indicate the evaluation
|
|
1517
1641
|
* status for the Config rule.</p>
|
|
@@ -1531,6 +1655,7 @@ export interface ConfigRule {
|
|
|
1531
1655
|
*/
|
|
1532
1656
|
ConfigRuleState?: ConfigRuleState | string;
|
|
1533
1657
|
/**
|
|
1658
|
+
* @public
|
|
1534
1659
|
* <p>Service principal name of the service that created the
|
|
1535
1660
|
* rule.</p>
|
|
1536
1661
|
* <note>
|
|
@@ -1541,6 +1666,7 @@ export interface ConfigRule {
|
|
|
1541
1666
|
*/
|
|
1542
1667
|
CreatedBy?: string;
|
|
1543
1668
|
/**
|
|
1669
|
+
* @public
|
|
1544
1670
|
* <p>The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.</p>
|
|
1545
1671
|
*/
|
|
1546
1672
|
EvaluationModes?: EvaluationModeConfiguration[];
|
|
@@ -1552,10 +1678,12 @@ export interface ConfigRule {
|
|
|
1552
1678
|
*/
|
|
1553
1679
|
export interface ConfigRuleComplianceFilters {
|
|
1554
1680
|
/**
|
|
1681
|
+
* @public
|
|
1555
1682
|
* <p>The name of the Config rule.</p>
|
|
1556
1683
|
*/
|
|
1557
1684
|
ConfigRuleName?: string;
|
|
1558
1685
|
/**
|
|
1686
|
+
* @public
|
|
1559
1687
|
* <p>The rule compliance status.</p>
|
|
1560
1688
|
* <p>For the <code>ConfigRuleComplianceFilters</code> data type, Config supports only <code>COMPLIANT</code> and
|
|
1561
1689
|
* <code>NON_COMPLIANT</code>. Config does not support the
|
|
@@ -1564,11 +1692,13 @@ export interface ConfigRuleComplianceFilters {
|
|
|
1564
1692
|
*/
|
|
1565
1693
|
ComplianceType?: ComplianceType | string;
|
|
1566
1694
|
/**
|
|
1695
|
+
* @public
|
|
1567
1696
|
* <p>The 12-digit account ID of the source account.
|
|
1568
1697
|
* </p>
|
|
1569
1698
|
*/
|
|
1570
1699
|
AccountId?: string;
|
|
1571
1700
|
/**
|
|
1701
|
+
* @public
|
|
1572
1702
|
* <p>The source region where the data is aggregated.
|
|
1573
1703
|
* </p>
|
|
1574
1704
|
*/
|
|
@@ -1581,10 +1711,12 @@ export interface ConfigRuleComplianceFilters {
|
|
|
1581
1711
|
*/
|
|
1582
1712
|
export interface ConfigRuleComplianceSummaryFilters {
|
|
1583
1713
|
/**
|
|
1714
|
+
* @public
|
|
1584
1715
|
* <p>The 12-digit account ID of the source account.</p>
|
|
1585
1716
|
*/
|
|
1586
1717
|
AccountId?: string;
|
|
1587
1718
|
/**
|
|
1719
|
+
* @public
|
|
1588
1720
|
* <p>The source region where the data is aggregated.</p>
|
|
1589
1721
|
*/
|
|
1590
1722
|
AwsRegion?: string;
|
|
@@ -1611,57 +1743,69 @@ export type ConfigRuleComplianceSummaryGroupKey = (typeof ConfigRuleComplianceSu
|
|
|
1611
1743
|
*/
|
|
1612
1744
|
export interface ConfigRuleEvaluationStatus {
|
|
1613
1745
|
/**
|
|
1746
|
+
* @public
|
|
1614
1747
|
* <p>The name of the Config rule.</p>
|
|
1615
1748
|
*/
|
|
1616
1749
|
ConfigRuleName?: string;
|
|
1617
1750
|
/**
|
|
1751
|
+
* @public
|
|
1618
1752
|
* <p>The Amazon Resource Name (ARN) of the Config
|
|
1619
1753
|
* rule.</p>
|
|
1620
1754
|
*/
|
|
1621
1755
|
ConfigRuleArn?: string;
|
|
1622
1756
|
/**
|
|
1757
|
+
* @public
|
|
1623
1758
|
* <p>The ID of the Config rule.</p>
|
|
1624
1759
|
*/
|
|
1625
1760
|
ConfigRuleId?: string;
|
|
1626
1761
|
/**
|
|
1762
|
+
* @public
|
|
1627
1763
|
* <p>The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.</p>
|
|
1628
1764
|
*/
|
|
1629
1765
|
LastSuccessfulInvocationTime?: Date;
|
|
1630
1766
|
/**
|
|
1767
|
+
* @public
|
|
1631
1768
|
* <p>The time that Config last failed to invoke the Config
|
|
1632
1769
|
* rule to evaluate your Amazon Web Services resources.</p>
|
|
1633
1770
|
*/
|
|
1634
1771
|
LastFailedInvocationTime?: Date;
|
|
1635
1772
|
/**
|
|
1773
|
+
* @public
|
|
1636
1774
|
* <p>The time that Config last successfully evaluated your Amazon Web Services
|
|
1637
1775
|
* resources against the rule.</p>
|
|
1638
1776
|
*/
|
|
1639
1777
|
LastSuccessfulEvaluationTime?: Date;
|
|
1640
1778
|
/**
|
|
1779
|
+
* @public
|
|
1641
1780
|
* <p>The time that Config last failed to evaluate your Amazon Web Services
|
|
1642
1781
|
* resources against the rule.</p>
|
|
1643
1782
|
*/
|
|
1644
1783
|
LastFailedEvaluationTime?: Date;
|
|
1645
1784
|
/**
|
|
1785
|
+
* @public
|
|
1646
1786
|
* <p>The time that you first activated the Config
|
|
1647
1787
|
* rule.</p>
|
|
1648
1788
|
*/
|
|
1649
1789
|
FirstActivatedTime?: Date;
|
|
1650
1790
|
/**
|
|
1791
|
+
* @public
|
|
1651
1792
|
* <p>The time that you last turned off the Config rule.</p>
|
|
1652
1793
|
*/
|
|
1653
1794
|
LastDeactivatedTime?: Date;
|
|
1654
1795
|
/**
|
|
1796
|
+
* @public
|
|
1655
1797
|
* <p>The error code that Config returned when the rule last
|
|
1656
1798
|
* failed.</p>
|
|
1657
1799
|
*/
|
|
1658
1800
|
LastErrorCode?: string;
|
|
1659
1801
|
/**
|
|
1802
|
+
* @public
|
|
1660
1803
|
* <p>The error message that Config returned when the rule last
|
|
1661
1804
|
* failed.</p>
|
|
1662
1805
|
*/
|
|
1663
1806
|
LastErrorMessage?: string;
|
|
1664
1807
|
/**
|
|
1808
|
+
* @public
|
|
1665
1809
|
* <p>Indicates whether Config has evaluated your resources
|
|
1666
1810
|
* against the rule at least once.</p>
|
|
1667
1811
|
* <ul>
|
|
@@ -1680,15 +1824,18 @@ export interface ConfigRuleEvaluationStatus {
|
|
|
1680
1824
|
*/
|
|
1681
1825
|
FirstEvaluationStarted?: boolean;
|
|
1682
1826
|
/**
|
|
1827
|
+
* @public
|
|
1683
1828
|
* <p>The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either <code>Successful</code> or <code>Failed</code>.</p>
|
|
1684
1829
|
*/
|
|
1685
1830
|
LastDebugLogDeliveryStatus?: string;
|
|
1686
1831
|
/**
|
|
1832
|
+
* @public
|
|
1687
1833
|
* <p>The reason Config was not able to deliver a debug log. This is for the last
|
|
1688
1834
|
* failed attempt to retrieve a debug log for your Config Custom Policy rules.</p>
|
|
1689
1835
|
*/
|
|
1690
1836
|
LastDebugLogDeliveryStatusReason?: string;
|
|
1691
1837
|
/**
|
|
1838
|
+
* @public
|
|
1692
1839
|
* <p>The time Config last attempted to deliver a debug log for your Config Custom Policy rules.</p>
|
|
1693
1840
|
*/
|
|
1694
1841
|
LastDebugLogDeliveryTime?: Date;
|
|
@@ -1750,6 +1897,7 @@ export interface ConfigRuleEvaluationStatus {
|
|
|
1750
1897
|
*/
|
|
1751
1898
|
export interface ConfigSnapshotDeliveryProperties {
|
|
1752
1899
|
/**
|
|
1900
|
+
* @public
|
|
1753
1901
|
* <p>The frequency with which Config delivers configuration
|
|
1754
1902
|
* snapshots.</p>
|
|
1755
1903
|
*/
|
|
@@ -1762,6 +1910,7 @@ export interface ConfigSnapshotDeliveryProperties {
|
|
|
1762
1910
|
*/
|
|
1763
1911
|
export interface ConfigStreamDeliveryInfo {
|
|
1764
1912
|
/**
|
|
1913
|
+
* @public
|
|
1765
1914
|
* <p>Status of the last attempted delivery.</p>
|
|
1766
1915
|
* <p>
|
|
1767
1916
|
* <b>Note</b> Providing an SNS topic on a
|
|
@@ -1770,14 +1919,17 @@ export interface ConfigStreamDeliveryInfo {
|
|
|
1770
1919
|
*/
|
|
1771
1920
|
lastStatus?: DeliveryStatus | string;
|
|
1772
1921
|
/**
|
|
1922
|
+
* @public
|
|
1773
1923
|
* <p>The error code from the last attempted delivery.</p>
|
|
1774
1924
|
*/
|
|
1775
1925
|
lastErrorCode?: string;
|
|
1776
1926
|
/**
|
|
1927
|
+
* @public
|
|
1777
1928
|
* <p>The error message from the last attempted delivery.</p>
|
|
1778
1929
|
*/
|
|
1779
1930
|
lastErrorMessage?: string;
|
|
1780
1931
|
/**
|
|
1932
|
+
* @public
|
|
1781
1933
|
* <p>The time from the last status change.</p>
|
|
1782
1934
|
*/
|
|
1783
1935
|
lastStatusChangeTime?: Date;
|
|
@@ -1789,15 +1941,18 @@ export interface ConfigStreamDeliveryInfo {
|
|
|
1789
1941
|
*/
|
|
1790
1942
|
export interface OrganizationAggregationSource {
|
|
1791
1943
|
/**
|
|
1944
|
+
* @public
|
|
1792
1945
|
* <p>ARN of the IAM role used to retrieve Amazon Web Services Organization details
|
|
1793
1946
|
* associated with the aggregator account.</p>
|
|
1794
1947
|
*/
|
|
1795
1948
|
RoleArn: string | undefined;
|
|
1796
1949
|
/**
|
|
1950
|
+
* @public
|
|
1797
1951
|
* <p>The source regions being aggregated.</p>
|
|
1798
1952
|
*/
|
|
1799
1953
|
AwsRegions?: string[];
|
|
1800
1954
|
/**
|
|
1955
|
+
* @public
|
|
1801
1956
|
* <p>If true, aggregate existing Config regions and future
|
|
1802
1957
|
* regions.</p>
|
|
1803
1958
|
*/
|
|
@@ -1811,33 +1966,40 @@ export interface OrganizationAggregationSource {
|
|
|
1811
1966
|
*/
|
|
1812
1967
|
export interface ConfigurationAggregator {
|
|
1813
1968
|
/**
|
|
1969
|
+
* @public
|
|
1814
1970
|
* <p>The name of the aggregator.</p>
|
|
1815
1971
|
*/
|
|
1816
1972
|
ConfigurationAggregatorName?: string;
|
|
1817
1973
|
/**
|
|
1974
|
+
* @public
|
|
1818
1975
|
* <p>The Amazon Resource Name (ARN) of the aggregator.</p>
|
|
1819
1976
|
*/
|
|
1820
1977
|
ConfigurationAggregatorArn?: string;
|
|
1821
1978
|
/**
|
|
1979
|
+
* @public
|
|
1822
1980
|
* <p>Provides a list of source accounts and regions to be
|
|
1823
1981
|
* aggregated.</p>
|
|
1824
1982
|
*/
|
|
1825
1983
|
AccountAggregationSources?: AccountAggregationSource[];
|
|
1826
1984
|
/**
|
|
1985
|
+
* @public
|
|
1827
1986
|
* <p>Provides an organization and list of regions to be
|
|
1828
1987
|
* aggregated.</p>
|
|
1829
1988
|
*/
|
|
1830
1989
|
OrganizationAggregationSource?: OrganizationAggregationSource;
|
|
1831
1990
|
/**
|
|
1991
|
+
* @public
|
|
1832
1992
|
* <p>The time stamp when the configuration aggregator was
|
|
1833
1993
|
* created.</p>
|
|
1834
1994
|
*/
|
|
1835
1995
|
CreationTime?: Date;
|
|
1836
1996
|
/**
|
|
1997
|
+
* @public
|
|
1837
1998
|
* <p>The time of the last update.</p>
|
|
1838
1999
|
*/
|
|
1839
2000
|
LastUpdatedTime?: Date;
|
|
1840
2001
|
/**
|
|
2002
|
+
* @public
|
|
1841
2003
|
* <p>Amazon Web Services service that created the configuration aggregator.</p>
|
|
1842
2004
|
*/
|
|
1843
2005
|
CreatedBy?: string;
|
|
@@ -1849,20 +2011,24 @@ export interface ConfigurationAggregator {
|
|
|
1849
2011
|
*/
|
|
1850
2012
|
export interface Relationship {
|
|
1851
2013
|
/**
|
|
2014
|
+
* @public
|
|
1852
2015
|
* <p>The resource type of the related resource.</p>
|
|
1853
2016
|
*/
|
|
1854
2017
|
resourceType?: ResourceType | string;
|
|
1855
2018
|
/**
|
|
2019
|
+
* @public
|
|
1856
2020
|
* <p>The ID of the related resource (for example,
|
|
1857
2021
|
* <code>sg-xxxxxx</code>).</p>
|
|
1858
2022
|
*/
|
|
1859
2023
|
resourceId?: string;
|
|
1860
2024
|
/**
|
|
2025
|
+
* @public
|
|
1861
2026
|
* <p>The custom name of the related resource, if
|
|
1862
2027
|
* available.</p>
|
|
1863
2028
|
*/
|
|
1864
2029
|
resourceName?: string;
|
|
1865
2030
|
/**
|
|
2031
|
+
* @public
|
|
1866
2032
|
* <p>The type of relationship with the related resource.</p>
|
|
1867
2033
|
*/
|
|
1868
2034
|
relationshipName?: string;
|
|
@@ -1874,20 +2040,24 @@ export interface Relationship {
|
|
|
1874
2040
|
*/
|
|
1875
2041
|
export interface ConfigurationItem {
|
|
1876
2042
|
/**
|
|
2043
|
+
* @public
|
|
1877
2044
|
* <p>The version number of the resource configuration.</p>
|
|
1878
2045
|
*/
|
|
1879
2046
|
version?: string;
|
|
1880
2047
|
/**
|
|
2048
|
+
* @public
|
|
1881
2049
|
* <p>The 12-digit Amazon Web Services account ID associated with the
|
|
1882
2050
|
* resource.</p>
|
|
1883
2051
|
*/
|
|
1884
2052
|
accountId?: string;
|
|
1885
2053
|
/**
|
|
2054
|
+
* @public
|
|
1886
2055
|
* <p>The time when the configuration recording was
|
|
1887
2056
|
* initiated.</p>
|
|
1888
2057
|
*/
|
|
1889
2058
|
configurationItemCaptureTime?: Date;
|
|
1890
2059
|
/**
|
|
2060
|
+
* @public
|
|
1891
2061
|
* <p>The configuration item status. The valid values are:</p>
|
|
1892
2062
|
* <ul>
|
|
1893
2063
|
* <li>
|
|
@@ -1912,11 +2082,13 @@ export interface ConfigurationItem {
|
|
|
1912
2082
|
*/
|
|
1913
2083
|
configurationItemStatus?: ConfigurationItemStatus | string;
|
|
1914
2084
|
/**
|
|
2085
|
+
* @public
|
|
1915
2086
|
* <p>An identifier that indicates the ordering of the configuration
|
|
1916
2087
|
* items of a resource.</p>
|
|
1917
2088
|
*/
|
|
1918
2089
|
configurationStateId?: string;
|
|
1919
2090
|
/**
|
|
2091
|
+
* @public
|
|
1920
2092
|
* <p>Unique MD5 hash that represents the configuration item's
|
|
1921
2093
|
* state.</p>
|
|
1922
2094
|
* <p>You can use MD5 hash to compare the states of two or more
|
|
@@ -1925,40 +2097,49 @@ export interface ConfigurationItem {
|
|
|
1925
2097
|
*/
|
|
1926
2098
|
configurationItemMD5Hash?: string;
|
|
1927
2099
|
/**
|
|
2100
|
+
* @public
|
|
1928
2101
|
* <p>Amazon Resource Name (ARN) associated with the resource.</p>
|
|
1929
2102
|
*/
|
|
1930
2103
|
arn?: string;
|
|
1931
2104
|
/**
|
|
2105
|
+
* @public
|
|
1932
2106
|
* <p>The type of Amazon Web Services resource.</p>
|
|
1933
2107
|
*/
|
|
1934
2108
|
resourceType?: ResourceType | string;
|
|
1935
2109
|
/**
|
|
2110
|
+
* @public
|
|
1936
2111
|
* <p>The ID of the resource (for example,
|
|
1937
2112
|
* <code>sg-xxxxxx</code>).</p>
|
|
1938
2113
|
*/
|
|
1939
2114
|
resourceId?: string;
|
|
1940
2115
|
/**
|
|
2116
|
+
* @public
|
|
1941
2117
|
* <p>The custom name of the resource, if available.</p>
|
|
1942
2118
|
*/
|
|
1943
2119
|
resourceName?: string;
|
|
1944
2120
|
/**
|
|
2121
|
+
* @public
|
|
1945
2122
|
* <p>The region where the resource resides.</p>
|
|
1946
2123
|
*/
|
|
1947
2124
|
awsRegion?: string;
|
|
1948
2125
|
/**
|
|
2126
|
+
* @public
|
|
1949
2127
|
* <p>The Availability Zone associated with the resource.</p>
|
|
1950
2128
|
*/
|
|
1951
2129
|
availabilityZone?: string;
|
|
1952
2130
|
/**
|
|
2131
|
+
* @public
|
|
1953
2132
|
* <p>The time stamp when the resource was created.</p>
|
|
1954
2133
|
*/
|
|
1955
2134
|
resourceCreationTime?: Date;
|
|
1956
2135
|
/**
|
|
2136
|
+
* @public
|
|
1957
2137
|
* <p>A mapping of key value tags associated with the
|
|
1958
2138
|
* resource.</p>
|
|
1959
2139
|
*/
|
|
1960
2140
|
tags?: Record<string, string>;
|
|
1961
2141
|
/**
|
|
2142
|
+
* @public
|
|
1962
2143
|
* <p>A list of CloudTrail event IDs.</p>
|
|
1963
2144
|
* <p>A populated field indicates that the current configuration was
|
|
1964
2145
|
* initiated by the events recorded in the CloudTrail log. For more
|
|
@@ -1969,14 +2150,17 @@ export interface ConfigurationItem {
|
|
|
1969
2150
|
*/
|
|
1970
2151
|
relatedEvents?: string[];
|
|
1971
2152
|
/**
|
|
2153
|
+
* @public
|
|
1972
2154
|
* <p>A list of related Amazon Web Services resources.</p>
|
|
1973
2155
|
*/
|
|
1974
2156
|
relationships?: Relationship[];
|
|
1975
2157
|
/**
|
|
2158
|
+
* @public
|
|
1976
2159
|
* <p>The description of the resource configuration.</p>
|
|
1977
2160
|
*/
|
|
1978
2161
|
configuration?: string;
|
|
1979
2162
|
/**
|
|
2163
|
+
* @public
|
|
1980
2164
|
* <p>Configuration attributes that Config returns for certain
|
|
1981
2165
|
* resource types to supplement the information returned for the
|
|
1982
2166
|
* <code>configuration</code> parameter.</p>
|
|
@@ -1990,6 +2174,7 @@ export interface ConfigurationItem {
|
|
|
1990
2174
|
*/
|
|
1991
2175
|
export interface ExclusionByResourceTypes {
|
|
1992
2176
|
/**
|
|
2177
|
+
* @public
|
|
1993
2178
|
* <p>A comma-separated list of resource types to exclude from recording by the configuration
|
|
1994
2179
|
* recorder.</p>
|
|
1995
2180
|
*/
|
|
@@ -2014,6 +2199,7 @@ export type RecordingStrategyType = (typeof RecordingStrategyType)[keyof typeof
|
|
|
2014
2199
|
*/
|
|
2015
2200
|
export interface RecordingStrategy {
|
|
2016
2201
|
/**
|
|
2202
|
+
* @public
|
|
2017
2203
|
* <p>The recording strategy for the configuration recorder.</p>
|
|
2018
2204
|
* <ul>
|
|
2019
2205
|
* <li>
|
|
@@ -2077,6 +2263,7 @@ export interface RecordingStrategy {
|
|
|
2077
2263
|
*/
|
|
2078
2264
|
export interface RecordingGroup {
|
|
2079
2265
|
/**
|
|
2266
|
+
* @public
|
|
2080
2267
|
* <p>Specifies whether Config records configuration changes for all supported regional resource types.</p>
|
|
2081
2268
|
* <p>If you set this field to <code>true</code>, when Config
|
|
2082
2269
|
* adds support for a new type of regional resource, Config starts recording resources of that type automatically.</p>
|
|
@@ -2085,6 +2272,7 @@ export interface RecordingGroup {
|
|
|
2085
2272
|
*/
|
|
2086
2273
|
allSupported?: boolean;
|
|
2087
2274
|
/**
|
|
2275
|
+
* @public
|
|
2088
2276
|
* <p>Specifies whether Config records configuration changes for all supported global resources.</p>
|
|
2089
2277
|
* <p>Before you set this field to <code>true</code>,
|
|
2090
2278
|
* set the <code>allSupported</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html">RecordingGroup</a> to
|
|
@@ -2101,6 +2289,7 @@ export interface RecordingGroup {
|
|
|
2101
2289
|
*/
|
|
2102
2290
|
includeGlobalResourceTypes?: boolean;
|
|
2103
2291
|
/**
|
|
2292
|
+
* @public
|
|
2104
2293
|
* <p>A comma-separated list that specifies which resource types Config
|
|
2105
2294
|
* records.</p>
|
|
2106
2295
|
* <p>Optionally, you can set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>INCLUSION_BY_RESOURCE_TYPES</code>.</p>
|
|
@@ -2126,11 +2315,13 @@ export interface RecordingGroup {
|
|
|
2126
2315
|
*/
|
|
2127
2316
|
resourceTypes?: (ResourceType | string)[];
|
|
2128
2317
|
/**
|
|
2318
|
+
* @public
|
|
2129
2319
|
* <p>An object that specifies how Config excludes resource types from being recorded by the configuration recorder.</p>
|
|
2130
2320
|
* <p>To use this option, you must set the <code>useOnly</code> field of <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html">RecordingStrategy</a> to <code>EXCLUSION_BY_RESOURCE_TYPES</code>.</p>
|
|
2131
2321
|
*/
|
|
2132
2322
|
exclusionByResourceTypes?: ExclusionByResourceTypes;
|
|
2133
2323
|
/**
|
|
2324
|
+
* @public
|
|
2134
2325
|
* <p>An object that specifies the recording strategy for the configuration recorder.</p>
|
|
2135
2326
|
* <ul>
|
|
2136
2327
|
* <li>
|
|
@@ -2172,11 +2363,13 @@ export interface RecordingGroup {
|
|
|
2172
2363
|
*/
|
|
2173
2364
|
export interface ConfigurationRecorder {
|
|
2174
2365
|
/**
|
|
2366
|
+
* @public
|
|
2175
2367
|
* <p>The name of the configuration recorder. Config automatically assigns the name of "default" when creating the configuration recorder.</p>
|
|
2176
2368
|
* <p>You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name. </p>
|
|
2177
2369
|
*/
|
|
2178
2370
|
name?: string;
|
|
2179
2371
|
/**
|
|
2372
|
+
* @public
|
|
2180
2373
|
* <p>Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.</p>
|
|
2181
2374
|
* <note>
|
|
2182
2375
|
* <p>While the API model does not require this field, the server will reject a request without a defined <code>roleARN</code> for the configuration recorder.</p>
|
|
@@ -2203,6 +2396,7 @@ export interface ConfigurationRecorder {
|
|
|
2203
2396
|
*/
|
|
2204
2397
|
roleARN?: string;
|
|
2205
2398
|
/**
|
|
2399
|
+
* @public
|
|
2206
2400
|
* <p>Specifies which resource types Config
|
|
2207
2401
|
* records for configuration changes.</p>
|
|
2208
2402
|
* <note>
|
|
@@ -2245,35 +2439,43 @@ export type RecorderStatus = (typeof RecorderStatus)[keyof typeof RecorderStatus
|
|
|
2245
2439
|
*/
|
|
2246
2440
|
export interface ConfigurationRecorderStatus {
|
|
2247
2441
|
/**
|
|
2442
|
+
* @public
|
|
2248
2443
|
* <p>The name of the configuration recorder.</p>
|
|
2249
2444
|
*/
|
|
2250
2445
|
name?: string;
|
|
2251
2446
|
/**
|
|
2447
|
+
* @public
|
|
2252
2448
|
* <p>The time the recorder was last started.</p>
|
|
2253
2449
|
*/
|
|
2254
2450
|
lastStartTime?: Date;
|
|
2255
2451
|
/**
|
|
2452
|
+
* @public
|
|
2256
2453
|
* <p>The time the recorder was last stopped.</p>
|
|
2257
2454
|
*/
|
|
2258
2455
|
lastStopTime?: Date;
|
|
2259
2456
|
/**
|
|
2457
|
+
* @public
|
|
2260
2458
|
* <p>Specifies whether or not the recorder is currently
|
|
2261
2459
|
* recording.</p>
|
|
2262
2460
|
*/
|
|
2263
2461
|
recording?: boolean;
|
|
2264
2462
|
/**
|
|
2463
|
+
* @public
|
|
2265
2464
|
* <p>The status of the latest recording event processed by the recorder.</p>
|
|
2266
2465
|
*/
|
|
2267
2466
|
lastStatus?: RecorderStatus | string;
|
|
2268
2467
|
/**
|
|
2468
|
+
* @public
|
|
2269
2469
|
* <p>The latest error code from when the recorder last failed.</p>
|
|
2270
2470
|
*/
|
|
2271
2471
|
lastErrorCode?: string;
|
|
2272
2472
|
/**
|
|
2473
|
+
* @public
|
|
2273
2474
|
* <p>The latest error message from when the recorder last failed.</p>
|
|
2274
2475
|
*/
|
|
2275
2476
|
lastErrorMessage?: string;
|
|
2276
2477
|
/**
|
|
2478
|
+
* @public
|
|
2277
2479
|
* <p>The time of the latest change in status of an recording event processed by the recorder.</p>
|
|
2278
2480
|
*/
|
|
2279
2481
|
lastStatusChangeTime?: Date;
|
|
@@ -2284,10 +2486,12 @@ export interface ConfigurationRecorderStatus {
|
|
|
2284
2486
|
*/
|
|
2285
2487
|
export interface ConformancePackComplianceFilters {
|
|
2286
2488
|
/**
|
|
2489
|
+
* @public
|
|
2287
2490
|
* <p>Filters the results by Config rule names.</p>
|
|
2288
2491
|
*/
|
|
2289
2492
|
ConfigRuleNames?: string[];
|
|
2290
2493
|
/**
|
|
2494
|
+
* @public
|
|
2291
2495
|
* <p>Filters the results by compliance.</p>
|
|
2292
2496
|
* <p>The allowed values are <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. <code>INSUFFICIENT_DATA</code> is not supported.</p>
|
|
2293
2497
|
*/
|
|
@@ -2301,14 +2505,17 @@ export interface ConformancePackComplianceFilters {
|
|
|
2301
2505
|
*/
|
|
2302
2506
|
export interface ConformancePackComplianceScore {
|
|
2303
2507
|
/**
|
|
2508
|
+
* @public
|
|
2304
2509
|
* <p>Compliance score for the conformance pack. Conformance packs with no evaluation results will have a compliance score of <code>INSUFFICIENT_DATA</code>.</p>
|
|
2305
2510
|
*/
|
|
2306
2511
|
Score?: string;
|
|
2307
2512
|
/**
|
|
2513
|
+
* @public
|
|
2308
2514
|
* <p>The name of the conformance pack.</p>
|
|
2309
2515
|
*/
|
|
2310
2516
|
ConformancePackName?: string;
|
|
2311
2517
|
/**
|
|
2518
|
+
* @public
|
|
2312
2519
|
* <p>The time that the conformance pack compliance score was last updated.</p>
|
|
2313
2520
|
*/
|
|
2314
2521
|
LastUpdatedTime?: Date;
|
|
@@ -2319,6 +2526,7 @@ export interface ConformancePackComplianceScore {
|
|
|
2319
2526
|
*/
|
|
2320
2527
|
export interface ConformancePackComplianceScoresFilters {
|
|
2321
2528
|
/**
|
|
2529
|
+
* @public
|
|
2322
2530
|
* <p>The names of the conformance packs whose compliance scores you want to include in the conformance pack compliance score result set.
|
|
2323
2531
|
* You can include up to 25 conformance packs in the <code>ConformancePackNames</code> array of strings, each with a character limit of 256 characters for the conformance pack name.</p>
|
|
2324
2532
|
*/
|
|
@@ -2330,10 +2538,12 @@ export interface ConformancePackComplianceScoresFilters {
|
|
|
2330
2538
|
*/
|
|
2331
2539
|
export interface ConformancePackComplianceSummary {
|
|
2332
2540
|
/**
|
|
2541
|
+
* @public
|
|
2333
2542
|
* <p>The name of the conformance pack name.</p>
|
|
2334
2543
|
*/
|
|
2335
2544
|
ConformancePackName: string | undefined;
|
|
2336
2545
|
/**
|
|
2546
|
+
* @public
|
|
2337
2547
|
* <p>The status of the conformance pack.</p>
|
|
2338
2548
|
*/
|
|
2339
2549
|
ConformancePackComplianceStatus: ConformancePackComplianceType | string | undefined;
|
|
@@ -2345,10 +2555,12 @@ export interface ConformancePackComplianceSummary {
|
|
|
2345
2555
|
*/
|
|
2346
2556
|
export interface ConformancePackInputParameter {
|
|
2347
2557
|
/**
|
|
2558
|
+
* @public
|
|
2348
2559
|
* <p>One part of a key-value pair.</p>
|
|
2349
2560
|
*/
|
|
2350
2561
|
ParameterName: string | undefined;
|
|
2351
2562
|
/**
|
|
2563
|
+
* @public
|
|
2352
2564
|
* <p>Another part of the key-value pair. </p>
|
|
2353
2565
|
*/
|
|
2354
2566
|
ParameterValue: string | undefined;
|
|
@@ -2361,11 +2573,13 @@ export interface ConformancePackInputParameter {
|
|
|
2361
2573
|
*/
|
|
2362
2574
|
export interface TemplateSSMDocumentDetails {
|
|
2363
2575
|
/**
|
|
2576
|
+
* @public
|
|
2364
2577
|
* <p>The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.
|
|
2365
2578
|
* If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.</p>
|
|
2366
2579
|
*/
|
|
2367
2580
|
DocumentName: string | undefined;
|
|
2368
2581
|
/**
|
|
2582
|
+
* @public
|
|
2369
2583
|
* <p>The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.</p>
|
|
2370
2584
|
* <note>
|
|
2371
2585
|
* <p>This field is optional.</p>
|
|
@@ -2379,18 +2593,22 @@ export interface TemplateSSMDocumentDetails {
|
|
|
2379
2593
|
*/
|
|
2380
2594
|
export interface ConformancePackDetail {
|
|
2381
2595
|
/**
|
|
2596
|
+
* @public
|
|
2382
2597
|
* <p>Name of the conformance pack.</p>
|
|
2383
2598
|
*/
|
|
2384
2599
|
ConformancePackName: string | undefined;
|
|
2385
2600
|
/**
|
|
2601
|
+
* @public
|
|
2386
2602
|
* <p>Amazon Resource Name (ARN) of the conformance pack.</p>
|
|
2387
2603
|
*/
|
|
2388
2604
|
ConformancePackArn: string | undefined;
|
|
2389
2605
|
/**
|
|
2606
|
+
* @public
|
|
2390
2607
|
* <p>ID of the conformance pack.</p>
|
|
2391
2608
|
*/
|
|
2392
2609
|
ConformancePackId: string | undefined;
|
|
2393
2610
|
/**
|
|
2611
|
+
* @public
|
|
2394
2612
|
* <p>The name of the Amazon S3 bucket where Config stores conformance pack templates. </p>
|
|
2395
2613
|
* <note>
|
|
2396
2614
|
* <p>This field is optional.</p>
|
|
@@ -2398,6 +2616,7 @@ export interface ConformancePackDetail {
|
|
|
2398
2616
|
*/
|
|
2399
2617
|
DeliveryS3Bucket?: string;
|
|
2400
2618
|
/**
|
|
2619
|
+
* @public
|
|
2401
2620
|
* <p>The prefix for the Amazon S3 bucket.</p>
|
|
2402
2621
|
* <note>
|
|
2403
2622
|
* <p>This field is optional.</p>
|
|
@@ -2405,18 +2624,22 @@ export interface ConformancePackDetail {
|
|
|
2405
2624
|
*/
|
|
2406
2625
|
DeliveryS3KeyPrefix?: string;
|
|
2407
2626
|
/**
|
|
2627
|
+
* @public
|
|
2408
2628
|
* <p>A list of <code>ConformancePackInputParameter</code> objects.</p>
|
|
2409
2629
|
*/
|
|
2410
2630
|
ConformancePackInputParameters?: ConformancePackInputParameter[];
|
|
2411
2631
|
/**
|
|
2632
|
+
* @public
|
|
2412
2633
|
* <p>The last time a conformation pack update was requested. </p>
|
|
2413
2634
|
*/
|
|
2414
2635
|
LastUpdateRequestedTime?: Date;
|
|
2415
2636
|
/**
|
|
2637
|
+
* @public
|
|
2416
2638
|
* <p>The Amazon Web Services service that created the conformance pack.</p>
|
|
2417
2639
|
*/
|
|
2418
2640
|
CreatedBy?: string;
|
|
2419
2641
|
/**
|
|
2642
|
+
* @public
|
|
2420
2643
|
* <p>An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.</p>
|
|
2421
2644
|
*/
|
|
2422
2645
|
TemplateSSMDocumentDetails?: TemplateSSMDocumentDetails;
|
|
@@ -2427,19 +2650,23 @@ export interface ConformancePackDetail {
|
|
|
2427
2650
|
*/
|
|
2428
2651
|
export interface ConformancePackEvaluationFilters {
|
|
2429
2652
|
/**
|
|
2653
|
+
* @public
|
|
2430
2654
|
* <p>Filters the results by Config rule names.</p>
|
|
2431
2655
|
*/
|
|
2432
2656
|
ConfigRuleNames?: string[];
|
|
2433
2657
|
/**
|
|
2658
|
+
* @public
|
|
2434
2659
|
* <p>Filters the results by compliance.</p>
|
|
2435
2660
|
* <p>The allowed values are <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. <code>INSUFFICIENT_DATA</code> is not supported.</p>
|
|
2436
2661
|
*/
|
|
2437
2662
|
ComplianceType?: ConformancePackComplianceType | string;
|
|
2438
2663
|
/**
|
|
2664
|
+
* @public
|
|
2439
2665
|
* <p>Filters the results by the resource type (for example, <code>"AWS::EC2::Instance"</code>). </p>
|
|
2440
2666
|
*/
|
|
2441
2667
|
ResourceType?: string;
|
|
2442
2668
|
/**
|
|
2669
|
+
* @public
|
|
2443
2670
|
* <p>Filters the results by resource IDs.</p>
|
|
2444
2671
|
* <note>
|
|
2445
2672
|
* <p>This is valid only when you provide resource type. If there is no resource type, you will see an error.</p>
|
|
@@ -2453,22 +2680,27 @@ export interface ConformancePackEvaluationFilters {
|
|
|
2453
2680
|
*/
|
|
2454
2681
|
export interface ConformancePackEvaluationResult {
|
|
2455
2682
|
/**
|
|
2683
|
+
* @public
|
|
2456
2684
|
* <p>The compliance type. The allowed values are <code>COMPLIANT</code> and <code>NON_COMPLIANT</code>. <code>INSUFFICIENT_DATA</code> is not supported.</p>
|
|
2457
2685
|
*/
|
|
2458
2686
|
ComplianceType: ConformancePackComplianceType | string | undefined;
|
|
2459
2687
|
/**
|
|
2688
|
+
* @public
|
|
2460
2689
|
* <p>Uniquely identifies an evaluation result.</p>
|
|
2461
2690
|
*/
|
|
2462
2691
|
EvaluationResultIdentifier: EvaluationResultIdentifier | undefined;
|
|
2463
2692
|
/**
|
|
2693
|
+
* @public
|
|
2464
2694
|
* <p>The time when Config rule evaluated Amazon Web Services resource.</p>
|
|
2465
2695
|
*/
|
|
2466
2696
|
ConfigRuleInvokedTime: Date | undefined;
|
|
2467
2697
|
/**
|
|
2698
|
+
* @public
|
|
2468
2699
|
* <p>The time when Config recorded the evaluation result. </p>
|
|
2469
2700
|
*/
|
|
2470
2701
|
ResultRecordedTime: Date | undefined;
|
|
2471
2702
|
/**
|
|
2703
|
+
* @public
|
|
2472
2704
|
* <p>Supplementary information about how the evaluation determined the compliance. </p>
|
|
2473
2705
|
*/
|
|
2474
2706
|
Annotation?: string;
|
|
@@ -2479,14 +2711,17 @@ export interface ConformancePackEvaluationResult {
|
|
|
2479
2711
|
*/
|
|
2480
2712
|
export interface ConformancePackRuleCompliance {
|
|
2481
2713
|
/**
|
|
2714
|
+
* @public
|
|
2482
2715
|
* <p>Name of the Config rule.</p>
|
|
2483
2716
|
*/
|
|
2484
2717
|
ConfigRuleName?: string;
|
|
2485
2718
|
/**
|
|
2719
|
+
* @public
|
|
2486
2720
|
* <p>Compliance of the Config rule.</p>
|
|
2487
2721
|
*/
|
|
2488
2722
|
ComplianceType?: ConformancePackComplianceType | string;
|
|
2489
2723
|
/**
|
|
2724
|
+
* @public
|
|
2490
2725
|
* <p>Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives.
|
|
2491
2726
|
* A control can align with a specific compliance regime or map to internal controls defined by an organization.</p>
|
|
2492
2727
|
*/
|
|
@@ -2513,18 +2748,22 @@ export type ConformancePackState = (typeof ConformancePackState)[keyof typeof Co
|
|
|
2513
2748
|
*/
|
|
2514
2749
|
export interface ConformancePackStatusDetail {
|
|
2515
2750
|
/**
|
|
2751
|
+
* @public
|
|
2516
2752
|
* <p>Name of the conformance pack.</p>
|
|
2517
2753
|
*/
|
|
2518
2754
|
ConformancePackName: string | undefined;
|
|
2519
2755
|
/**
|
|
2756
|
+
* @public
|
|
2520
2757
|
* <p>ID of the conformance pack.</p>
|
|
2521
2758
|
*/
|
|
2522
2759
|
ConformancePackId: string | undefined;
|
|
2523
2760
|
/**
|
|
2761
|
+
* @public
|
|
2524
2762
|
* <p>Amazon Resource Name (ARN) of comformance pack.</p>
|
|
2525
2763
|
*/
|
|
2526
2764
|
ConformancePackArn: string | undefined;
|
|
2527
2765
|
/**
|
|
2766
|
+
* @public
|
|
2528
2767
|
* <p>Indicates deployment status of conformance pack.</p>
|
|
2529
2768
|
* <p>Config sets the state of the conformance pack to:</p>
|
|
2530
2769
|
* <ul>
|
|
@@ -2547,18 +2786,22 @@ export interface ConformancePackStatusDetail {
|
|
|
2547
2786
|
*/
|
|
2548
2787
|
ConformancePackState: ConformancePackState | string | undefined;
|
|
2549
2788
|
/**
|
|
2789
|
+
* @public
|
|
2550
2790
|
* <p>Amazon Resource Name (ARN) of CloudFormation stack. </p>
|
|
2551
2791
|
*/
|
|
2552
2792
|
StackArn: string | undefined;
|
|
2553
2793
|
/**
|
|
2794
|
+
* @public
|
|
2554
2795
|
* <p>The reason of conformance pack creation failure.</p>
|
|
2555
2796
|
*/
|
|
2556
2797
|
ConformancePackStatusReason?: string;
|
|
2557
2798
|
/**
|
|
2799
|
+
* @public
|
|
2558
2800
|
* <p>Last time when conformation pack creation and update was requested.</p>
|
|
2559
2801
|
*/
|
|
2560
2802
|
LastUpdateRequestedTime: Date | undefined;
|
|
2561
2803
|
/**
|
|
2804
|
+
* @public
|
|
2562
2805
|
* <p>Last time when conformation pack creation and update was successful.</p>
|
|
2563
2806
|
*/
|
|
2564
2807
|
LastUpdateCompletedTime?: Date;
|
|
@@ -2580,11 +2823,13 @@ export declare class ConformancePackTemplateValidationException extends __BaseEx
|
|
|
2580
2823
|
*/
|
|
2581
2824
|
export interface DeleteAggregationAuthorizationRequest {
|
|
2582
2825
|
/**
|
|
2826
|
+
* @public
|
|
2583
2827
|
* <p>The 12-digit account ID of the account authorized to aggregate
|
|
2584
2828
|
* data.</p>
|
|
2585
2829
|
*/
|
|
2586
2830
|
AuthorizedAccountId: string | undefined;
|
|
2587
2831
|
/**
|
|
2832
|
+
* @public
|
|
2588
2833
|
* <p>The region authorized to collect aggregated data.</p>
|
|
2589
2834
|
*/
|
|
2590
2835
|
AuthorizedAwsRegion: string | undefined;
|
|
@@ -2608,6 +2853,7 @@ export declare class InvalidParameterValueException extends __BaseException {
|
|
|
2608
2853
|
*/
|
|
2609
2854
|
export interface DeleteConfigRuleRequest {
|
|
2610
2855
|
/**
|
|
2856
|
+
* @public
|
|
2611
2857
|
* <p>The name of the Config rule that you want to
|
|
2612
2858
|
* delete.</p>
|
|
2613
2859
|
*/
|
|
@@ -2665,6 +2911,7 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
2665
2911
|
*/
|
|
2666
2912
|
export interface DeleteConfigurationAggregatorRequest {
|
|
2667
2913
|
/**
|
|
2914
|
+
* @public
|
|
2668
2915
|
* <p>The name of the configuration aggregator.</p>
|
|
2669
2916
|
*/
|
|
2670
2917
|
ConfigurationAggregatorName: string | undefined;
|
|
@@ -2676,6 +2923,7 @@ export interface DeleteConfigurationAggregatorRequest {
|
|
|
2676
2923
|
*/
|
|
2677
2924
|
export interface DeleteConfigurationRecorderRequest {
|
|
2678
2925
|
/**
|
|
2926
|
+
* @public
|
|
2679
2927
|
* <p>The name of the configuration recorder to be deleted. You can
|
|
2680
2928
|
* retrieve the name of your configuration recorder by using the
|
|
2681
2929
|
* <code>DescribeConfigurationRecorders</code> action.</p>
|
|
@@ -2700,6 +2948,7 @@ export declare class NoSuchConfigurationRecorderException extends __BaseExceptio
|
|
|
2700
2948
|
*/
|
|
2701
2949
|
export interface DeleteConformancePackRequest {
|
|
2702
2950
|
/**
|
|
2951
|
+
* @public
|
|
2703
2952
|
* <p>Name of the conformance pack you want to delete.</p>
|
|
2704
2953
|
*/
|
|
2705
2954
|
ConformancePackName: string | undefined;
|
|
@@ -2724,6 +2973,7 @@ export declare class NoSuchConformancePackException extends __BaseException {
|
|
|
2724
2973
|
*/
|
|
2725
2974
|
export interface DeleteDeliveryChannelRequest {
|
|
2726
2975
|
/**
|
|
2976
|
+
* @public
|
|
2727
2977
|
* <p>The name of the delivery channel to delete.</p>
|
|
2728
2978
|
*/
|
|
2729
2979
|
DeliveryChannelName: string | undefined;
|
|
@@ -2760,6 +3010,7 @@ export declare class NoSuchDeliveryChannelException extends __BaseException {
|
|
|
2760
3010
|
*/
|
|
2761
3011
|
export interface DeleteEvaluationResultsRequest {
|
|
2762
3012
|
/**
|
|
3013
|
+
* @public
|
|
2763
3014
|
* <p>The name of the Config rule for which you want to delete
|
|
2764
3015
|
* the evaluation results.</p>
|
|
2765
3016
|
*/
|
|
@@ -2777,6 +3028,7 @@ export interface DeleteEvaluationResultsResponse {
|
|
|
2777
3028
|
*/
|
|
2778
3029
|
export interface DeleteOrganizationConfigRuleRequest {
|
|
2779
3030
|
/**
|
|
3031
|
+
* @public
|
|
2780
3032
|
* <p>The name of organization Config rule that you want to delete.</p>
|
|
2781
3033
|
*/
|
|
2782
3034
|
OrganizationConfigRuleName: string | undefined;
|
|
@@ -2828,6 +3080,7 @@ export declare class OrganizationAccessDeniedException extends __BaseException {
|
|
|
2828
3080
|
*/
|
|
2829
3081
|
export interface DeleteOrganizationConformancePackRequest {
|
|
2830
3082
|
/**
|
|
3083
|
+
* @public
|
|
2831
3084
|
* <p>The name of organization conformance pack that you want to delete.</p>
|
|
2832
3085
|
*/
|
|
2833
3086
|
OrganizationConformancePackName: string | undefined;
|
|
@@ -2850,11 +3103,13 @@ export declare class NoSuchOrganizationConformancePackException extends __BaseEx
|
|
|
2850
3103
|
*/
|
|
2851
3104
|
export interface DeletePendingAggregationRequestRequest {
|
|
2852
3105
|
/**
|
|
3106
|
+
* @public
|
|
2853
3107
|
* <p>The 12-digit account ID of the account requesting to aggregate
|
|
2854
3108
|
* data.</p>
|
|
2855
3109
|
*/
|
|
2856
3110
|
RequesterAccountId: string | undefined;
|
|
2857
3111
|
/**
|
|
3112
|
+
* @public
|
|
2858
3113
|
* <p>The region requesting to aggregate data.</p>
|
|
2859
3114
|
*/
|
|
2860
3115
|
RequesterAwsRegion: string | undefined;
|
|
@@ -2864,10 +3119,12 @@ export interface DeletePendingAggregationRequestRequest {
|
|
|
2864
3119
|
*/
|
|
2865
3120
|
export interface DeleteRemediationConfigurationRequest {
|
|
2866
3121
|
/**
|
|
3122
|
+
* @public
|
|
2867
3123
|
* <p>The name of the Config rule for which you want to delete remediation configuration.</p>
|
|
2868
3124
|
*/
|
|
2869
3125
|
ConfigRuleName: string | undefined;
|
|
2870
3126
|
/**
|
|
3127
|
+
* @public
|
|
2871
3128
|
* <p>The type of a resource.</p>
|
|
2872
3129
|
*/
|
|
2873
3130
|
ResourceType?: string;
|
|
@@ -2941,10 +3198,12 @@ export declare class RemediationInProgressException extends __BaseException {
|
|
|
2941
3198
|
*/
|
|
2942
3199
|
export interface RemediationExceptionResourceKey {
|
|
2943
3200
|
/**
|
|
3201
|
+
* @public
|
|
2944
3202
|
* <p>The type of a resource.</p>
|
|
2945
3203
|
*/
|
|
2946
3204
|
ResourceType?: string;
|
|
2947
3205
|
/**
|
|
3206
|
+
* @public
|
|
2948
3207
|
* <p>The ID of the resource (for example., sg-xxxxxx).</p>
|
|
2949
3208
|
*/
|
|
2950
3209
|
ResourceId?: string;
|
|
@@ -2954,10 +3213,12 @@ export interface RemediationExceptionResourceKey {
|
|
|
2954
3213
|
*/
|
|
2955
3214
|
export interface DeleteRemediationExceptionsRequest {
|
|
2956
3215
|
/**
|
|
3216
|
+
* @public
|
|
2957
3217
|
* <p>The name of the Config rule for which you want to delete remediation exception configuration.</p>
|
|
2958
3218
|
*/
|
|
2959
3219
|
ConfigRuleName: string | undefined;
|
|
2960
3220
|
/**
|
|
3221
|
+
* @public
|
|
2961
3222
|
* <p>An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys. </p>
|
|
2962
3223
|
*/
|
|
2963
3224
|
ResourceKeys: RemediationExceptionResourceKey[] | undefined;
|
|
@@ -2968,10 +3229,12 @@ export interface DeleteRemediationExceptionsRequest {
|
|
|
2968
3229
|
*/
|
|
2969
3230
|
export interface FailedDeleteRemediationExceptionsBatch {
|
|
2970
3231
|
/**
|
|
3232
|
+
* @public
|
|
2971
3233
|
* <p>Returns a failure message for delete remediation exception. For example, Config creates an exception due to an internal error.</p>
|
|
2972
3234
|
*/
|
|
2973
3235
|
FailureMessage?: string;
|
|
2974
3236
|
/**
|
|
3237
|
+
* @public
|
|
2975
3238
|
* <p>Returns remediation exception resource key object of the failed items.</p>
|
|
2976
3239
|
*/
|
|
2977
3240
|
FailedItems?: RemediationExceptionResourceKey[];
|
|
@@ -2981,6 +3244,7 @@ export interface FailedDeleteRemediationExceptionsBatch {
|
|
|
2981
3244
|
*/
|
|
2982
3245
|
export interface DeleteRemediationExceptionsResponse {
|
|
2983
3246
|
/**
|
|
3247
|
+
* @public
|
|
2984
3248
|
* <p>Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.</p>
|
|
2985
3249
|
*/
|
|
2986
3250
|
FailedBatches?: FailedDeleteRemediationExceptionsBatch[];
|
|
@@ -3002,10 +3266,12 @@ export declare class NoSuchRemediationExceptionException extends __BaseException
|
|
|
3002
3266
|
*/
|
|
3003
3267
|
export interface DeleteResourceConfigRequest {
|
|
3004
3268
|
/**
|
|
3269
|
+
* @public
|
|
3005
3270
|
* <p>The type of the resource.</p>
|
|
3006
3271
|
*/
|
|
3007
3272
|
ResourceType: string | undefined;
|
|
3008
3273
|
/**
|
|
3274
|
+
* @public
|
|
3009
3275
|
* <p>Unique identifier of the resource.</p>
|
|
3010
3276
|
*/
|
|
3011
3277
|
ResourceId: string | undefined;
|
|
@@ -3027,6 +3293,7 @@ export declare class NoRunningConfigurationRecorderException extends __BaseExcep
|
|
|
3027
3293
|
*/
|
|
3028
3294
|
export interface DeleteRetentionConfigurationRequest {
|
|
3029
3295
|
/**
|
|
3296
|
+
* @public
|
|
3030
3297
|
* <p>The name of the retention configuration to delete.</p>
|
|
3031
3298
|
*/
|
|
3032
3299
|
RetentionConfigurationName: string | undefined;
|
|
@@ -3048,6 +3315,7 @@ export declare class NoSuchRetentionConfigurationException extends __BaseExcepti
|
|
|
3048
3315
|
*/
|
|
3049
3316
|
export interface DeleteStoredQueryRequest {
|
|
3050
3317
|
/**
|
|
3318
|
+
* @public
|
|
3051
3319
|
* <p>The name of the query that you want to delete.</p>
|
|
3052
3320
|
*/
|
|
3053
3321
|
QueryName: string | undefined;
|
|
@@ -3076,6 +3344,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
3076
3344
|
*/
|
|
3077
3345
|
export interface DeliverConfigSnapshotRequest {
|
|
3078
3346
|
/**
|
|
3347
|
+
* @public
|
|
3079
3348
|
* <p>The name of the delivery channel through which the snapshot is
|
|
3080
3349
|
* delivered.</p>
|
|
3081
3350
|
*/
|
|
@@ -3088,6 +3357,7 @@ export interface DeliverConfigSnapshotRequest {
|
|
|
3088
3357
|
*/
|
|
3089
3358
|
export interface DeliverConfigSnapshotResponse {
|
|
3090
3359
|
/**
|
|
3360
|
+
* @public
|
|
3091
3361
|
* <p>The ID of the snapshot that is being created.</p>
|
|
3092
3362
|
*/
|
|
3093
3363
|
configSnapshotId?: string;
|
|
@@ -3099,6 +3369,7 @@ export interface DeliverConfigSnapshotResponse {
|
|
|
3099
3369
|
*/
|
|
3100
3370
|
export interface DeliveryChannel {
|
|
3101
3371
|
/**
|
|
3372
|
+
* @public
|
|
3102
3373
|
* <p>The name of the delivery channel. By default, Config
|
|
3103
3374
|
* assigns the name "default" when creating the delivery channel. To
|
|
3104
3375
|
* change the delivery channel name, you must use the
|
|
@@ -3108,6 +3379,7 @@ export interface DeliveryChannel {
|
|
|
3108
3379
|
*/
|
|
3109
3380
|
name?: string;
|
|
3110
3381
|
/**
|
|
3382
|
+
* @public
|
|
3111
3383
|
* <p>The name of the Amazon S3 bucket to which Config delivers
|
|
3112
3384
|
* configuration snapshots and configuration history files.</p>
|
|
3113
3385
|
* <p>If you specify a bucket that belongs to another Amazon Web Services account,
|
|
@@ -3116,15 +3388,18 @@ export interface DeliveryChannel {
|
|
|
3116
3388
|
*/
|
|
3117
3389
|
s3BucketName?: string;
|
|
3118
3390
|
/**
|
|
3391
|
+
* @public
|
|
3119
3392
|
* <p>The prefix for the specified Amazon S3 bucket.</p>
|
|
3120
3393
|
*/
|
|
3121
3394
|
s3KeyPrefix?: string;
|
|
3122
3395
|
/**
|
|
3396
|
+
* @public
|
|
3123
3397
|
* <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config.
|
|
3124
3398
|
* Must belong to the same Region as the destination S3 bucket.</p>
|
|
3125
3399
|
*/
|
|
3126
3400
|
s3KmsKeyArn?: string;
|
|
3127
3401
|
/**
|
|
3402
|
+
* @public
|
|
3128
3403
|
* <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which
|
|
3129
3404
|
* Config sends notifications about configuration
|
|
3130
3405
|
* changes.</p>
|
|
@@ -3135,6 +3410,7 @@ export interface DeliveryChannel {
|
|
|
3135
3410
|
*/
|
|
3136
3411
|
snsTopicARN?: string;
|
|
3137
3412
|
/**
|
|
3413
|
+
* @public
|
|
3138
3414
|
* <p>The options for how often Config delivers configuration
|
|
3139
3415
|
* snapshots to the Amazon S3 bucket.</p>
|
|
3140
3416
|
*/
|
|
@@ -3148,20 +3424,24 @@ export interface DeliveryChannel {
|
|
|
3148
3424
|
*/
|
|
3149
3425
|
export interface DeliveryChannelStatus {
|
|
3150
3426
|
/**
|
|
3427
|
+
* @public
|
|
3151
3428
|
* <p>The name of the delivery channel.</p>
|
|
3152
3429
|
*/
|
|
3153
3430
|
name?: string;
|
|
3154
3431
|
/**
|
|
3432
|
+
* @public
|
|
3155
3433
|
* <p>A list containing the status of the delivery of the snapshot to
|
|
3156
3434
|
* the specified Amazon S3 bucket.</p>
|
|
3157
3435
|
*/
|
|
3158
3436
|
configSnapshotDeliveryInfo?: ConfigExportDeliveryInfo;
|
|
3159
3437
|
/**
|
|
3438
|
+
* @public
|
|
3160
3439
|
* <p>A list that contains the status of the delivery of the
|
|
3161
3440
|
* configuration history to the specified Amazon S3 bucket.</p>
|
|
3162
3441
|
*/
|
|
3163
3442
|
configHistoryDeliveryInfo?: ConfigExportDeliveryInfo;
|
|
3164
3443
|
/**
|
|
3444
|
+
* @public
|
|
3165
3445
|
* <p>A list containing the status of the delivery of the
|
|
3166
3446
|
* configuration stream notification to the specified Amazon SNS
|
|
3167
3447
|
* topic.</p>
|
|
@@ -3173,15 +3453,18 @@ export interface DeliveryChannelStatus {
|
|
|
3173
3453
|
*/
|
|
3174
3454
|
export interface DescribeAggregateComplianceByConfigRulesRequest {
|
|
3175
3455
|
/**
|
|
3456
|
+
* @public
|
|
3176
3457
|
* <p>The name of the configuration aggregator.</p>
|
|
3177
3458
|
*/
|
|
3178
3459
|
ConfigurationAggregatorName: string | undefined;
|
|
3179
3460
|
/**
|
|
3461
|
+
* @public
|
|
3180
3462
|
* <p>Filters the results by ConfigRuleComplianceFilters object.
|
|
3181
3463
|
* </p>
|
|
3182
3464
|
*/
|
|
3183
3465
|
Filters?: ConfigRuleComplianceFilters;
|
|
3184
3466
|
/**
|
|
3467
|
+
* @public
|
|
3185
3468
|
* <p>The maximum number of evaluation results returned on each page.
|
|
3186
3469
|
* The default is
|
|
3187
3470
|
* maximum.
|
|
@@ -3189,6 +3472,7 @@ export interface DescribeAggregateComplianceByConfigRulesRequest {
|
|
|
3189
3472
|
*/
|
|
3190
3473
|
Limit?: number;
|
|
3191
3474
|
/**
|
|
3475
|
+
* @public
|
|
3192
3476
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
3193
3477
|
* to get the next page of results in a paginated response.</p>
|
|
3194
3478
|
*/
|
|
@@ -3199,11 +3483,13 @@ export interface DescribeAggregateComplianceByConfigRulesRequest {
|
|
|
3199
3483
|
*/
|
|
3200
3484
|
export interface DescribeAggregateComplianceByConfigRulesResponse {
|
|
3201
3485
|
/**
|
|
3486
|
+
* @public
|
|
3202
3487
|
* <p>Returns a list of AggregateComplianceByConfigRule
|
|
3203
3488
|
* object.</p>
|
|
3204
3489
|
*/
|
|
3205
3490
|
AggregateComplianceByConfigRules?: AggregateComplianceByConfigRule[];
|
|
3206
3491
|
/**
|
|
3492
|
+
* @public
|
|
3207
3493
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
3208
3494
|
* to get the next page of results in a paginated response.</p>
|
|
3209
3495
|
*/
|
|
@@ -3240,18 +3526,22 @@ export declare class InvalidNextTokenException extends __BaseException {
|
|
|
3240
3526
|
*/
|
|
3241
3527
|
export interface DescribeAggregateComplianceByConformancePacksRequest {
|
|
3242
3528
|
/**
|
|
3529
|
+
* @public
|
|
3243
3530
|
* <p>The name of the configuration aggregator.</p>
|
|
3244
3531
|
*/
|
|
3245
3532
|
ConfigurationAggregatorName: string | undefined;
|
|
3246
3533
|
/**
|
|
3534
|
+
* @public
|
|
3247
3535
|
* <p>Filters the result by <code>AggregateConformancePackComplianceFilters</code> object.</p>
|
|
3248
3536
|
*/
|
|
3249
3537
|
Filters?: AggregateConformancePackComplianceFilters;
|
|
3250
3538
|
/**
|
|
3539
|
+
* @public
|
|
3251
3540
|
* <p>The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default. </p>
|
|
3252
3541
|
*/
|
|
3253
3542
|
Limit?: number;
|
|
3254
3543
|
/**
|
|
3544
|
+
* @public
|
|
3255
3545
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
3256
3546
|
*/
|
|
3257
3547
|
NextToken?: string;
|
|
@@ -3261,10 +3551,12 @@ export interface DescribeAggregateComplianceByConformancePacksRequest {
|
|
|
3261
3551
|
*/
|
|
3262
3552
|
export interface DescribeAggregateComplianceByConformancePacksResponse {
|
|
3263
3553
|
/**
|
|
3554
|
+
* @public
|
|
3264
3555
|
* <p>Returns the <code>AggregateComplianceByConformancePack</code> object.</p>
|
|
3265
3556
|
*/
|
|
3266
3557
|
AggregateComplianceByConformancePacks?: AggregateComplianceByConformancePack[];
|
|
3267
3558
|
/**
|
|
3559
|
+
* @public
|
|
3268
3560
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
3269
3561
|
*/
|
|
3270
3562
|
NextToken?: string;
|
|
@@ -3274,12 +3566,14 @@ export interface DescribeAggregateComplianceByConformancePacksResponse {
|
|
|
3274
3566
|
*/
|
|
3275
3567
|
export interface DescribeAggregationAuthorizationsRequest {
|
|
3276
3568
|
/**
|
|
3569
|
+
* @public
|
|
3277
3570
|
* <p>The maximum number of AggregationAuthorizations returned on
|
|
3278
3571
|
* each page. The default is maximum. If you specify 0, Config uses
|
|
3279
3572
|
* the default.</p>
|
|
3280
3573
|
*/
|
|
3281
3574
|
Limit?: number;
|
|
3282
3575
|
/**
|
|
3576
|
+
* @public
|
|
3283
3577
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
3284
3578
|
* to get the next page of results in a paginated response.</p>
|
|
3285
3579
|
*/
|
|
@@ -3290,11 +3584,13 @@ export interface DescribeAggregationAuthorizationsRequest {
|
|
|
3290
3584
|
*/
|
|
3291
3585
|
export interface DescribeAggregationAuthorizationsResponse {
|
|
3292
3586
|
/**
|
|
3587
|
+
* @public
|
|
3293
3588
|
* <p>Returns a list of authorizations granted to various aggregator
|
|
3294
3589
|
* accounts and regions.</p>
|
|
3295
3590
|
*/
|
|
3296
3591
|
AggregationAuthorizations?: AggregationAuthorization[];
|
|
3297
3592
|
/**
|
|
3593
|
+
* @public
|
|
3298
3594
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
3299
3595
|
* to get the next page of results in a paginated response.</p>
|
|
3300
3596
|
*/
|
|
@@ -3306,15 +3602,18 @@ export interface DescribeAggregationAuthorizationsResponse {
|
|
|
3306
3602
|
*/
|
|
3307
3603
|
export interface DescribeComplianceByConfigRuleRequest {
|
|
3308
3604
|
/**
|
|
3605
|
+
* @public
|
|
3309
3606
|
* <p>Specify one or more Config rule names to filter the results
|
|
3310
3607
|
* by rule.</p>
|
|
3311
3608
|
*/
|
|
3312
3609
|
ConfigRuleNames?: string[];
|
|
3313
3610
|
/**
|
|
3611
|
+
* @public
|
|
3314
3612
|
* <p>Filters the results by compliance.</p>
|
|
3315
3613
|
*/
|
|
3316
3614
|
ComplianceTypes?: (ComplianceType | string)[];
|
|
3317
3615
|
/**
|
|
3616
|
+
* @public
|
|
3318
3617
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
3319
3618
|
* that you use to get the next page of results in a paginated
|
|
3320
3619
|
* response.</p>
|
|
@@ -3327,11 +3626,13 @@ export interface DescribeComplianceByConfigRuleRequest {
|
|
|
3327
3626
|
*/
|
|
3328
3627
|
export interface DescribeComplianceByConfigRuleResponse {
|
|
3329
3628
|
/**
|
|
3629
|
+
* @public
|
|
3330
3630
|
* <p>Indicates whether each of the specified Config rules is
|
|
3331
3631
|
* compliant.</p>
|
|
3332
3632
|
*/
|
|
3333
3633
|
ComplianceByConfigRules?: ComplianceByConfigRule[];
|
|
3334
3634
|
/**
|
|
3635
|
+
* @public
|
|
3335
3636
|
* <p>The string that you use in a subsequent request to get the next
|
|
3336
3637
|
* page of results in a paginated response.</p>
|
|
3337
3638
|
*/
|
|
@@ -3343,6 +3644,7 @@ export interface DescribeComplianceByConfigRuleResponse {
|
|
|
3343
3644
|
*/
|
|
3344
3645
|
export interface DescribeComplianceByResourceRequest {
|
|
3345
3646
|
/**
|
|
3647
|
+
* @public
|
|
3346
3648
|
* <p>The types of Amazon Web Services resources for which you want compliance
|
|
3347
3649
|
* information (for example, <code>AWS::EC2::Instance</code>). For this
|
|
3348
3650
|
* action, you can specify that the resource type is an Amazon Web Services account by
|
|
@@ -3350,6 +3652,7 @@ export interface DescribeComplianceByResourceRequest {
|
|
|
3350
3652
|
*/
|
|
3351
3653
|
ResourceType?: string;
|
|
3352
3654
|
/**
|
|
3655
|
+
* @public
|
|
3353
3656
|
* <p>The ID of the Amazon Web Services resource for which you want compliance
|
|
3354
3657
|
* information. You can specify only one resource ID. If you specify a
|
|
3355
3658
|
* resource ID, you must also specify a type for
|
|
@@ -3357,16 +3660,19 @@ export interface DescribeComplianceByResourceRequest {
|
|
|
3357
3660
|
*/
|
|
3358
3661
|
ResourceId?: string;
|
|
3359
3662
|
/**
|
|
3663
|
+
* @public
|
|
3360
3664
|
* <p>Filters the results by compliance.</p>
|
|
3361
3665
|
*/
|
|
3362
3666
|
ComplianceTypes?: (ComplianceType | string)[];
|
|
3363
3667
|
/**
|
|
3668
|
+
* @public
|
|
3364
3669
|
* <p>The maximum number of evaluation results returned on each page.
|
|
3365
3670
|
* The default is 10. You cannot specify a number greater than 100. If
|
|
3366
3671
|
* you specify 0, Config uses the default.</p>
|
|
3367
3672
|
*/
|
|
3368
3673
|
Limit?: number;
|
|
3369
3674
|
/**
|
|
3675
|
+
* @public
|
|
3370
3676
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
3371
3677
|
* that you use to get the next page of results in a paginated
|
|
3372
3678
|
* response.</p>
|
|
@@ -3379,11 +3685,13 @@ export interface DescribeComplianceByResourceRequest {
|
|
|
3379
3685
|
*/
|
|
3380
3686
|
export interface DescribeComplianceByResourceResponse {
|
|
3381
3687
|
/**
|
|
3688
|
+
* @public
|
|
3382
3689
|
* <p>Indicates whether the specified Amazon Web Services resource complies with all
|
|
3383
3690
|
* of the Config rules that evaluate it.</p>
|
|
3384
3691
|
*/
|
|
3385
3692
|
ComplianceByResources?: ComplianceByResource[];
|
|
3386
3693
|
/**
|
|
3694
|
+
* @public
|
|
3387
3695
|
* <p>The string that you use in a subsequent request to get the next
|
|
3388
3696
|
* page of results in a paginated response.</p>
|
|
3389
3697
|
*/
|
|
@@ -3395,6 +3703,7 @@ export interface DescribeComplianceByResourceResponse {
|
|
|
3395
3703
|
*/
|
|
3396
3704
|
export interface DescribeConfigRuleEvaluationStatusRequest {
|
|
3397
3705
|
/**
|
|
3706
|
+
* @public
|
|
3398
3707
|
* <p>The name of the Config managed rules for which you want
|
|
3399
3708
|
* status information. If you do not specify any names, Config
|
|
3400
3709
|
* returns status information for all Config managed rules that you
|
|
@@ -3402,12 +3711,14 @@ export interface DescribeConfigRuleEvaluationStatusRequest {
|
|
|
3402
3711
|
*/
|
|
3403
3712
|
ConfigRuleNames?: string[];
|
|
3404
3713
|
/**
|
|
3714
|
+
* @public
|
|
3405
3715
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
3406
3716
|
* that you use to get the next page of results in a paginated
|
|
3407
3717
|
* response.</p>
|
|
3408
3718
|
*/
|
|
3409
3719
|
NextToken?: string;
|
|
3410
3720
|
/**
|
|
3721
|
+
* @public
|
|
3411
3722
|
* <p>The number of rule evaluation results that you want
|
|
3412
3723
|
* returned.</p>
|
|
3413
3724
|
* <p>This parameter is required if the rule limit for your account
|
|
@@ -3424,10 +3735,12 @@ export interface DescribeConfigRuleEvaluationStatusRequest {
|
|
|
3424
3735
|
*/
|
|
3425
3736
|
export interface DescribeConfigRuleEvaluationStatusResponse {
|
|
3426
3737
|
/**
|
|
3738
|
+
* @public
|
|
3427
3739
|
* <p>Status information about your Config managed rules.</p>
|
|
3428
3740
|
*/
|
|
3429
3741
|
ConfigRulesEvaluationStatus?: ConfigRuleEvaluationStatus[];
|
|
3430
3742
|
/**
|
|
3743
|
+
* @public
|
|
3431
3744
|
* <p>The string that you use in a subsequent request to get the next
|
|
3432
3745
|
* page of results in a paginated response.</p>
|
|
3433
3746
|
*/
|
|
@@ -3442,6 +3755,7 @@ export interface DescribeConfigRuleEvaluationStatusResponse {
|
|
|
3442
3755
|
*/
|
|
3443
3756
|
export interface DescribeConfigRulesFilters {
|
|
3444
3757
|
/**
|
|
3758
|
+
* @public
|
|
3445
3759
|
* <p>The mode of an evaluation. The valid values are Detective or Proactive.</p>
|
|
3446
3760
|
*/
|
|
3447
3761
|
EvaluationMode?: EvaluationMode | string;
|
|
@@ -3452,18 +3766,21 @@ export interface DescribeConfigRulesFilters {
|
|
|
3452
3766
|
*/
|
|
3453
3767
|
export interface DescribeConfigRulesRequest {
|
|
3454
3768
|
/**
|
|
3769
|
+
* @public
|
|
3455
3770
|
* <p>The names of the Config rules for which you want details.
|
|
3456
3771
|
* If you do not specify any names, Config returns details for all
|
|
3457
3772
|
* your rules.</p>
|
|
3458
3773
|
*/
|
|
3459
3774
|
ConfigRuleNames?: string[];
|
|
3460
3775
|
/**
|
|
3776
|
+
* @public
|
|
3461
3777
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
3462
3778
|
* that you use to get the next page of results in a paginated
|
|
3463
3779
|
* response.</p>
|
|
3464
3780
|
*/
|
|
3465
3781
|
NextToken?: string;
|
|
3466
3782
|
/**
|
|
3783
|
+
* @public
|
|
3467
3784
|
* <p>Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules,
|
|
3468
3785
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html">
|
|
3469
3786
|
* <b>Evaluation Mode</b>
|
|
@@ -3477,10 +3794,12 @@ export interface DescribeConfigRulesRequest {
|
|
|
3477
3794
|
*/
|
|
3478
3795
|
export interface DescribeConfigRulesResponse {
|
|
3479
3796
|
/**
|
|
3797
|
+
* @public
|
|
3480
3798
|
* <p>The details about your Config rules.</p>
|
|
3481
3799
|
*/
|
|
3482
3800
|
ConfigRules?: ConfigRule[];
|
|
3483
3801
|
/**
|
|
3802
|
+
* @public
|
|
3484
3803
|
* <p>The string that you use in a subsequent request to get the next
|
|
3485
3804
|
* page of results in a paginated response.</p>
|
|
3486
3805
|
*/
|
|
@@ -3491,15 +3810,18 @@ export interface DescribeConfigRulesResponse {
|
|
|
3491
3810
|
*/
|
|
3492
3811
|
export interface DescribeConfigurationAggregatorsRequest {
|
|
3493
3812
|
/**
|
|
3813
|
+
* @public
|
|
3494
3814
|
* <p>The name of the configuration aggregators.</p>
|
|
3495
3815
|
*/
|
|
3496
3816
|
ConfigurationAggregatorNames?: string[];
|
|
3497
3817
|
/**
|
|
3818
|
+
* @public
|
|
3498
3819
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
3499
3820
|
* to get the next page of results in a paginated response.</p>
|
|
3500
3821
|
*/
|
|
3501
3822
|
NextToken?: string;
|
|
3502
3823
|
/**
|
|
3824
|
+
* @public
|
|
3503
3825
|
* <p>The maximum number of configuration aggregators returned on
|
|
3504
3826
|
* each page. The default is maximum. If you specify 0, Config uses
|
|
3505
3827
|
* the default.</p>
|
|
@@ -3511,10 +3833,12 @@ export interface DescribeConfigurationAggregatorsRequest {
|
|
|
3511
3833
|
*/
|
|
3512
3834
|
export interface DescribeConfigurationAggregatorsResponse {
|
|
3513
3835
|
/**
|
|
3836
|
+
* @public
|
|
3514
3837
|
* <p>Returns a ConfigurationAggregators object.</p>
|
|
3515
3838
|
*/
|
|
3516
3839
|
ConfigurationAggregators?: ConfigurationAggregator[];
|
|
3517
3840
|
/**
|
|
3841
|
+
* @public
|
|
3518
3842
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
3519
3843
|
* to get the next page of results in a paginated response.</p>
|
|
3520
3844
|
*/
|
|
@@ -3525,10 +3849,12 @@ export interface DescribeConfigurationAggregatorsResponse {
|
|
|
3525
3849
|
*/
|
|
3526
3850
|
export interface DescribeConfigurationAggregatorSourcesStatusRequest {
|
|
3527
3851
|
/**
|
|
3852
|
+
* @public
|
|
3528
3853
|
* <p>The name of the configuration aggregator.</p>
|
|
3529
3854
|
*/
|
|
3530
3855
|
ConfigurationAggregatorName: string | undefined;
|
|
3531
3856
|
/**
|
|
3857
|
+
* @public
|
|
3532
3858
|
* <p>Filters the status type.</p>
|
|
3533
3859
|
* <ul>
|
|
3534
3860
|
* <li>
|
|
@@ -3547,11 +3873,13 @@ export interface DescribeConfigurationAggregatorSourcesStatusRequest {
|
|
|
3547
3873
|
*/
|
|
3548
3874
|
UpdateStatus?: (AggregatedSourceStatusType | string)[];
|
|
3549
3875
|
/**
|
|
3876
|
+
* @public
|
|
3550
3877
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
3551
3878
|
* to get the next page of results in a paginated response.</p>
|
|
3552
3879
|
*/
|
|
3553
3880
|
NextToken?: string;
|
|
3554
3881
|
/**
|
|
3882
|
+
* @public
|
|
3555
3883
|
* <p>The maximum number of AggregatorSourceStatus returned on each
|
|
3556
3884
|
* page. The default is maximum. If you specify 0, Config uses the
|
|
3557
3885
|
* default.</p>
|
|
@@ -3563,11 +3891,13 @@ export interface DescribeConfigurationAggregatorSourcesStatusRequest {
|
|
|
3563
3891
|
*/
|
|
3564
3892
|
export interface DescribeConfigurationAggregatorSourcesStatusResponse {
|
|
3565
3893
|
/**
|
|
3894
|
+
* @public
|
|
3566
3895
|
* <p>Returns an AggregatedSourceStatus object.
|
|
3567
3896
|
* </p>
|
|
3568
3897
|
*/
|
|
3569
3898
|
AggregatedSourceStatusList?: AggregatedSourceStatus[];
|
|
3570
3899
|
/**
|
|
3900
|
+
* @public
|
|
3571
3901
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
3572
3902
|
* to get the next page of results in a paginated response.</p>
|
|
3573
3903
|
*/
|
|
@@ -3579,6 +3909,7 @@ export interface DescribeConfigurationAggregatorSourcesStatusResponse {
|
|
|
3579
3909
|
*/
|
|
3580
3910
|
export interface DescribeConfigurationRecordersRequest {
|
|
3581
3911
|
/**
|
|
3912
|
+
* @public
|
|
3582
3913
|
* <p>A list of configuration recorder names.</p>
|
|
3583
3914
|
*/
|
|
3584
3915
|
ConfigurationRecorderNames?: string[];
|
|
@@ -3589,6 +3920,7 @@ export interface DescribeConfigurationRecordersRequest {
|
|
|
3589
3920
|
*/
|
|
3590
3921
|
export interface DescribeConfigurationRecordersResponse {
|
|
3591
3922
|
/**
|
|
3923
|
+
* @public
|
|
3592
3924
|
* <p>A list that contains the descriptions of the specified
|
|
3593
3925
|
* configuration recorders.</p>
|
|
3594
3926
|
*/
|
|
@@ -3601,6 +3933,7 @@ export interface DescribeConfigurationRecordersResponse {
|
|
|
3601
3933
|
*/
|
|
3602
3934
|
export interface DescribeConfigurationRecorderStatusRequest {
|
|
3603
3935
|
/**
|
|
3936
|
+
* @public
|
|
3604
3937
|
* <p>The name(s) of the configuration recorder. If the name is not
|
|
3605
3938
|
* specified, the action returns the current status of all the
|
|
3606
3939
|
* configuration recorders associated with the account.</p>
|
|
@@ -3614,6 +3947,7 @@ export interface DescribeConfigurationRecorderStatusRequest {
|
|
|
3614
3947
|
*/
|
|
3615
3948
|
export interface DescribeConfigurationRecorderStatusResponse {
|
|
3616
3949
|
/**
|
|
3950
|
+
* @public
|
|
3617
3951
|
* <p>A list that contains status of the specified
|
|
3618
3952
|
* recorders.</p>
|
|
3619
3953
|
*/
|
|
@@ -3624,18 +3958,22 @@ export interface DescribeConfigurationRecorderStatusResponse {
|
|
|
3624
3958
|
*/
|
|
3625
3959
|
export interface DescribeConformancePackComplianceRequest {
|
|
3626
3960
|
/**
|
|
3961
|
+
* @public
|
|
3627
3962
|
* <p>Name of the conformance pack.</p>
|
|
3628
3963
|
*/
|
|
3629
3964
|
ConformancePackName: string | undefined;
|
|
3630
3965
|
/**
|
|
3966
|
+
* @public
|
|
3631
3967
|
* <p>A <code>ConformancePackComplianceFilters</code> object.</p>
|
|
3632
3968
|
*/
|
|
3633
3969
|
Filters?: ConformancePackComplianceFilters;
|
|
3634
3970
|
/**
|
|
3971
|
+
* @public
|
|
3635
3972
|
* <p>The maximum number of Config rules within a conformance pack are returned on each page.</p>
|
|
3636
3973
|
*/
|
|
3637
3974
|
Limit?: number;
|
|
3638
3975
|
/**
|
|
3976
|
+
* @public
|
|
3639
3977
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
3640
3978
|
*/
|
|
3641
3979
|
NextToken?: string;
|
|
@@ -3645,14 +3983,17 @@ export interface DescribeConformancePackComplianceRequest {
|
|
|
3645
3983
|
*/
|
|
3646
3984
|
export interface DescribeConformancePackComplianceResponse {
|
|
3647
3985
|
/**
|
|
3986
|
+
* @public
|
|
3648
3987
|
* <p>Name of the conformance pack.</p>
|
|
3649
3988
|
*/
|
|
3650
3989
|
ConformancePackName: string | undefined;
|
|
3651
3990
|
/**
|
|
3991
|
+
* @public
|
|
3652
3992
|
* <p>Returns a list of <code>ConformancePackRuleCompliance</code> objects.</p>
|
|
3653
3993
|
*/
|
|
3654
3994
|
ConformancePackRuleComplianceList: ConformancePackRuleCompliance[] | undefined;
|
|
3655
3995
|
/**
|
|
3996
|
+
* @public
|
|
3656
3997
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
3657
3998
|
*/
|
|
3658
3999
|
NextToken?: string;
|
|
@@ -3674,14 +4015,17 @@ export declare class NoSuchConfigRuleInConformancePackException extends __BaseEx
|
|
|
3674
4015
|
*/
|
|
3675
4016
|
export interface DescribeConformancePacksRequest {
|
|
3676
4017
|
/**
|
|
4018
|
+
* @public
|
|
3677
4019
|
* <p>Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs. </p>
|
|
3678
4020
|
*/
|
|
3679
4021
|
ConformancePackNames?: string[];
|
|
3680
4022
|
/**
|
|
4023
|
+
* @public
|
|
3681
4024
|
* <p>The maximum number of conformance packs returned on each page.</p>
|
|
3682
4025
|
*/
|
|
3683
4026
|
Limit?: number;
|
|
3684
4027
|
/**
|
|
4028
|
+
* @public
|
|
3685
4029
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
3686
4030
|
*/
|
|
3687
4031
|
NextToken?: string;
|
|
@@ -3691,10 +4035,12 @@ export interface DescribeConformancePacksRequest {
|
|
|
3691
4035
|
*/
|
|
3692
4036
|
export interface DescribeConformancePacksResponse {
|
|
3693
4037
|
/**
|
|
4038
|
+
* @public
|
|
3694
4039
|
* <p>Returns a list of <code>ConformancePackDetail</code> objects.</p>
|
|
3695
4040
|
*/
|
|
3696
4041
|
ConformancePackDetails?: ConformancePackDetail[];
|
|
3697
4042
|
/**
|
|
4043
|
+
* @public
|
|
3698
4044
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
3699
4045
|
*/
|
|
3700
4046
|
NextToken?: string;
|
|
@@ -3704,14 +4050,17 @@ export interface DescribeConformancePacksResponse {
|
|
|
3704
4050
|
*/
|
|
3705
4051
|
export interface DescribeConformancePackStatusRequest {
|
|
3706
4052
|
/**
|
|
4053
|
+
* @public
|
|
3707
4054
|
* <p>Comma-separated list of conformance pack names.</p>
|
|
3708
4055
|
*/
|
|
3709
4056
|
ConformancePackNames?: string[];
|
|
3710
4057
|
/**
|
|
4058
|
+
* @public
|
|
3711
4059
|
* <p>The maximum number of conformance packs status returned on each page.</p>
|
|
3712
4060
|
*/
|
|
3713
4061
|
Limit?: number;
|
|
3714
4062
|
/**
|
|
4063
|
+
* @public
|
|
3715
4064
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
3716
4065
|
*/
|
|
3717
4066
|
NextToken?: string;
|
|
@@ -3721,10 +4070,12 @@ export interface DescribeConformancePackStatusRequest {
|
|
|
3721
4070
|
*/
|
|
3722
4071
|
export interface DescribeConformancePackStatusResponse {
|
|
3723
4072
|
/**
|
|
4073
|
+
* @public
|
|
3724
4074
|
* <p>A list of <code>ConformancePackStatusDetail</code> objects.</p>
|
|
3725
4075
|
*/
|
|
3726
4076
|
ConformancePackStatusDetails?: ConformancePackStatusDetail[];
|
|
3727
4077
|
/**
|
|
4078
|
+
* @public
|
|
3728
4079
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
3729
4080
|
*/
|
|
3730
4081
|
NextToken?: string;
|
|
@@ -3736,6 +4087,7 @@ export interface DescribeConformancePackStatusResponse {
|
|
|
3736
4087
|
*/
|
|
3737
4088
|
export interface DescribeDeliveryChannelsRequest {
|
|
3738
4089
|
/**
|
|
4090
|
+
* @public
|
|
3739
4091
|
* <p>A list of delivery channel names.</p>
|
|
3740
4092
|
*/
|
|
3741
4093
|
DeliveryChannelNames?: string[];
|
|
@@ -3747,6 +4099,7 @@ export interface DescribeDeliveryChannelsRequest {
|
|
|
3747
4099
|
*/
|
|
3748
4100
|
export interface DescribeDeliveryChannelsResponse {
|
|
3749
4101
|
/**
|
|
4102
|
+
* @public
|
|
3750
4103
|
* <p>A list that contains the descriptions of the specified delivery
|
|
3751
4104
|
* channel.</p>
|
|
3752
4105
|
*/
|
|
@@ -3759,6 +4112,7 @@ export interface DescribeDeliveryChannelsResponse {
|
|
|
3759
4112
|
*/
|
|
3760
4113
|
export interface DescribeDeliveryChannelStatusRequest {
|
|
3761
4114
|
/**
|
|
4115
|
+
* @public
|
|
3762
4116
|
* <p>A list of delivery channel names.</p>
|
|
3763
4117
|
*/
|
|
3764
4118
|
DeliveryChannelNames?: string[];
|
|
@@ -3769,6 +4123,7 @@ export interface DescribeDeliveryChannelStatusRequest {
|
|
|
3769
4123
|
*/
|
|
3770
4124
|
export interface DescribeDeliveryChannelStatusResponse {
|
|
3771
4125
|
/**
|
|
4126
|
+
* @public
|
|
3772
4127
|
* <p>A list that contains the status of a specified delivery
|
|
3773
4128
|
* channel.</p>
|
|
3774
4129
|
*/
|
|
@@ -3779,14 +4134,17 @@ export interface DescribeDeliveryChannelStatusResponse {
|
|
|
3779
4134
|
*/
|
|
3780
4135
|
export interface DescribeOrganizationConfigRulesRequest {
|
|
3781
4136
|
/**
|
|
4137
|
+
* @public
|
|
3782
4138
|
* <p>The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.</p>
|
|
3783
4139
|
*/
|
|
3784
4140
|
OrganizationConfigRuleNames?: string[];
|
|
3785
4141
|
/**
|
|
4142
|
+
* @public
|
|
3786
4143
|
* <p>The maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.</p>
|
|
3787
4144
|
*/
|
|
3788
4145
|
Limit?: number;
|
|
3789
4146
|
/**
|
|
4147
|
+
* @public
|
|
3790
4148
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
3791
4149
|
*/
|
|
3792
4150
|
NextToken?: string;
|
|
@@ -3812,10 +4170,12 @@ export type OrganizationConfigRuleTriggerTypeNoSN = (typeof OrganizationConfigRu
|
|
|
3812
4170
|
*/
|
|
3813
4171
|
export interface OrganizationCustomPolicyRuleMetadataNoPolicy {
|
|
3814
4172
|
/**
|
|
4173
|
+
* @public
|
|
3815
4174
|
* <p>The description that you provide for your organization Config Custom Policy rule.</p>
|
|
3816
4175
|
*/
|
|
3817
4176
|
Description?: string;
|
|
3818
4177
|
/**
|
|
4178
|
+
* @public
|
|
3819
4179
|
* <p>The type of notification that triggers Config to run an evaluation for a rule.
|
|
3820
4180
|
* For Config Custom Policy rules, Config supports change
|
|
3821
4181
|
* triggered notification types:</p>
|
|
@@ -3833,37 +4193,45 @@ export interface OrganizationCustomPolicyRuleMetadataNoPolicy {
|
|
|
3833
4193
|
*/
|
|
3834
4194
|
OrganizationConfigRuleTriggerTypes?: (OrganizationConfigRuleTriggerTypeNoSN | string)[];
|
|
3835
4195
|
/**
|
|
4196
|
+
* @public
|
|
3836
4197
|
* <p>A string, in JSON format, that is passed to your organization Config Custom Policy rule.</p>
|
|
3837
4198
|
*/
|
|
3838
4199
|
InputParameters?: string;
|
|
3839
4200
|
/**
|
|
4201
|
+
* @public
|
|
3840
4202
|
* <p>The maximum frequency with which Config runs evaluations for a rule. Your
|
|
3841
4203
|
* Config Custom Policy rule is triggered when Config delivers
|
|
3842
4204
|
* the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p>
|
|
3843
4205
|
*/
|
|
3844
4206
|
MaximumExecutionFrequency?: MaximumExecutionFrequency | string;
|
|
3845
4207
|
/**
|
|
4208
|
+
* @public
|
|
3846
4209
|
* <p>The type of the Amazon Web Services resource that was evaluated.</p>
|
|
3847
4210
|
*/
|
|
3848
4211
|
ResourceTypesScope?: string[];
|
|
3849
4212
|
/**
|
|
4213
|
+
* @public
|
|
3850
4214
|
* <p>The ID of the Amazon Web Services resource that was evaluated.</p>
|
|
3851
4215
|
*/
|
|
3852
4216
|
ResourceIdScope?: string;
|
|
3853
4217
|
/**
|
|
4218
|
+
* @public
|
|
3854
4219
|
* <p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.</p>
|
|
3855
4220
|
*/
|
|
3856
4221
|
TagKeyScope?: string;
|
|
3857
4222
|
/**
|
|
4223
|
+
* @public
|
|
3858
4224
|
* <p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</p>
|
|
3859
4225
|
*/
|
|
3860
4226
|
TagValueScope?: string;
|
|
3861
4227
|
/**
|
|
4228
|
+
* @public
|
|
3862
4229
|
* <p>The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the <a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
|
|
3863
4230
|
* Repository</a>.</p>
|
|
3864
4231
|
*/
|
|
3865
4232
|
PolicyRuntime?: string;
|
|
3866
4233
|
/**
|
|
4234
|
+
* @public
|
|
3867
4235
|
* <p>A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.</p>
|
|
3868
4236
|
*/
|
|
3869
4237
|
DebugLogDeliveryAccounts?: string[];
|
|
@@ -3889,14 +4257,17 @@ export type OrganizationConfigRuleTriggerType = (typeof OrganizationConfigRuleTr
|
|
|
3889
4257
|
*/
|
|
3890
4258
|
export interface OrganizationCustomRuleMetadata {
|
|
3891
4259
|
/**
|
|
4260
|
+
* @public
|
|
3892
4261
|
* <p>The description that you provide for your organization Config rule.</p>
|
|
3893
4262
|
*/
|
|
3894
4263
|
Description?: string;
|
|
3895
4264
|
/**
|
|
4265
|
+
* @public
|
|
3896
4266
|
* <p>The lambda function ARN.</p>
|
|
3897
4267
|
*/
|
|
3898
4268
|
LambdaFunctionArn: string | undefined;
|
|
3899
4269
|
/**
|
|
4270
|
+
* @public
|
|
3900
4271
|
* <p>The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:</p>
|
|
3901
4272
|
* <ul>
|
|
3902
4273
|
* <li>
|
|
@@ -3916,10 +4287,12 @@ export interface OrganizationCustomRuleMetadata {
|
|
|
3916
4287
|
*/
|
|
3917
4288
|
OrganizationConfigRuleTriggerTypes: (OrganizationConfigRuleTriggerType | string)[] | undefined;
|
|
3918
4289
|
/**
|
|
4290
|
+
* @public
|
|
3919
4291
|
* <p>A string, in JSON format, that is passed to your organization Config rule Lambda function.</p>
|
|
3920
4292
|
*/
|
|
3921
4293
|
InputParameters?: string;
|
|
3922
4294
|
/**
|
|
4295
|
+
* @public
|
|
3923
4296
|
* <p>The maximum frequency with which Config runs evaluations for a rule.
|
|
3924
4297
|
* Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p>
|
|
3925
4298
|
* <note>
|
|
@@ -3929,19 +4302,23 @@ export interface OrganizationCustomRuleMetadata {
|
|
|
3929
4302
|
*/
|
|
3930
4303
|
MaximumExecutionFrequency?: MaximumExecutionFrequency | string;
|
|
3931
4304
|
/**
|
|
4305
|
+
* @public
|
|
3932
4306
|
* <p>The type of the Amazon Web Services resource that was evaluated.</p>
|
|
3933
4307
|
*/
|
|
3934
4308
|
ResourceTypesScope?: string[];
|
|
3935
4309
|
/**
|
|
4310
|
+
* @public
|
|
3936
4311
|
* <p>The ID of the Amazon Web Services resource that was evaluated.</p>
|
|
3937
4312
|
*/
|
|
3938
4313
|
ResourceIdScope?: string;
|
|
3939
4314
|
/**
|
|
4315
|
+
* @public
|
|
3940
4316
|
* <p>One part of a key-value pair that make up a tag.
|
|
3941
4317
|
* A key is a general label that acts like a category for more specific tag values. </p>
|
|
3942
4318
|
*/
|
|
3943
4319
|
TagKeyScope?: string;
|
|
3944
4320
|
/**
|
|
4321
|
+
* @public
|
|
3945
4322
|
* <p>The optional part of a key-value pair that make up a tag.
|
|
3946
4323
|
* A value acts as a descriptor within a tag category (key). </p>
|
|
3947
4324
|
*/
|
|
@@ -3954,20 +4331,24 @@ export interface OrganizationCustomRuleMetadata {
|
|
|
3954
4331
|
*/
|
|
3955
4332
|
export interface OrganizationManagedRuleMetadata {
|
|
3956
4333
|
/**
|
|
4334
|
+
* @public
|
|
3957
4335
|
* <p>The description that you provide for your organization Config rule.</p>
|
|
3958
4336
|
*/
|
|
3959
4337
|
Description?: string;
|
|
3960
4338
|
/**
|
|
4339
|
+
* @public
|
|
3961
4340
|
* <p>For organization config managed rules, a predefined identifier from a
|
|
3962
4341
|
* list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed
|
|
3963
4342
|
* rule. To reference a managed rule, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using Config managed rules</a>.</p>
|
|
3964
4343
|
*/
|
|
3965
4344
|
RuleIdentifier: string | undefined;
|
|
3966
4345
|
/**
|
|
4346
|
+
* @public
|
|
3967
4347
|
* <p>A string, in JSON format, that is passed to your organization Config rule Lambda function.</p>
|
|
3968
4348
|
*/
|
|
3969
4349
|
InputParameters?: string;
|
|
3970
4350
|
/**
|
|
4351
|
+
* @public
|
|
3971
4352
|
* <p>The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.</p>
|
|
3972
4353
|
* <note>
|
|
3973
4354
|
* <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
|
|
@@ -3976,19 +4357,23 @@ export interface OrganizationManagedRuleMetadata {
|
|
|
3976
4357
|
*/
|
|
3977
4358
|
MaximumExecutionFrequency?: MaximumExecutionFrequency | string;
|
|
3978
4359
|
/**
|
|
4360
|
+
* @public
|
|
3979
4361
|
* <p>The type of the Amazon Web Services resource that was evaluated.</p>
|
|
3980
4362
|
*/
|
|
3981
4363
|
ResourceTypesScope?: string[];
|
|
3982
4364
|
/**
|
|
4365
|
+
* @public
|
|
3983
4366
|
* <p>The ID of the Amazon Web Services resource that was evaluated.</p>
|
|
3984
4367
|
*/
|
|
3985
4368
|
ResourceIdScope?: string;
|
|
3986
4369
|
/**
|
|
4370
|
+
* @public
|
|
3987
4371
|
* <p>One part of a key-value pair that make up a tag.
|
|
3988
4372
|
* A key is a general label that acts like a category for more specific tag values. </p>
|
|
3989
4373
|
*/
|
|
3990
4374
|
TagKeyScope?: string;
|
|
3991
4375
|
/**
|
|
4376
|
+
* @public
|
|
3992
4377
|
* <p>The optional part of a key-value pair that make up a tag.
|
|
3993
4378
|
* A value acts as a descriptor within a tag category (key).</p>
|
|
3994
4379
|
*/
|
|
@@ -4000,30 +4385,37 @@ export interface OrganizationManagedRuleMetadata {
|
|
|
4000
4385
|
*/
|
|
4001
4386
|
export interface OrganizationConfigRule {
|
|
4002
4387
|
/**
|
|
4388
|
+
* @public
|
|
4003
4389
|
* <p>The name that you assign to organization Config rule.</p>
|
|
4004
4390
|
*/
|
|
4005
4391
|
OrganizationConfigRuleName: string | undefined;
|
|
4006
4392
|
/**
|
|
4393
|
+
* @public
|
|
4007
4394
|
* <p>Amazon Resource Name (ARN) of organization Config rule.</p>
|
|
4008
4395
|
*/
|
|
4009
4396
|
OrganizationConfigRuleArn: string | undefined;
|
|
4010
4397
|
/**
|
|
4398
|
+
* @public
|
|
4011
4399
|
* <p>An <code>OrganizationManagedRuleMetadata</code> object.</p>
|
|
4012
4400
|
*/
|
|
4013
4401
|
OrganizationManagedRuleMetadata?: OrganizationManagedRuleMetadata;
|
|
4014
4402
|
/**
|
|
4403
|
+
* @public
|
|
4015
4404
|
* <p>An <code>OrganizationCustomRuleMetadata</code> object.</p>
|
|
4016
4405
|
*/
|
|
4017
4406
|
OrganizationCustomRuleMetadata?: OrganizationCustomRuleMetadata;
|
|
4018
4407
|
/**
|
|
4408
|
+
* @public
|
|
4019
4409
|
* <p>A comma-separated list of accounts excluded from organization Config rule.</p>
|
|
4020
4410
|
*/
|
|
4021
4411
|
ExcludedAccounts?: string[];
|
|
4022
4412
|
/**
|
|
4413
|
+
* @public
|
|
4023
4414
|
* <p>The timestamp of the last update.</p>
|
|
4024
4415
|
*/
|
|
4025
4416
|
LastUpdateTime?: Date;
|
|
4026
4417
|
/**
|
|
4418
|
+
* @public
|
|
4027
4419
|
* <p>An
|
|
4028
4420
|
* object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have
|
|
4029
4421
|
* debug logging enabled, and other custom rule metadata, such as resource type, resource
|
|
@@ -4036,10 +4428,12 @@ export interface OrganizationConfigRule {
|
|
|
4036
4428
|
*/
|
|
4037
4429
|
export interface DescribeOrganizationConfigRulesResponse {
|
|
4038
4430
|
/**
|
|
4431
|
+
* @public
|
|
4039
4432
|
* <p>Returns a list of <code>OrganizationConfigRule</code> objects.</p>
|
|
4040
4433
|
*/
|
|
4041
4434
|
OrganizationConfigRules?: OrganizationConfigRule[];
|
|
4042
4435
|
/**
|
|
4436
|
+
* @public
|
|
4043
4437
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
4044
4438
|
*/
|
|
4045
4439
|
NextToken?: string;
|
|
@@ -4049,14 +4443,17 @@ export interface DescribeOrganizationConfigRulesResponse {
|
|
|
4049
4443
|
*/
|
|
4050
4444
|
export interface DescribeOrganizationConfigRuleStatusesRequest {
|
|
4051
4445
|
/**
|
|
4446
|
+
* @public
|
|
4052
4447
|
* <p>The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.</p>
|
|
4053
4448
|
*/
|
|
4054
4449
|
OrganizationConfigRuleNames?: string[];
|
|
4055
4450
|
/**
|
|
4451
|
+
* @public
|
|
4056
4452
|
* <p>The maximum number of <code>OrganizationConfigRuleStatuses</code> returned on each page. If you do no specify a number, Config uses the default. The default is 100.</p>
|
|
4057
4453
|
*/
|
|
4058
4454
|
Limit?: number;
|
|
4059
4455
|
/**
|
|
4456
|
+
* @public
|
|
4060
4457
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
4061
4458
|
*/
|
|
4062
4459
|
NextToken?: string;
|
|
@@ -4086,10 +4483,12 @@ export type OrganizationRuleStatus = (typeof OrganizationRuleStatus)[keyof typeo
|
|
|
4086
4483
|
*/
|
|
4087
4484
|
export interface OrganizationConfigRuleStatus {
|
|
4088
4485
|
/**
|
|
4486
|
+
* @public
|
|
4089
4487
|
* <p>The name that you assign to organization Config rule.</p>
|
|
4090
4488
|
*/
|
|
4091
4489
|
OrganizationConfigRuleName: string | undefined;
|
|
4092
4490
|
/**
|
|
4491
|
+
* @public
|
|
4093
4492
|
* <p>Indicates deployment status of an organization Config rule.
|
|
4094
4493
|
* When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts.
|
|
4095
4494
|
* When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization.
|
|
@@ -4136,14 +4535,17 @@ export interface OrganizationConfigRuleStatus {
|
|
|
4136
4535
|
*/
|
|
4137
4536
|
OrganizationRuleStatus: OrganizationRuleStatus | string | undefined;
|
|
4138
4537
|
/**
|
|
4538
|
+
* @public
|
|
4139
4539
|
* <p>An error code that is returned when organization Config rule creation or deletion has failed.</p>
|
|
4140
4540
|
*/
|
|
4141
4541
|
ErrorCode?: string;
|
|
4142
4542
|
/**
|
|
4543
|
+
* @public
|
|
4143
4544
|
* <p>An error message indicating that organization Config rule creation or deletion failed due to an error.</p>
|
|
4144
4545
|
*/
|
|
4145
4546
|
ErrorMessage?: string;
|
|
4146
4547
|
/**
|
|
4548
|
+
* @public
|
|
4147
4549
|
* <p>The timestamp of the last update.</p>
|
|
4148
4550
|
*/
|
|
4149
4551
|
LastUpdateTime?: Date;
|
|
@@ -4153,10 +4555,12 @@ export interface OrganizationConfigRuleStatus {
|
|
|
4153
4555
|
*/
|
|
4154
4556
|
export interface DescribeOrganizationConfigRuleStatusesResponse {
|
|
4155
4557
|
/**
|
|
4558
|
+
* @public
|
|
4156
4559
|
* <p>A list of <code>OrganizationConfigRuleStatus</code> objects.</p>
|
|
4157
4560
|
*/
|
|
4158
4561
|
OrganizationConfigRuleStatuses?: OrganizationConfigRuleStatus[];
|
|
4159
4562
|
/**
|
|
4563
|
+
* @public
|
|
4160
4564
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
4161
4565
|
*/
|
|
4162
4566
|
NextToken?: string;
|
|
@@ -4166,15 +4570,18 @@ export interface DescribeOrganizationConfigRuleStatusesResponse {
|
|
|
4166
4570
|
*/
|
|
4167
4571
|
export interface DescribeOrganizationConformancePacksRequest {
|
|
4168
4572
|
/**
|
|
4573
|
+
* @public
|
|
4169
4574
|
* <p>The name that you assign to an organization conformance pack.</p>
|
|
4170
4575
|
*/
|
|
4171
4576
|
OrganizationConformancePackNames?: string[];
|
|
4172
4577
|
/**
|
|
4578
|
+
* @public
|
|
4173
4579
|
* <p>The maximum number of organization config packs returned on each page. If you do no specify a
|
|
4174
4580
|
* number, Config uses the default. The default is 100.</p>
|
|
4175
4581
|
*/
|
|
4176
4582
|
Limit?: number;
|
|
4177
4583
|
/**
|
|
4584
|
+
* @public
|
|
4178
4585
|
* <p>The nextToken string returned on a previous page that you use to get the next page of results in a
|
|
4179
4586
|
* paginated response.</p>
|
|
4180
4587
|
*/
|
|
@@ -4186,14 +4593,17 @@ export interface DescribeOrganizationConformancePacksRequest {
|
|
|
4186
4593
|
*/
|
|
4187
4594
|
export interface OrganizationConformancePack {
|
|
4188
4595
|
/**
|
|
4596
|
+
* @public
|
|
4189
4597
|
* <p>The name you assign to an organization conformance pack.</p>
|
|
4190
4598
|
*/
|
|
4191
4599
|
OrganizationConformancePackName: string | undefined;
|
|
4192
4600
|
/**
|
|
4601
|
+
* @public
|
|
4193
4602
|
* <p>Amazon Resource Name (ARN) of organization conformance pack.</p>
|
|
4194
4603
|
*/
|
|
4195
4604
|
OrganizationConformancePackArn: string | undefined;
|
|
4196
4605
|
/**
|
|
4606
|
+
* @public
|
|
4197
4607
|
* <p>The name of the Amazon S3 bucket where Config stores conformance pack templates. </p>
|
|
4198
4608
|
* <note>
|
|
4199
4609
|
* <p>This field is optional.</p>
|
|
@@ -4201,6 +4611,7 @@ export interface OrganizationConformancePack {
|
|
|
4201
4611
|
*/
|
|
4202
4612
|
DeliveryS3Bucket?: string;
|
|
4203
4613
|
/**
|
|
4614
|
+
* @public
|
|
4204
4615
|
* <p>Any folder structure you want to add to an Amazon S3 bucket.</p>
|
|
4205
4616
|
* <note>
|
|
4206
4617
|
* <p>This field is optional.</p>
|
|
@@ -4208,14 +4619,17 @@ export interface OrganizationConformancePack {
|
|
|
4208
4619
|
*/
|
|
4209
4620
|
DeliveryS3KeyPrefix?: string;
|
|
4210
4621
|
/**
|
|
4622
|
+
* @public
|
|
4211
4623
|
* <p>A list of <code>ConformancePackInputParameter</code> objects.</p>
|
|
4212
4624
|
*/
|
|
4213
4625
|
ConformancePackInputParameters?: ConformancePackInputParameter[];
|
|
4214
4626
|
/**
|
|
4627
|
+
* @public
|
|
4215
4628
|
* <p>A comma-separated list of accounts excluded from organization conformance pack.</p>
|
|
4216
4629
|
*/
|
|
4217
4630
|
ExcludedAccounts?: string[];
|
|
4218
4631
|
/**
|
|
4632
|
+
* @public
|
|
4219
4633
|
* <p>Last time when organization conformation pack was updated.</p>
|
|
4220
4634
|
*/
|
|
4221
4635
|
LastUpdateTime: Date | undefined;
|
|
@@ -4225,10 +4639,12 @@ export interface OrganizationConformancePack {
|
|
|
4225
4639
|
*/
|
|
4226
4640
|
export interface DescribeOrganizationConformancePacksResponse {
|
|
4227
4641
|
/**
|
|
4642
|
+
* @public
|
|
4228
4643
|
* <p>Returns a list of OrganizationConformancePacks objects.</p>
|
|
4229
4644
|
*/
|
|
4230
4645
|
OrganizationConformancePacks?: OrganizationConformancePack[];
|
|
4231
4646
|
/**
|
|
4647
|
+
* @public
|
|
4232
4648
|
* <p>The nextToken string returned on a previous page that you use to get the next page of results in a
|
|
4233
4649
|
* paginated response.</p>
|
|
4234
4650
|
*/
|
|
@@ -4239,16 +4655,19 @@ export interface DescribeOrganizationConformancePacksResponse {
|
|
|
4239
4655
|
*/
|
|
4240
4656
|
export interface DescribeOrganizationConformancePackStatusesRequest {
|
|
4241
4657
|
/**
|
|
4658
|
+
* @public
|
|
4242
4659
|
* <p>The names of organization conformance packs for which you want status details.
|
|
4243
4660
|
* If you do not specify any names, Config returns details for all your organization conformance packs. </p>
|
|
4244
4661
|
*/
|
|
4245
4662
|
OrganizationConformancePackNames?: string[];
|
|
4246
4663
|
/**
|
|
4664
|
+
* @public
|
|
4247
4665
|
* <p>The maximum number of OrganizationConformancePackStatuses returned on each page.
|
|
4248
4666
|
* If you do no specify a number, Config uses the default. The default is 100. </p>
|
|
4249
4667
|
*/
|
|
4250
4668
|
Limit?: number;
|
|
4251
4669
|
/**
|
|
4670
|
+
* @public
|
|
4252
4671
|
* <p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
4253
4672
|
*/
|
|
4254
4673
|
NextToken?: string;
|
|
@@ -4278,10 +4697,12 @@ export type OrganizationResourceStatus = (typeof OrganizationResourceStatus)[key
|
|
|
4278
4697
|
*/
|
|
4279
4698
|
export interface OrganizationConformancePackStatus {
|
|
4280
4699
|
/**
|
|
4700
|
+
* @public
|
|
4281
4701
|
* <p>The name that you assign to organization conformance pack.</p>
|
|
4282
4702
|
*/
|
|
4283
4703
|
OrganizationConformancePackName: string | undefined;
|
|
4284
4704
|
/**
|
|
4705
|
+
* @public
|
|
4285
4706
|
* <p>Indicates deployment status of an organization conformance pack.
|
|
4286
4707
|
* When management account calls PutOrganizationConformancePack for the first time,
|
|
4287
4708
|
* conformance pack status is created in all the member accounts.
|
|
@@ -4334,14 +4755,17 @@ export interface OrganizationConformancePackStatus {
|
|
|
4334
4755
|
*/
|
|
4335
4756
|
Status: OrganizationResourceStatus | string | undefined;
|
|
4336
4757
|
/**
|
|
4758
|
+
* @public
|
|
4337
4759
|
* <p>An error code that is returned when organization conformance pack creation or deletion has failed in a member account. </p>
|
|
4338
4760
|
*/
|
|
4339
4761
|
ErrorCode?: string;
|
|
4340
4762
|
/**
|
|
4763
|
+
* @public
|
|
4341
4764
|
* <p>An error message indicating that organization conformance pack creation or deletion failed due to an error. </p>
|
|
4342
4765
|
*/
|
|
4343
4766
|
ErrorMessage?: string;
|
|
4344
4767
|
/**
|
|
4768
|
+
* @public
|
|
4345
4769
|
* <p>The timestamp of the last update.</p>
|
|
4346
4770
|
*/
|
|
4347
4771
|
LastUpdateTime?: Date;
|
|
@@ -4351,10 +4775,12 @@ export interface OrganizationConformancePackStatus {
|
|
|
4351
4775
|
*/
|
|
4352
4776
|
export interface DescribeOrganizationConformancePackStatusesResponse {
|
|
4353
4777
|
/**
|
|
4778
|
+
* @public
|
|
4354
4779
|
* <p>A list of <code>OrganizationConformancePackStatus</code> objects. </p>
|
|
4355
4780
|
*/
|
|
4356
4781
|
OrganizationConformancePackStatuses?: OrganizationConformancePackStatus[];
|
|
4357
4782
|
/**
|
|
4783
|
+
* @public
|
|
4358
4784
|
* <p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
4359
4785
|
*/
|
|
4360
4786
|
NextToken?: string;
|
|
@@ -4364,12 +4790,14 @@ export interface DescribeOrganizationConformancePackStatusesResponse {
|
|
|
4364
4790
|
*/
|
|
4365
4791
|
export interface DescribePendingAggregationRequestsRequest {
|
|
4366
4792
|
/**
|
|
4793
|
+
* @public
|
|
4367
4794
|
* <p>The maximum number of evaluation results returned on each page.
|
|
4368
4795
|
* The default is maximum. If you specify 0, Config uses the
|
|
4369
4796
|
* default.</p>
|
|
4370
4797
|
*/
|
|
4371
4798
|
Limit?: number;
|
|
4372
4799
|
/**
|
|
4800
|
+
* @public
|
|
4373
4801
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
4374
4802
|
* to get the next page of results in a paginated response.</p>
|
|
4375
4803
|
*/
|
|
@@ -4383,11 +4811,13 @@ export interface DescribePendingAggregationRequestsRequest {
|
|
|
4383
4811
|
*/
|
|
4384
4812
|
export interface PendingAggregationRequest {
|
|
4385
4813
|
/**
|
|
4814
|
+
* @public
|
|
4386
4815
|
* <p>The 12-digit account ID of the account requesting to aggregate
|
|
4387
4816
|
* data.</p>
|
|
4388
4817
|
*/
|
|
4389
4818
|
RequesterAccountId?: string;
|
|
4390
4819
|
/**
|
|
4820
|
+
* @public
|
|
4391
4821
|
* <p>The region requesting to aggregate data. </p>
|
|
4392
4822
|
*/
|
|
4393
4823
|
RequesterAwsRegion?: string;
|
|
@@ -4397,10 +4827,12 @@ export interface PendingAggregationRequest {
|
|
|
4397
4827
|
*/
|
|
4398
4828
|
export interface DescribePendingAggregationRequestsResponse {
|
|
4399
4829
|
/**
|
|
4830
|
+
* @public
|
|
4400
4831
|
* <p>Returns a PendingAggregationRequests object.</p>
|
|
4401
4832
|
*/
|
|
4402
4833
|
PendingAggregationRequests?: PendingAggregationRequest[];
|
|
4403
4834
|
/**
|
|
4835
|
+
* @public
|
|
4404
4836
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
4405
4837
|
* to get the next page of results in a paginated response.</p>
|
|
4406
4838
|
*/
|
|
@@ -4411,6 +4843,7 @@ export interface DescribePendingAggregationRequestsResponse {
|
|
|
4411
4843
|
*/
|
|
4412
4844
|
export interface DescribeRemediationConfigurationsRequest {
|
|
4413
4845
|
/**
|
|
4846
|
+
* @public
|
|
4414
4847
|
* <p>A list of Config rule names of remediation configurations for which you want details. </p>
|
|
4415
4848
|
*/
|
|
4416
4849
|
ConfigRuleNames: string[] | undefined;
|
|
@@ -4421,10 +4854,12 @@ export interface DescribeRemediationConfigurationsRequest {
|
|
|
4421
4854
|
*/
|
|
4422
4855
|
export interface SsmControls {
|
|
4423
4856
|
/**
|
|
4857
|
+
* @public
|
|
4424
4858
|
* <p>The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10. </p>
|
|
4425
4859
|
*/
|
|
4426
4860
|
ConcurrentExecutionRatePercentage?: number;
|
|
4427
4861
|
/**
|
|
4862
|
+
* @public
|
|
4428
4863
|
* <p>The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule.
|
|
4429
4864
|
* You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%.
|
|
4430
4865
|
* For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received. </p>
|
|
@@ -4437,6 +4872,7 @@ export interface SsmControls {
|
|
|
4437
4872
|
*/
|
|
4438
4873
|
export interface ExecutionControls {
|
|
4439
4874
|
/**
|
|
4875
|
+
* @public
|
|
4440
4876
|
* <p>A SsmControls object.</p>
|
|
4441
4877
|
*/
|
|
4442
4878
|
SsmControls?: SsmControls;
|
|
@@ -4458,6 +4894,7 @@ export type ResourceValueType = (typeof ResourceValueType)[keyof typeof Resource
|
|
|
4458
4894
|
*/
|
|
4459
4895
|
export interface ResourceValue {
|
|
4460
4896
|
/**
|
|
4897
|
+
* @public
|
|
4461
4898
|
* <p>The value is a resource ID.</p>
|
|
4462
4899
|
*/
|
|
4463
4900
|
Value: ResourceValueType | string | undefined;
|
|
@@ -4468,6 +4905,7 @@ export interface ResourceValue {
|
|
|
4468
4905
|
*/
|
|
4469
4906
|
export interface StaticValue {
|
|
4470
4907
|
/**
|
|
4908
|
+
* @public
|
|
4471
4909
|
* <p>A list of values. For example, the ARN of the assumed role. </p>
|
|
4472
4910
|
*/
|
|
4473
4911
|
Values: string[] | undefined;
|
|
@@ -4478,10 +4916,12 @@ export interface StaticValue {
|
|
|
4478
4916
|
*/
|
|
4479
4917
|
export interface RemediationParameterValue {
|
|
4480
4918
|
/**
|
|
4919
|
+
* @public
|
|
4481
4920
|
* <p>The value is dynamic and changes at run-time.</p>
|
|
4482
4921
|
*/
|
|
4483
4922
|
ResourceValue?: ResourceValue;
|
|
4484
4923
|
/**
|
|
4924
|
+
* @public
|
|
4485
4925
|
* <p>The value is static and does not change at run-time.</p>
|
|
4486
4926
|
*/
|
|
4487
4927
|
StaticValue?: StaticValue;
|
|
@@ -4503,18 +4943,22 @@ export type RemediationTargetType = (typeof RemediationTargetType)[keyof typeof
|
|
|
4503
4943
|
*/
|
|
4504
4944
|
export interface RemediationConfiguration {
|
|
4505
4945
|
/**
|
|
4946
|
+
* @public
|
|
4506
4947
|
* <p>The name of the Config rule.</p>
|
|
4507
4948
|
*/
|
|
4508
4949
|
ConfigRuleName: string | undefined;
|
|
4509
4950
|
/**
|
|
4951
|
+
* @public
|
|
4510
4952
|
* <p>The type of the target. Target executes remediation. For example, SSM document.</p>
|
|
4511
4953
|
*/
|
|
4512
4954
|
TargetType: RemediationTargetType | string | undefined;
|
|
4513
4955
|
/**
|
|
4956
|
+
* @public
|
|
4514
4957
|
* <p>Target ID is the name of the SSM document.</p>
|
|
4515
4958
|
*/
|
|
4516
4959
|
TargetId: string | undefined;
|
|
4517
4960
|
/**
|
|
4961
|
+
* @public
|
|
4518
4962
|
* <p>Version of the target. For example, version of the SSM document.</p>
|
|
4519
4963
|
* <note>
|
|
4520
4964
|
* <p>If you make backward incompatible changes to the SSM document,
|
|
@@ -4523,22 +4967,27 @@ export interface RemediationConfiguration {
|
|
|
4523
4967
|
*/
|
|
4524
4968
|
TargetVersion?: string;
|
|
4525
4969
|
/**
|
|
4970
|
+
* @public
|
|
4526
4971
|
* <p>An object of the RemediationParameterValue.</p>
|
|
4527
4972
|
*/
|
|
4528
4973
|
Parameters?: Record<string, RemediationParameterValue>;
|
|
4529
4974
|
/**
|
|
4975
|
+
* @public
|
|
4530
4976
|
* <p>The type of a resource. </p>
|
|
4531
4977
|
*/
|
|
4532
4978
|
ResourceType?: string;
|
|
4533
4979
|
/**
|
|
4980
|
+
* @public
|
|
4534
4981
|
* <p>The remediation is triggered automatically.</p>
|
|
4535
4982
|
*/
|
|
4536
4983
|
Automatic?: boolean;
|
|
4537
4984
|
/**
|
|
4985
|
+
* @public
|
|
4538
4986
|
* <p>An ExecutionControls object.</p>
|
|
4539
4987
|
*/
|
|
4540
4988
|
ExecutionControls?: ExecutionControls;
|
|
4541
4989
|
/**
|
|
4990
|
+
* @public
|
|
4542
4991
|
* <p>The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.</p>
|
|
4543
4992
|
* <p>For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds,
|
|
4544
4993
|
*
|
|
@@ -4546,16 +4995,19 @@ export interface RemediationConfiguration {
|
|
|
4546
4995
|
*/
|
|
4547
4996
|
MaximumAutomaticAttempts?: number;
|
|
4548
4997
|
/**
|
|
4998
|
+
* @public
|
|
4549
4999
|
* <p>Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds. </p>
|
|
4550
5000
|
* <p>For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5,
|
|
4551
5001
|
* Config will run auto-remediations 5 times within 50 seconds before throwing an exception.</p>
|
|
4552
5002
|
*/
|
|
4553
5003
|
RetryAttemptSeconds?: number;
|
|
4554
5004
|
/**
|
|
5005
|
+
* @public
|
|
4555
5006
|
* <p>Amazon Resource Name (ARN) of remediation configuration.</p>
|
|
4556
5007
|
*/
|
|
4557
5008
|
Arn?: string;
|
|
4558
5009
|
/**
|
|
5010
|
+
* @public
|
|
4559
5011
|
* <p>Name of the service that owns the service-linked rule, if applicable.</p>
|
|
4560
5012
|
*/
|
|
4561
5013
|
CreatedByService?: string;
|
|
@@ -4565,6 +5017,7 @@ export interface RemediationConfiguration {
|
|
|
4565
5017
|
*/
|
|
4566
5018
|
export interface DescribeRemediationConfigurationsResponse {
|
|
4567
5019
|
/**
|
|
5020
|
+
* @public
|
|
4568
5021
|
* <p>Returns a remediation configuration object.</p>
|
|
4569
5022
|
*/
|
|
4570
5023
|
RemediationConfigurations?: RemediationConfiguration[];
|
|
@@ -4574,18 +5027,22 @@ export interface DescribeRemediationConfigurationsResponse {
|
|
|
4574
5027
|
*/
|
|
4575
5028
|
export interface DescribeRemediationExceptionsRequest {
|
|
4576
5029
|
/**
|
|
5030
|
+
* @public
|
|
4577
5031
|
* <p>The name of the Config rule.</p>
|
|
4578
5032
|
*/
|
|
4579
5033
|
ConfigRuleName: string | undefined;
|
|
4580
5034
|
/**
|
|
5035
|
+
* @public
|
|
4581
5036
|
* <p>An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys. </p>
|
|
4582
5037
|
*/
|
|
4583
5038
|
ResourceKeys?: RemediationExceptionResourceKey[];
|
|
4584
5039
|
/**
|
|
5040
|
+
* @public
|
|
4585
5041
|
* <p>The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.</p>
|
|
4586
5042
|
*/
|
|
4587
5043
|
Limit?: number;
|
|
4588
5044
|
/**
|
|
5045
|
+
* @public
|
|
4589
5046
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
4590
5047
|
*/
|
|
4591
5048
|
NextToken?: string;
|
|
@@ -4596,22 +5053,27 @@ export interface DescribeRemediationExceptionsRequest {
|
|
|
4596
5053
|
*/
|
|
4597
5054
|
export interface RemediationException {
|
|
4598
5055
|
/**
|
|
5056
|
+
* @public
|
|
4599
5057
|
* <p>The name of the Config rule.</p>
|
|
4600
5058
|
*/
|
|
4601
5059
|
ConfigRuleName: string | undefined;
|
|
4602
5060
|
/**
|
|
5061
|
+
* @public
|
|
4603
5062
|
* <p>The type of a resource.</p>
|
|
4604
5063
|
*/
|
|
4605
5064
|
ResourceType: string | undefined;
|
|
4606
5065
|
/**
|
|
5066
|
+
* @public
|
|
4607
5067
|
* <p>The ID of the resource (for example., sg-xxxxxx).</p>
|
|
4608
5068
|
*/
|
|
4609
5069
|
ResourceId: string | undefined;
|
|
4610
5070
|
/**
|
|
5071
|
+
* @public
|
|
4611
5072
|
* <p>An explanation of an remediation exception.</p>
|
|
4612
5073
|
*/
|
|
4613
5074
|
Message?: string;
|
|
4614
5075
|
/**
|
|
5076
|
+
* @public
|
|
4615
5077
|
* <p>The time when the remediation exception will be deleted.</p>
|
|
4616
5078
|
*/
|
|
4617
5079
|
ExpirationTime?: Date;
|
|
@@ -4621,10 +5083,12 @@ export interface RemediationException {
|
|
|
4621
5083
|
*/
|
|
4622
5084
|
export interface DescribeRemediationExceptionsResponse {
|
|
4623
5085
|
/**
|
|
5086
|
+
* @public
|
|
4624
5087
|
* <p>Returns a list of remediation exception objects.</p>
|
|
4625
5088
|
*/
|
|
4626
5089
|
RemediationExceptions?: RemediationException[];
|
|
4627
5090
|
/**
|
|
5091
|
+
* @public
|
|
4628
5092
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
4629
5093
|
*/
|
|
4630
5094
|
NextToken?: string;
|
|
@@ -4634,18 +5098,22 @@ export interface DescribeRemediationExceptionsResponse {
|
|
|
4634
5098
|
*/
|
|
4635
5099
|
export interface DescribeRemediationExecutionStatusRequest {
|
|
4636
5100
|
/**
|
|
5101
|
+
* @public
|
|
4637
5102
|
* <p>A list of Config rule names.</p>
|
|
4638
5103
|
*/
|
|
4639
5104
|
ConfigRuleName: string | undefined;
|
|
4640
5105
|
/**
|
|
5106
|
+
* @public
|
|
4641
5107
|
* <p>A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID. </p>
|
|
4642
5108
|
*/
|
|
4643
5109
|
ResourceKeys?: ResourceKey[];
|
|
4644
5110
|
/**
|
|
5111
|
+
* @public
|
|
4645
5112
|
* <p>The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default. </p>
|
|
4646
5113
|
*/
|
|
4647
5114
|
Limit?: number;
|
|
4648
5115
|
/**
|
|
5116
|
+
* @public
|
|
4649
5117
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
4650
5118
|
*/
|
|
4651
5119
|
NextToken?: string;
|
|
@@ -4683,22 +5151,27 @@ export type RemediationExecutionStepState = (typeof RemediationExecutionStepStat
|
|
|
4683
5151
|
*/
|
|
4684
5152
|
export interface RemediationExecutionStep {
|
|
4685
5153
|
/**
|
|
5154
|
+
* @public
|
|
4686
5155
|
* <p>The details of the step.</p>
|
|
4687
5156
|
*/
|
|
4688
5157
|
Name?: string;
|
|
4689
5158
|
/**
|
|
5159
|
+
* @public
|
|
4690
5160
|
* <p>The valid status of the step.</p>
|
|
4691
5161
|
*/
|
|
4692
5162
|
State?: RemediationExecutionStepState | string;
|
|
4693
5163
|
/**
|
|
5164
|
+
* @public
|
|
4694
5165
|
* <p>An error message if the step was interrupted during execution.</p>
|
|
4695
5166
|
*/
|
|
4696
5167
|
ErrorMessage?: string;
|
|
4697
5168
|
/**
|
|
5169
|
+
* @public
|
|
4698
5170
|
* <p>The time when the step started.</p>
|
|
4699
5171
|
*/
|
|
4700
5172
|
StartTime?: Date;
|
|
4701
5173
|
/**
|
|
5174
|
+
* @public
|
|
4702
5175
|
* <p>The time when the step stopped.</p>
|
|
4703
5176
|
*/
|
|
4704
5177
|
StopTime?: Date;
|
|
@@ -4709,23 +5182,28 @@ export interface RemediationExecutionStep {
|
|
|
4709
5182
|
*/
|
|
4710
5183
|
export interface RemediationExecutionStatus {
|
|
4711
5184
|
/**
|
|
5185
|
+
* @public
|
|
4712
5186
|
* <p>The details that identify a resource within Config, including
|
|
4713
5187
|
* the resource type and resource ID.</p>
|
|
4714
5188
|
*/
|
|
4715
5189
|
ResourceKey?: ResourceKey;
|
|
4716
5190
|
/**
|
|
5191
|
+
* @public
|
|
4717
5192
|
* <p>ENUM of the values.</p>
|
|
4718
5193
|
*/
|
|
4719
5194
|
State?: RemediationExecutionState | string;
|
|
4720
5195
|
/**
|
|
5196
|
+
* @public
|
|
4721
5197
|
* <p>Details of every step.</p>
|
|
4722
5198
|
*/
|
|
4723
5199
|
StepDetails?: RemediationExecutionStep[];
|
|
4724
5200
|
/**
|
|
5201
|
+
* @public
|
|
4725
5202
|
* <p>Start time when the remediation was executed.</p>
|
|
4726
5203
|
*/
|
|
4727
5204
|
InvocationTime?: Date;
|
|
4728
5205
|
/**
|
|
5206
|
+
* @public
|
|
4729
5207
|
* <p>The time when the remediation execution was last updated.</p>
|
|
4730
5208
|
*/
|
|
4731
5209
|
LastUpdatedTime?: Date;
|
|
@@ -4735,10 +5213,12 @@ export interface RemediationExecutionStatus {
|
|
|
4735
5213
|
*/
|
|
4736
5214
|
export interface DescribeRemediationExecutionStatusResponse {
|
|
4737
5215
|
/**
|
|
5216
|
+
* @public
|
|
4738
5217
|
* <p>Returns a list of remediation execution statuses objects.</p>
|
|
4739
5218
|
*/
|
|
4740
5219
|
RemediationExecutionStatuses?: RemediationExecutionStatus[];
|
|
4741
5220
|
/**
|
|
5221
|
+
* @public
|
|
4742
5222
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
4743
5223
|
*/
|
|
4744
5224
|
NextToken?: string;
|
|
@@ -4748,6 +5228,7 @@ export interface DescribeRemediationExecutionStatusResponse {
|
|
|
4748
5228
|
*/
|
|
4749
5229
|
export interface DescribeRetentionConfigurationsRequest {
|
|
4750
5230
|
/**
|
|
5231
|
+
* @public
|
|
4751
5232
|
* <p>A list of names of retention configurations for which you want
|
|
4752
5233
|
* details. If you do not specify a name, Config returns details
|
|
4753
5234
|
* for all the retention configurations for that account.</p>
|
|
@@ -4758,6 +5239,7 @@ export interface DescribeRetentionConfigurationsRequest {
|
|
|
4758
5239
|
*/
|
|
4759
5240
|
RetentionConfigurationNames?: string[];
|
|
4760
5241
|
/**
|
|
5242
|
+
* @public
|
|
4761
5243
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
4762
5244
|
* that you use to get the next page of results in a paginated
|
|
4763
5245
|
* response. </p>
|
|
@@ -4770,10 +5252,12 @@ export interface DescribeRetentionConfigurationsRequest {
|
|
|
4770
5252
|
*/
|
|
4771
5253
|
export interface RetentionConfiguration {
|
|
4772
5254
|
/**
|
|
5255
|
+
* @public
|
|
4773
5256
|
* <p>The name of the retention configuration object.</p>
|
|
4774
5257
|
*/
|
|
4775
5258
|
Name: string | undefined;
|
|
4776
5259
|
/**
|
|
5260
|
+
* @public
|
|
4777
5261
|
* <p>Number of days Config stores your historical information.</p>
|
|
4778
5262
|
* <note>
|
|
4779
5263
|
* <p>Currently, only applicable to the configuration item history.</p>
|
|
@@ -4786,10 +5270,12 @@ export interface RetentionConfiguration {
|
|
|
4786
5270
|
*/
|
|
4787
5271
|
export interface DescribeRetentionConfigurationsResponse {
|
|
4788
5272
|
/**
|
|
5273
|
+
* @public
|
|
4789
5274
|
* <p>Returns a retention configuration object.</p>
|
|
4790
5275
|
*/
|
|
4791
5276
|
RetentionConfigurations?: RetentionConfiguration[];
|
|
4792
5277
|
/**
|
|
5278
|
+
* @public
|
|
4793
5279
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
4794
5280
|
* that you use to get the next page of results in a paginated
|
|
4795
5281
|
* response. </p>
|
|
@@ -4803,14 +5289,17 @@ export interface DescribeRetentionConfigurationsResponse {
|
|
|
4803
5289
|
*/
|
|
4804
5290
|
export interface Evaluation {
|
|
4805
5291
|
/**
|
|
5292
|
+
* @public
|
|
4806
5293
|
* <p>The type of Amazon Web Services resource that was evaluated.</p>
|
|
4807
5294
|
*/
|
|
4808
5295
|
ComplianceResourceType: string | undefined;
|
|
4809
5296
|
/**
|
|
5297
|
+
* @public
|
|
4810
5298
|
* <p>The ID of the Amazon Web Services resource that was evaluated.</p>
|
|
4811
5299
|
*/
|
|
4812
5300
|
ComplianceResourceId: string | undefined;
|
|
4813
5301
|
/**
|
|
5302
|
+
* @public
|
|
4814
5303
|
* <p>Indicates whether the Amazon Web Services resource complies with the Config
|
|
4815
5304
|
* rule that it was evaluated against.</p>
|
|
4816
5305
|
* <p>For the <code>Evaluation</code> data type, Config supports
|
|
@@ -4826,11 +5315,13 @@ export interface Evaluation {
|
|
|
4826
5315
|
*/
|
|
4827
5316
|
ComplianceType: ComplianceType | string | undefined;
|
|
4828
5317
|
/**
|
|
5318
|
+
* @public
|
|
4829
5319
|
* <p>Supplementary information about how the evaluation determined
|
|
4830
5320
|
* the compliance.</p>
|
|
4831
5321
|
*/
|
|
4832
5322
|
Annotation?: string;
|
|
4833
5323
|
/**
|
|
5324
|
+
* @public
|
|
4834
5325
|
* <p>The time of the event in Config that triggered the
|
|
4835
5326
|
* evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation.
|
|
4836
5327
|
* For periodic evaluations, the time indicates when Config
|
|
@@ -4846,6 +5337,7 @@ export interface Evaluation {
|
|
|
4846
5337
|
*/
|
|
4847
5338
|
export interface EvaluationContext {
|
|
4848
5339
|
/**
|
|
5340
|
+
* @public
|
|
4849
5341
|
* <p>A unique EvaluationContextIdentifier ID for an EvaluationContext.</p>
|
|
4850
5342
|
*/
|
|
4851
5343
|
EvaluationContextIdentifier?: string;
|
|
@@ -4858,10 +5350,12 @@ export interface EvaluationContext {
|
|
|
4858
5350
|
*/
|
|
4859
5351
|
export interface EvaluationResult {
|
|
4860
5352
|
/**
|
|
5353
|
+
* @public
|
|
4861
5354
|
* <p>Uniquely identifies the evaluation result.</p>
|
|
4862
5355
|
*/
|
|
4863
5356
|
EvaluationResultIdentifier?: EvaluationResultIdentifier;
|
|
4864
5357
|
/**
|
|
5358
|
+
* @public
|
|
4865
5359
|
* <p>Indicates whether the Amazon Web Services resource complies with the Config
|
|
4866
5360
|
* rule that evaluated it.</p>
|
|
4867
5361
|
* <p>For the <code>EvaluationResult</code> data type, Config
|
|
@@ -4872,21 +5366,25 @@ export interface EvaluationResult {
|
|
|
4872
5366
|
*/
|
|
4873
5367
|
ComplianceType?: ComplianceType | string;
|
|
4874
5368
|
/**
|
|
5369
|
+
* @public
|
|
4875
5370
|
* <p>The time when Config recorded the evaluation
|
|
4876
5371
|
* result.</p>
|
|
4877
5372
|
*/
|
|
4878
5373
|
ResultRecordedTime?: Date;
|
|
4879
5374
|
/**
|
|
5375
|
+
* @public
|
|
4880
5376
|
* <p>The time when the Config rule evaluated the Amazon Web Services
|
|
4881
5377
|
* resource.</p>
|
|
4882
5378
|
*/
|
|
4883
5379
|
ConfigRuleInvokedTime?: Date;
|
|
4884
5380
|
/**
|
|
5381
|
+
* @public
|
|
4885
5382
|
* <p>Supplementary information about how the evaluation determined
|
|
4886
5383
|
* the compliance.</p>
|
|
4887
5384
|
*/
|
|
4888
5385
|
Annotation?: string;
|
|
4889
5386
|
/**
|
|
5387
|
+
* @public
|
|
4890
5388
|
* <p>An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being
|
|
4891
5389
|
* evaluated, and the event that triggered the evaluation.</p>
|
|
4892
5390
|
*/
|
|
@@ -4911,10 +5409,12 @@ export type ResourceEvaluationStatus = (typeof ResourceEvaluationStatus)[keyof t
|
|
|
4911
5409
|
*/
|
|
4912
5410
|
export interface EvaluationStatus {
|
|
4913
5411
|
/**
|
|
5412
|
+
* @public
|
|
4914
5413
|
* <p>The status of an execution. The valid values are In_Progress, Succeeded or Failed. </p>
|
|
4915
5414
|
*/
|
|
4916
5415
|
Status: ResourceEvaluationStatus | string | undefined;
|
|
4917
5416
|
/**
|
|
5417
|
+
* @public
|
|
4918
5418
|
* <p>An explanation for failed execution status.</p>
|
|
4919
5419
|
*/
|
|
4920
5420
|
FailureReason?: string;
|
|
@@ -4925,22 +5425,27 @@ export interface EvaluationStatus {
|
|
|
4925
5425
|
*/
|
|
4926
5426
|
export interface ExternalEvaluation {
|
|
4927
5427
|
/**
|
|
5428
|
+
* @public
|
|
4928
5429
|
* <p>The evaluated compliance resource type. Config accepts <code>AWS::::Account</code> resource type.</p>
|
|
4929
5430
|
*/
|
|
4930
5431
|
ComplianceResourceType: string | undefined;
|
|
4931
5432
|
/**
|
|
5433
|
+
* @public
|
|
4932
5434
|
* <p>The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.</p>
|
|
4933
5435
|
*/
|
|
4934
5436
|
ComplianceResourceId: string | undefined;
|
|
4935
5437
|
/**
|
|
5438
|
+
* @public
|
|
4936
5439
|
* <p>The compliance of the Amazon Web Services resource. The valid values are <code>COMPLIANT, NON_COMPLIANT, </code> and <code>NOT_APPLICABLE</code>.</p>
|
|
4937
5440
|
*/
|
|
4938
5441
|
ComplianceType: ComplianceType | string | undefined;
|
|
4939
5442
|
/**
|
|
5443
|
+
* @public
|
|
4940
5444
|
* <p>Supplementary information about the reason of compliance. For example, this task was completed on a specific date.</p>
|
|
4941
5445
|
*/
|
|
4942
5446
|
Annotation?: string;
|
|
4943
5447
|
/**
|
|
5448
|
+
* @public
|
|
4944
5449
|
* <p>The time when the compliance was recorded. </p>
|
|
4945
5450
|
*/
|
|
4946
5451
|
OrderingTimestamp: Date | undefined;
|
|
@@ -4951,10 +5456,12 @@ export interface ExternalEvaluation {
|
|
|
4951
5456
|
*/
|
|
4952
5457
|
export interface FailedRemediationBatch {
|
|
4953
5458
|
/**
|
|
5459
|
+
* @public
|
|
4954
5460
|
* <p>Returns a failure message. For example, the resource is already compliant.</p>
|
|
4955
5461
|
*/
|
|
4956
5462
|
FailureMessage?: string;
|
|
4957
5463
|
/**
|
|
5464
|
+
* @public
|
|
4958
5465
|
* <p>Returns remediation configurations of the failed items.</p>
|
|
4959
5466
|
*/
|
|
4960
5467
|
FailedItems?: RemediationConfiguration[];
|
|
@@ -4965,10 +5472,12 @@ export interface FailedRemediationBatch {
|
|
|
4965
5472
|
*/
|
|
4966
5473
|
export interface FailedRemediationExceptionBatch {
|
|
4967
5474
|
/**
|
|
5475
|
+
* @public
|
|
4968
5476
|
* <p>Returns a failure message. For example, the auto-remediation has failed.</p>
|
|
4969
5477
|
*/
|
|
4970
5478
|
FailureMessage?: string;
|
|
4971
5479
|
/**
|
|
5480
|
+
* @public
|
|
4972
5481
|
* <p>Returns remediation exception resource key object of the failed items.</p>
|
|
4973
5482
|
*/
|
|
4974
5483
|
FailedItems?: RemediationException[];
|
|
@@ -4979,6 +5488,7 @@ export interface FailedRemediationExceptionBatch {
|
|
|
4979
5488
|
*/
|
|
4980
5489
|
export interface FieldInfo {
|
|
4981
5490
|
/**
|
|
5491
|
+
* @public
|
|
4982
5492
|
* <p>Name of the field.</p>
|
|
4983
5493
|
*/
|
|
4984
5494
|
Name?: string;
|
|
@@ -4988,23 +5498,28 @@ export interface FieldInfo {
|
|
|
4988
5498
|
*/
|
|
4989
5499
|
export interface GetAggregateComplianceDetailsByConfigRuleRequest {
|
|
4990
5500
|
/**
|
|
5501
|
+
* @public
|
|
4991
5502
|
* <p>The name of the configuration aggregator.</p>
|
|
4992
5503
|
*/
|
|
4993
5504
|
ConfigurationAggregatorName: string | undefined;
|
|
4994
5505
|
/**
|
|
5506
|
+
* @public
|
|
4995
5507
|
* <p>The name of the Config rule for which you want compliance
|
|
4996
5508
|
* information.</p>
|
|
4997
5509
|
*/
|
|
4998
5510
|
ConfigRuleName: string | undefined;
|
|
4999
5511
|
/**
|
|
5512
|
+
* @public
|
|
5000
5513
|
* <p>The 12-digit account ID of the source account.</p>
|
|
5001
5514
|
*/
|
|
5002
5515
|
AccountId: string | undefined;
|
|
5003
5516
|
/**
|
|
5517
|
+
* @public
|
|
5004
5518
|
* <p>The source region from where the data is aggregated.</p>
|
|
5005
5519
|
*/
|
|
5006
5520
|
AwsRegion: string | undefined;
|
|
5007
5521
|
/**
|
|
5522
|
+
* @public
|
|
5008
5523
|
* <p>The resource compliance status.</p>
|
|
5009
5524
|
* <note>
|
|
5010
5525
|
* <p>For the
|
|
@@ -5017,12 +5532,14 @@ export interface GetAggregateComplianceDetailsByConfigRuleRequest {
|
|
|
5017
5532
|
*/
|
|
5018
5533
|
ComplianceType?: ComplianceType | string;
|
|
5019
5534
|
/**
|
|
5535
|
+
* @public
|
|
5020
5536
|
* <p>The maximum number of evaluation results returned on each page.
|
|
5021
5537
|
* The default is 50. You cannot specify a number greater than 100. If
|
|
5022
5538
|
* you specify 0, Config uses the default.</p>
|
|
5023
5539
|
*/
|
|
5024
5540
|
Limit?: number;
|
|
5025
5541
|
/**
|
|
5542
|
+
* @public
|
|
5026
5543
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
5027
5544
|
* to get the next page of results in a paginated response.</p>
|
|
5028
5545
|
*/
|
|
@@ -5033,10 +5550,12 @@ export interface GetAggregateComplianceDetailsByConfigRuleRequest {
|
|
|
5033
5550
|
*/
|
|
5034
5551
|
export interface GetAggregateComplianceDetailsByConfigRuleResponse {
|
|
5035
5552
|
/**
|
|
5553
|
+
* @public
|
|
5036
5554
|
* <p>Returns an AggregateEvaluationResults object.</p>
|
|
5037
5555
|
*/
|
|
5038
5556
|
AggregateEvaluationResults?: AggregateEvaluationResult[];
|
|
5039
5557
|
/**
|
|
5558
|
+
* @public
|
|
5040
5559
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
5041
5560
|
* to get the next page of results in a paginated response.</p>
|
|
5042
5561
|
*/
|
|
@@ -5047,25 +5566,30 @@ export interface GetAggregateComplianceDetailsByConfigRuleResponse {
|
|
|
5047
5566
|
*/
|
|
5048
5567
|
export interface GetAggregateConfigRuleComplianceSummaryRequest {
|
|
5049
5568
|
/**
|
|
5569
|
+
* @public
|
|
5050
5570
|
* <p>The name of the configuration aggregator.</p>
|
|
5051
5571
|
*/
|
|
5052
5572
|
ConfigurationAggregatorName: string | undefined;
|
|
5053
5573
|
/**
|
|
5574
|
+
* @public
|
|
5054
5575
|
* <p>Filters the results based on the
|
|
5055
5576
|
* ConfigRuleComplianceSummaryFilters object.</p>
|
|
5056
5577
|
*/
|
|
5057
5578
|
Filters?: ConfigRuleComplianceSummaryFilters;
|
|
5058
5579
|
/**
|
|
5580
|
+
* @public
|
|
5059
5581
|
* <p>Groups the result based on ACCOUNT_ID or AWS_REGION.</p>
|
|
5060
5582
|
*/
|
|
5061
5583
|
GroupByKey?: ConfigRuleComplianceSummaryGroupKey | string;
|
|
5062
5584
|
/**
|
|
5585
|
+
* @public
|
|
5063
5586
|
* <p>The maximum number of evaluation results returned on each page.
|
|
5064
5587
|
* The default is 1000. You cannot specify a number greater than 1000.
|
|
5065
5588
|
* If you specify 0, Config uses the default.</p>
|
|
5066
5589
|
*/
|
|
5067
5590
|
Limit?: number;
|
|
5068
5591
|
/**
|
|
5592
|
+
* @public
|
|
5069
5593
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
5070
5594
|
* to get the next page of results in a paginated response.</p>
|
|
5071
5595
|
*/
|
|
@@ -5076,14 +5600,17 @@ export interface GetAggregateConfigRuleComplianceSummaryRequest {
|
|
|
5076
5600
|
*/
|
|
5077
5601
|
export interface GetAggregateConfigRuleComplianceSummaryResponse {
|
|
5078
5602
|
/**
|
|
5603
|
+
* @public
|
|
5079
5604
|
* <p>Groups the result based on ACCOUNT_ID or AWS_REGION.</p>
|
|
5080
5605
|
*/
|
|
5081
5606
|
GroupByKey?: string;
|
|
5082
5607
|
/**
|
|
5608
|
+
* @public
|
|
5083
5609
|
* <p>Returns a list of AggregateComplianceCounts object.</p>
|
|
5084
5610
|
*/
|
|
5085
5611
|
AggregateComplianceCounts?: AggregateComplianceCount[];
|
|
5086
5612
|
/**
|
|
5613
|
+
* @public
|
|
5087
5614
|
* <p>The <code>nextToken</code> string returned on a previous page that you use
|
|
5088
5615
|
* to get the next page of results in a paginated response.</p>
|
|
5089
5616
|
*/
|
|
@@ -5094,22 +5621,27 @@ export interface GetAggregateConfigRuleComplianceSummaryResponse {
|
|
|
5094
5621
|
*/
|
|
5095
5622
|
export interface GetAggregateConformancePackComplianceSummaryRequest {
|
|
5096
5623
|
/**
|
|
5624
|
+
* @public
|
|
5097
5625
|
* <p>The name of the configuration aggregator.</p>
|
|
5098
5626
|
*/
|
|
5099
5627
|
ConfigurationAggregatorName: string | undefined;
|
|
5100
5628
|
/**
|
|
5629
|
+
* @public
|
|
5101
5630
|
* <p>Filters the results based on the <code>AggregateConformancePackComplianceSummaryFilters</code> object.</p>
|
|
5102
5631
|
*/
|
|
5103
5632
|
Filters?: AggregateConformancePackComplianceSummaryFilters;
|
|
5104
5633
|
/**
|
|
5634
|
+
* @public
|
|
5105
5635
|
* <p>Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.</p>
|
|
5106
5636
|
*/
|
|
5107
5637
|
GroupByKey?: AggregateConformancePackComplianceSummaryGroupKey | string;
|
|
5108
5638
|
/**
|
|
5639
|
+
* @public
|
|
5109
5640
|
* <p>The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.</p>
|
|
5110
5641
|
*/
|
|
5111
5642
|
Limit?: number;
|
|
5112
5643
|
/**
|
|
5644
|
+
* @public
|
|
5113
5645
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
5114
5646
|
*/
|
|
5115
5647
|
NextToken?: string;
|
|
@@ -5119,14 +5651,17 @@ export interface GetAggregateConformancePackComplianceSummaryRequest {
|
|
|
5119
5651
|
*/
|
|
5120
5652
|
export interface GetAggregateConformancePackComplianceSummaryResponse {
|
|
5121
5653
|
/**
|
|
5654
|
+
* @public
|
|
5122
5655
|
* <p>Returns a list of <code>AggregateConformancePackComplianceSummary</code> object.</p>
|
|
5123
5656
|
*/
|
|
5124
5657
|
AggregateConformancePackComplianceSummaries?: AggregateConformancePackComplianceSummary[];
|
|
5125
5658
|
/**
|
|
5659
|
+
* @public
|
|
5126
5660
|
* <p>Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.</p>
|
|
5127
5661
|
*/
|
|
5128
5662
|
GroupByKey?: string;
|
|
5129
5663
|
/**
|
|
5664
|
+
* @public
|
|
5130
5665
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
5131
5666
|
*/
|
|
5132
5667
|
NextToken?: string;
|
|
@@ -5137,14 +5672,17 @@ export interface GetAggregateConformancePackComplianceSummaryResponse {
|
|
|
5137
5672
|
*/
|
|
5138
5673
|
export interface ResourceCountFilters {
|
|
5139
5674
|
/**
|
|
5675
|
+
* @public
|
|
5140
5676
|
* <p>The type of the Amazon Web Services resource.</p>
|
|
5141
5677
|
*/
|
|
5142
5678
|
ResourceType?: ResourceType | string;
|
|
5143
5679
|
/**
|
|
5680
|
+
* @public
|
|
5144
5681
|
* <p>The 12-digit ID of the account.</p>
|
|
5145
5682
|
*/
|
|
5146
5683
|
AccountId?: string;
|
|
5147
5684
|
/**
|
|
5685
|
+
* @public
|
|
5148
5686
|
* <p>The region where the account is located.</p>
|
|
5149
5687
|
*/
|
|
5150
5688
|
Region?: string;
|
|
@@ -5167,22 +5705,27 @@ export type ResourceCountGroupKey = (typeof ResourceCountGroupKey)[keyof typeof
|
|
|
5167
5705
|
*/
|
|
5168
5706
|
export interface GetAggregateDiscoveredResourceCountsRequest {
|
|
5169
5707
|
/**
|
|
5708
|
+
* @public
|
|
5170
5709
|
* <p>The name of the configuration aggregator.</p>
|
|
5171
5710
|
*/
|
|
5172
5711
|
ConfigurationAggregatorName: string | undefined;
|
|
5173
5712
|
/**
|
|
5713
|
+
* @public
|
|
5174
5714
|
* <p>Filters the results based on the <code>ResourceCountFilters</code> object.</p>
|
|
5175
5715
|
*/
|
|
5176
5716
|
Filters?: ResourceCountFilters;
|
|
5177
5717
|
/**
|
|
5718
|
+
* @public
|
|
5178
5719
|
* <p>The key to group the resource counts.</p>
|
|
5179
5720
|
*/
|
|
5180
5721
|
GroupByKey?: ResourceCountGroupKey | string;
|
|
5181
5722
|
/**
|
|
5723
|
+
* @public
|
|
5182
5724
|
* <p>The maximum number of <a>GroupedResourceCount</a> objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.</p>
|
|
5183
5725
|
*/
|
|
5184
5726
|
Limit?: number;
|
|
5185
5727
|
/**
|
|
5728
|
+
* @public
|
|
5186
5729
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
5187
5730
|
*/
|
|
5188
5731
|
NextToken?: string;
|
|
@@ -5193,10 +5736,12 @@ export interface GetAggregateDiscoveredResourceCountsRequest {
|
|
|
5193
5736
|
*/
|
|
5194
5737
|
export interface GroupedResourceCount {
|
|
5195
5738
|
/**
|
|
5739
|
+
* @public
|
|
5196
5740
|
* <p>The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as <code>GroupByKey</code>.</p>
|
|
5197
5741
|
*/
|
|
5198
5742
|
GroupName: string | undefined;
|
|
5199
5743
|
/**
|
|
5744
|
+
* @public
|
|
5200
5745
|
* <p>The number of resources in the group.</p>
|
|
5201
5746
|
*/
|
|
5202
5747
|
ResourceCount: number | undefined;
|
|
@@ -5206,18 +5751,22 @@ export interface GroupedResourceCount {
|
|
|
5206
5751
|
*/
|
|
5207
5752
|
export interface GetAggregateDiscoveredResourceCountsResponse {
|
|
5208
5753
|
/**
|
|
5754
|
+
* @public
|
|
5209
5755
|
* <p>The total number of resources that are present in an aggregator with the filters that you provide.</p>
|
|
5210
5756
|
*/
|
|
5211
5757
|
TotalDiscoveredResources: number | undefined;
|
|
5212
5758
|
/**
|
|
5759
|
+
* @public
|
|
5213
5760
|
* <p>The key passed into the request object. If <code>GroupByKey</code> is not provided, the result will be empty.</p>
|
|
5214
5761
|
*/
|
|
5215
5762
|
GroupByKey?: string;
|
|
5216
5763
|
/**
|
|
5764
|
+
* @public
|
|
5217
5765
|
* <p>Returns a list of GroupedResourceCount objects.</p>
|
|
5218
5766
|
*/
|
|
5219
5767
|
GroupedResourceCounts?: GroupedResourceCount[];
|
|
5220
5768
|
/**
|
|
5769
|
+
* @public
|
|
5221
5770
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
5222
5771
|
*/
|
|
5223
5772
|
NextToken?: string;
|
|
@@ -5227,10 +5776,12 @@ export interface GetAggregateDiscoveredResourceCountsResponse {
|
|
|
5227
5776
|
*/
|
|
5228
5777
|
export interface GetAggregateResourceConfigRequest {
|
|
5229
5778
|
/**
|
|
5779
|
+
* @public
|
|
5230
5780
|
* <p>The name of the configuration aggregator.</p>
|
|
5231
5781
|
*/
|
|
5232
5782
|
ConfigurationAggregatorName: string | undefined;
|
|
5233
5783
|
/**
|
|
5784
|
+
* @public
|
|
5234
5785
|
* <p>An object that identifies aggregate resource.</p>
|
|
5235
5786
|
*/
|
|
5236
5787
|
ResourceIdentifier: AggregateResourceIdentifier | undefined;
|
|
@@ -5240,6 +5791,7 @@ export interface GetAggregateResourceConfigRequest {
|
|
|
5240
5791
|
*/
|
|
5241
5792
|
export interface GetAggregateResourceConfigResponse {
|
|
5242
5793
|
/**
|
|
5794
|
+
* @public
|
|
5243
5795
|
* <p>Returns a <code>ConfigurationItem</code> object.</p>
|
|
5244
5796
|
*/
|
|
5245
5797
|
ConfigurationItem?: ConfigurationItem;
|
|
@@ -5275,23 +5827,27 @@ export declare class ResourceNotDiscoveredException extends __BaseException {
|
|
|
5275
5827
|
*/
|
|
5276
5828
|
export interface GetComplianceDetailsByConfigRuleRequest {
|
|
5277
5829
|
/**
|
|
5830
|
+
* @public
|
|
5278
5831
|
* <p>The name of the Config rule for which you want compliance
|
|
5279
5832
|
* information.</p>
|
|
5280
5833
|
*/
|
|
5281
5834
|
ConfigRuleName: string | undefined;
|
|
5282
5835
|
/**
|
|
5836
|
+
* @public
|
|
5283
5837
|
* <p>Filters the results by compliance.</p>
|
|
5284
5838
|
* <p>
|
|
5285
5839
|
* <code>INSUFFICIENT_DATA</code> is a valid <code>ComplianceType</code> that is returned when an Config rule cannot be evaluated. However, <code>INSUFFICIENT_DATA</code> cannot be used as a <code>ComplianceType</code> for filtering results.</p>
|
|
5286
5840
|
*/
|
|
5287
5841
|
ComplianceTypes?: (ComplianceType | string)[];
|
|
5288
5842
|
/**
|
|
5843
|
+
* @public
|
|
5289
5844
|
* <p>The maximum number of evaluation results returned on each page.
|
|
5290
5845
|
* The default is 10. You cannot specify a number greater than 100. If
|
|
5291
5846
|
* you specify 0, Config uses the default.</p>
|
|
5292
5847
|
*/
|
|
5293
5848
|
Limit?: number;
|
|
5294
5849
|
/**
|
|
5850
|
+
* @public
|
|
5295
5851
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
5296
5852
|
* that you use to get the next page of results in a paginated
|
|
5297
5853
|
* response.</p>
|
|
@@ -5304,11 +5860,13 @@ export interface GetComplianceDetailsByConfigRuleRequest {
|
|
|
5304
5860
|
*/
|
|
5305
5861
|
export interface GetComplianceDetailsByConfigRuleResponse {
|
|
5306
5862
|
/**
|
|
5863
|
+
* @public
|
|
5307
5864
|
* <p>Indicates whether the Amazon Web Services resource complies with the specified
|
|
5308
5865
|
* Config rule.</p>
|
|
5309
5866
|
*/
|
|
5310
5867
|
EvaluationResults?: EvaluationResult[];
|
|
5311
5868
|
/**
|
|
5869
|
+
* @public
|
|
5312
5870
|
* <p>The string that you use in a subsequent request to get the next
|
|
5313
5871
|
* page of results in a paginated response.</p>
|
|
5314
5872
|
*/
|
|
@@ -5320,28 +5878,33 @@ export interface GetComplianceDetailsByConfigRuleResponse {
|
|
|
5320
5878
|
*/
|
|
5321
5879
|
export interface GetComplianceDetailsByResourceRequest {
|
|
5322
5880
|
/**
|
|
5881
|
+
* @public
|
|
5323
5882
|
* <p>The type of the Amazon Web Services resource for which you want compliance
|
|
5324
5883
|
* information.</p>
|
|
5325
5884
|
*/
|
|
5326
5885
|
ResourceType?: string;
|
|
5327
5886
|
/**
|
|
5887
|
+
* @public
|
|
5328
5888
|
* <p>The ID of the Amazon Web Services resource for which you want compliance
|
|
5329
5889
|
* information.</p>
|
|
5330
5890
|
*/
|
|
5331
5891
|
ResourceId?: string;
|
|
5332
5892
|
/**
|
|
5893
|
+
* @public
|
|
5333
5894
|
* <p>Filters the results by compliance.</p>
|
|
5334
5895
|
* <p>
|
|
5335
5896
|
* <code>INSUFFICIENT_DATA</code> is a valid <code>ComplianceType</code> that is returned when an Config rule cannot be evaluated. However, <code>INSUFFICIENT_DATA</code> cannot be used as a <code>ComplianceType</code> for filtering results.</p>
|
|
5336
5897
|
*/
|
|
5337
5898
|
ComplianceTypes?: (ComplianceType | string)[];
|
|
5338
5899
|
/**
|
|
5900
|
+
* @public
|
|
5339
5901
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
5340
5902
|
* that you use to get the next page of results in a paginated
|
|
5341
5903
|
* response.</p>
|
|
5342
5904
|
*/
|
|
5343
5905
|
NextToken?: string;
|
|
5344
5906
|
/**
|
|
5907
|
+
* @public
|
|
5345
5908
|
* <p>The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results. </p>
|
|
5346
5909
|
* <note>
|
|
5347
5910
|
* <p>You need to only provide either a <code>ResourceEvaluationID</code> or a <code>ResourceID </code>and <code>ResourceType</code>.</p>
|
|
@@ -5355,10 +5918,12 @@ export interface GetComplianceDetailsByResourceRequest {
|
|
|
5355
5918
|
*/
|
|
5356
5919
|
export interface GetComplianceDetailsByResourceResponse {
|
|
5357
5920
|
/**
|
|
5921
|
+
* @public
|
|
5358
5922
|
* <p>Indicates whether the specified Amazon Web Services resource complies each Config rule.</p>
|
|
5359
5923
|
*/
|
|
5360
5924
|
EvaluationResults?: EvaluationResult[];
|
|
5361
5925
|
/**
|
|
5926
|
+
* @public
|
|
5362
5927
|
* <p>The string that you use in a subsequent request to get the next
|
|
5363
5928
|
* page of results in a paginated response.</p>
|
|
5364
5929
|
*/
|
|
@@ -5370,6 +5935,7 @@ export interface GetComplianceDetailsByResourceResponse {
|
|
|
5370
5935
|
*/
|
|
5371
5936
|
export interface GetComplianceSummaryByConfigRuleResponse {
|
|
5372
5937
|
/**
|
|
5938
|
+
* @public
|
|
5373
5939
|
* <p>The number of Config rules that are compliant and the
|
|
5374
5940
|
* number that are noncompliant, up to a maximum of 25 for
|
|
5375
5941
|
* each.</p>
|
|
@@ -5382,6 +5948,7 @@ export interface GetComplianceSummaryByConfigRuleResponse {
|
|
|
5382
5948
|
*/
|
|
5383
5949
|
export interface GetComplianceSummaryByResourceTypeRequest {
|
|
5384
5950
|
/**
|
|
5951
|
+
* @public
|
|
5385
5952
|
* <p>Specify one or more resource types to get the number of
|
|
5386
5953
|
* resources that are compliant and the number that are noncompliant
|
|
5387
5954
|
* for each resource type.</p>
|
|
@@ -5398,6 +5965,7 @@ export interface GetComplianceSummaryByResourceTypeRequest {
|
|
|
5398
5965
|
*/
|
|
5399
5966
|
export interface GetComplianceSummaryByResourceTypeResponse {
|
|
5400
5967
|
/**
|
|
5968
|
+
* @public
|
|
5401
5969
|
* <p>The number of resources that are compliant and the number that
|
|
5402
5970
|
* are noncompliant. If one or more resource types were provided with
|
|
5403
5971
|
* the request, the numbers are returned for each resource type. The
|
|
@@ -5410,18 +5978,22 @@ export interface GetComplianceSummaryByResourceTypeResponse {
|
|
|
5410
5978
|
*/
|
|
5411
5979
|
export interface GetConformancePackComplianceDetailsRequest {
|
|
5412
5980
|
/**
|
|
5981
|
+
* @public
|
|
5413
5982
|
* <p>Name of the conformance pack.</p>
|
|
5414
5983
|
*/
|
|
5415
5984
|
ConformancePackName: string | undefined;
|
|
5416
5985
|
/**
|
|
5986
|
+
* @public
|
|
5417
5987
|
* <p>A <code>ConformancePackEvaluationFilters</code> object.</p>
|
|
5418
5988
|
*/
|
|
5419
5989
|
Filters?: ConformancePackEvaluationFilters;
|
|
5420
5990
|
/**
|
|
5991
|
+
* @public
|
|
5421
5992
|
* <p>The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.</p>
|
|
5422
5993
|
*/
|
|
5423
5994
|
Limit?: number;
|
|
5424
5995
|
/**
|
|
5996
|
+
* @public
|
|
5425
5997
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
5426
5998
|
*/
|
|
5427
5999
|
NextToken?: string;
|
|
@@ -5431,14 +6003,17 @@ export interface GetConformancePackComplianceDetailsRequest {
|
|
|
5431
6003
|
*/
|
|
5432
6004
|
export interface GetConformancePackComplianceDetailsResponse {
|
|
5433
6005
|
/**
|
|
6006
|
+
* @public
|
|
5434
6007
|
* <p>Name of the conformance pack.</p>
|
|
5435
6008
|
*/
|
|
5436
6009
|
ConformancePackName: string | undefined;
|
|
5437
6010
|
/**
|
|
6011
|
+
* @public
|
|
5438
6012
|
* <p>Returns a list of <code>ConformancePackEvaluationResult</code> objects.</p>
|
|
5439
6013
|
*/
|
|
5440
6014
|
ConformancePackRuleEvaluationResults?: ConformancePackEvaluationResult[];
|
|
5441
6015
|
/**
|
|
6016
|
+
* @public
|
|
5442
6017
|
* <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
5443
6018
|
*/
|
|
5444
6019
|
NextToken?: string;
|
|
@@ -5448,14 +6023,17 @@ export interface GetConformancePackComplianceDetailsResponse {
|
|
|
5448
6023
|
*/
|
|
5449
6024
|
export interface GetConformancePackComplianceSummaryRequest {
|
|
5450
6025
|
/**
|
|
6026
|
+
* @public
|
|
5451
6027
|
* <p>Names of conformance packs.</p>
|
|
5452
6028
|
*/
|
|
5453
6029
|
ConformancePackNames: string[] | undefined;
|
|
5454
6030
|
/**
|
|
6031
|
+
* @public
|
|
5455
6032
|
* <p>The maximum number of conformance packs returned on each page.</p>
|
|
5456
6033
|
*/
|
|
5457
6034
|
Limit?: number;
|
|
5458
6035
|
/**
|
|
6036
|
+
* @public
|
|
5459
6037
|
* <p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
5460
6038
|
*/
|
|
5461
6039
|
NextToken?: string;
|
|
@@ -5465,10 +6043,12 @@ export interface GetConformancePackComplianceSummaryRequest {
|
|
|
5465
6043
|
*/
|
|
5466
6044
|
export interface GetConformancePackComplianceSummaryResponse {
|
|
5467
6045
|
/**
|
|
6046
|
+
* @public
|
|
5468
6047
|
* <p>A list of <code>ConformancePackComplianceSummary</code> objects. </p>
|
|
5469
6048
|
*/
|
|
5470
6049
|
ConformancePackComplianceSummaryList?: ConformancePackComplianceSummary[];
|
|
5471
6050
|
/**
|
|
6051
|
+
* @public
|
|
5472
6052
|
* <p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
5473
6053
|
*/
|
|
5474
6054
|
NextToken?: string;
|
|
@@ -5478,6 +6058,7 @@ export interface GetConformancePackComplianceSummaryResponse {
|
|
|
5478
6058
|
*/
|
|
5479
6059
|
export interface GetCustomRulePolicyRequest {
|
|
5480
6060
|
/**
|
|
6061
|
+
* @public
|
|
5481
6062
|
* <p>The name of your Config Custom Policy rule.</p>
|
|
5482
6063
|
*/
|
|
5483
6064
|
ConfigRuleName?: string;
|
|
@@ -5487,6 +6068,7 @@ export interface GetCustomRulePolicyRequest {
|
|
|
5487
6068
|
*/
|
|
5488
6069
|
export interface GetCustomRulePolicyResponse {
|
|
5489
6070
|
/**
|
|
6071
|
+
* @public
|
|
5490
6072
|
* <p>The policy definition containing the logic for your Config Custom Policy rule.</p>
|
|
5491
6073
|
*/
|
|
5492
6074
|
PolicyText?: string;
|
|
@@ -5496,6 +6078,7 @@ export interface GetCustomRulePolicyResponse {
|
|
|
5496
6078
|
*/
|
|
5497
6079
|
export interface GetDiscoveredResourceCountsRequest {
|
|
5498
6080
|
/**
|
|
6081
|
+
* @public
|
|
5499
6082
|
* <p>The comma-separated list that specifies the resource types that
|
|
5500
6083
|
* you want Config to return (for example,
|
|
5501
6084
|
* <code>"AWS::EC2::Instance"</code>,
|
|
@@ -5512,6 +6095,7 @@ export interface GetDiscoveredResourceCountsRequest {
|
|
|
5512
6095
|
*/
|
|
5513
6096
|
resourceTypes?: string[];
|
|
5514
6097
|
/**
|
|
6098
|
+
* @public
|
|
5515
6099
|
* <p>The maximum number of <a>ResourceCount</a> objects
|
|
5516
6100
|
* returned on each page. The default is 100. You cannot specify a
|
|
5517
6101
|
* number greater than 100. If you specify 0, Config uses the
|
|
@@ -5519,6 +6103,7 @@ export interface GetDiscoveredResourceCountsRequest {
|
|
|
5519
6103
|
*/
|
|
5520
6104
|
limit?: number;
|
|
5521
6105
|
/**
|
|
6106
|
+
* @public
|
|
5522
6107
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
5523
6108
|
* that you use to get the next page of results in a paginated
|
|
5524
6109
|
* response.</p>
|
|
@@ -5532,11 +6117,13 @@ export interface GetDiscoveredResourceCountsRequest {
|
|
|
5532
6117
|
*/
|
|
5533
6118
|
export interface ResourceCount {
|
|
5534
6119
|
/**
|
|
6120
|
+
* @public
|
|
5535
6121
|
* <p>The resource type (for example,
|
|
5536
6122
|
* <code>"AWS::EC2::Instance"</code>).</p>
|
|
5537
6123
|
*/
|
|
5538
6124
|
resourceType?: ResourceType | string;
|
|
5539
6125
|
/**
|
|
6126
|
+
* @public
|
|
5540
6127
|
* <p>The number of resources.</p>
|
|
5541
6128
|
*/
|
|
5542
6129
|
count?: number;
|
|
@@ -5546,6 +6133,7 @@ export interface ResourceCount {
|
|
|
5546
6133
|
*/
|
|
5547
6134
|
export interface GetDiscoveredResourceCountsResponse {
|
|
5548
6135
|
/**
|
|
6136
|
+
* @public
|
|
5549
6137
|
* <p>The total number of resources that Config is recording in
|
|
5550
6138
|
* the region for your account. If you specify resource types in the
|
|
5551
6139
|
* request, Config returns only the total number of resources for
|
|
@@ -5575,11 +6163,13 @@ export interface GetDiscoveredResourceCountsResponse {
|
|
|
5575
6163
|
*/
|
|
5576
6164
|
totalDiscoveredResources?: number;
|
|
5577
6165
|
/**
|
|
6166
|
+
* @public
|
|
5578
6167
|
* <p>The list of <code>ResourceCount</code> objects. Each object is
|
|
5579
6168
|
* listed in descending order by the number of resources.</p>
|
|
5580
6169
|
*/
|
|
5581
6170
|
resourceCounts?: ResourceCount[];
|
|
5582
6171
|
/**
|
|
6172
|
+
* @public
|
|
5583
6173
|
* <p>The string that you use in a subsequent request to get the next
|
|
5584
6174
|
* page of results in a paginated response.</p>
|
|
5585
6175
|
*/
|
|
@@ -5610,10 +6200,12 @@ export type MemberAccountRuleStatus = (typeof MemberAccountRuleStatus)[keyof typ
|
|
|
5610
6200
|
*/
|
|
5611
6201
|
export interface StatusDetailFilters {
|
|
5612
6202
|
/**
|
|
6203
|
+
* @public
|
|
5613
6204
|
* <p>The 12-digit account ID of the member account within an organization.</p>
|
|
5614
6205
|
*/
|
|
5615
6206
|
AccountId?: string;
|
|
5616
6207
|
/**
|
|
6208
|
+
* @public
|
|
5617
6209
|
* <p>Indicates deployment status for Config rule in the member account.
|
|
5618
6210
|
* When management account calls <code>PutOrganizationConfigRule</code> action for the first time, Config rule status is created in the member account.
|
|
5619
6211
|
* When management account calls <code>PutOrganizationConfigRule</code> action for the second time, Config rule status is updated in the member account.
|
|
@@ -5666,18 +6258,22 @@ export interface StatusDetailFilters {
|
|
|
5666
6258
|
*/
|
|
5667
6259
|
export interface GetOrganizationConfigRuleDetailedStatusRequest {
|
|
5668
6260
|
/**
|
|
6261
|
+
* @public
|
|
5669
6262
|
* <p>The name of your organization Config rule for which you want status details for member accounts.</p>
|
|
5670
6263
|
*/
|
|
5671
6264
|
OrganizationConfigRuleName: string | undefined;
|
|
5672
6265
|
/**
|
|
6266
|
+
* @public
|
|
5673
6267
|
* <p>A <code>StatusDetailFilters</code> object.</p>
|
|
5674
6268
|
*/
|
|
5675
6269
|
Filters?: StatusDetailFilters;
|
|
5676
6270
|
/**
|
|
6271
|
+
* @public
|
|
5677
6272
|
* <p>The maximum number of <code>OrganizationConfigRuleDetailedStatus</code> returned on each page. If you do not specify a number, Config uses the default. The default is 100.</p>
|
|
5678
6273
|
*/
|
|
5679
6274
|
Limit?: number;
|
|
5680
6275
|
/**
|
|
6276
|
+
* @public
|
|
5681
6277
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
5682
6278
|
*/
|
|
5683
6279
|
NextToken?: string;
|
|
@@ -5688,14 +6284,17 @@ export interface GetOrganizationConfigRuleDetailedStatusRequest {
|
|
|
5688
6284
|
*/
|
|
5689
6285
|
export interface MemberAccountStatus {
|
|
5690
6286
|
/**
|
|
6287
|
+
* @public
|
|
5691
6288
|
* <p>The 12-digit account ID of a member account.</p>
|
|
5692
6289
|
*/
|
|
5693
6290
|
AccountId: string | undefined;
|
|
5694
6291
|
/**
|
|
6292
|
+
* @public
|
|
5695
6293
|
* <p>The name of Config rule deployed in the member account.</p>
|
|
5696
6294
|
*/
|
|
5697
6295
|
ConfigRuleName: string | undefined;
|
|
5698
6296
|
/**
|
|
6297
|
+
* @public
|
|
5699
6298
|
* <p>Indicates deployment status for Config rule in the member account.
|
|
5700
6299
|
* When management account calls <code>PutOrganizationConfigRule</code> action for the first time, Config rule status is created in the member account.
|
|
5701
6300
|
* When management account calls <code>PutOrganizationConfigRule</code> action for the second time, Config rule status is updated in the member account.
|
|
@@ -5743,14 +6342,17 @@ export interface MemberAccountStatus {
|
|
|
5743
6342
|
*/
|
|
5744
6343
|
MemberAccountRuleStatus: MemberAccountRuleStatus | string | undefined;
|
|
5745
6344
|
/**
|
|
6345
|
+
* @public
|
|
5746
6346
|
* <p>An error code that is returned when Config rule creation or deletion failed in the member account.</p>
|
|
5747
6347
|
*/
|
|
5748
6348
|
ErrorCode?: string;
|
|
5749
6349
|
/**
|
|
6350
|
+
* @public
|
|
5750
6351
|
* <p>An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.</p>
|
|
5751
6352
|
*/
|
|
5752
6353
|
ErrorMessage?: string;
|
|
5753
6354
|
/**
|
|
6355
|
+
* @public
|
|
5754
6356
|
* <p>The timestamp of the last status update.</p>
|
|
5755
6357
|
*/
|
|
5756
6358
|
LastUpdateTime?: Date;
|
|
@@ -5760,10 +6362,12 @@ export interface MemberAccountStatus {
|
|
|
5760
6362
|
*/
|
|
5761
6363
|
export interface GetOrganizationConfigRuleDetailedStatusResponse {
|
|
5762
6364
|
/**
|
|
6365
|
+
* @public
|
|
5763
6366
|
* <p>A list of <code>MemberAccountStatus</code> objects.</p>
|
|
5764
6367
|
*/
|
|
5765
6368
|
OrganizationConfigRuleDetailedStatus?: MemberAccountStatus[];
|
|
5766
6369
|
/**
|
|
6370
|
+
* @public
|
|
5767
6371
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
5768
6372
|
*/
|
|
5769
6373
|
NextToken?: string;
|
|
@@ -5793,10 +6397,12 @@ export type OrganizationResourceDetailedStatus = (typeof OrganizationResourceDet
|
|
|
5793
6397
|
*/
|
|
5794
6398
|
export interface OrganizationResourceDetailedStatusFilters {
|
|
5795
6399
|
/**
|
|
6400
|
+
* @public
|
|
5796
6401
|
* <p>The 12-digit account ID of the member account within an organization.</p>
|
|
5797
6402
|
*/
|
|
5798
6403
|
AccountId?: string;
|
|
5799
6404
|
/**
|
|
6405
|
+
* @public
|
|
5800
6406
|
* <p>Indicates deployment status for conformance pack in a member account.
|
|
5801
6407
|
* When management account calls <code>PutOrganizationConformancePack</code> action for the first time, conformance pack status is created in the member account.
|
|
5802
6408
|
* When management account calls <code>PutOrganizationConformancePack</code> action for the second time, conformance pack status is updated in the member account.
|
|
@@ -5849,19 +6455,23 @@ export interface OrganizationResourceDetailedStatusFilters {
|
|
|
5849
6455
|
*/
|
|
5850
6456
|
export interface GetOrganizationConformancePackDetailedStatusRequest {
|
|
5851
6457
|
/**
|
|
6458
|
+
* @public
|
|
5852
6459
|
* <p>The name of organization conformance pack for which you want status details for member accounts.</p>
|
|
5853
6460
|
*/
|
|
5854
6461
|
OrganizationConformancePackName: string | undefined;
|
|
5855
6462
|
/**
|
|
6463
|
+
* @public
|
|
5856
6464
|
* <p>An <code>OrganizationResourceDetailedStatusFilters</code> object.</p>
|
|
5857
6465
|
*/
|
|
5858
6466
|
Filters?: OrganizationResourceDetailedStatusFilters;
|
|
5859
6467
|
/**
|
|
6468
|
+
* @public
|
|
5860
6469
|
* <p>The maximum number of <code>OrganizationConformancePackDetailedStatuses</code> returned on each page.
|
|
5861
6470
|
* If you do not specify a number, Config uses the default. The default is 100. </p>
|
|
5862
6471
|
*/
|
|
5863
6472
|
Limit?: number;
|
|
5864
6473
|
/**
|
|
6474
|
+
* @public
|
|
5865
6475
|
* <p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
5866
6476
|
*/
|
|
5867
6477
|
NextToken?: string;
|
|
@@ -5874,14 +6484,17 @@ export interface GetOrganizationConformancePackDetailedStatusRequest {
|
|
|
5874
6484
|
*/
|
|
5875
6485
|
export interface OrganizationConformancePackDetailedStatus {
|
|
5876
6486
|
/**
|
|
6487
|
+
* @public
|
|
5877
6488
|
* <p>The 12-digit account ID of a member account.</p>
|
|
5878
6489
|
*/
|
|
5879
6490
|
AccountId: string | undefined;
|
|
5880
6491
|
/**
|
|
6492
|
+
* @public
|
|
5881
6493
|
* <p>The name of conformance pack deployed in the member account.</p>
|
|
5882
6494
|
*/
|
|
5883
6495
|
ConformancePackName: string | undefined;
|
|
5884
6496
|
/**
|
|
6497
|
+
* @public
|
|
5885
6498
|
* <p>Indicates deployment status for conformance pack in a member account.
|
|
5886
6499
|
* When management account calls <code>PutOrganizationConformancePack</code> action for the first time, conformance pack status is created in the member account.
|
|
5887
6500
|
* When management account calls <code>PutOrganizationConformancePack</code> action for the second time, conformance pack status is updated in the member account.
|
|
@@ -5929,16 +6542,19 @@ export interface OrganizationConformancePackDetailedStatus {
|
|
|
5929
6542
|
*/
|
|
5930
6543
|
Status: OrganizationResourceDetailedStatus | string | undefined;
|
|
5931
6544
|
/**
|
|
6545
|
+
* @public
|
|
5932
6546
|
* <p>An error code that is returned when conformance pack creation or
|
|
5933
6547
|
* deletion failed in the member account. </p>
|
|
5934
6548
|
*/
|
|
5935
6549
|
ErrorCode?: string;
|
|
5936
6550
|
/**
|
|
6551
|
+
* @public
|
|
5937
6552
|
* <p>An error message indicating that conformance pack account creation or deletion
|
|
5938
6553
|
* has failed due to an error in the member account. </p>
|
|
5939
6554
|
*/
|
|
5940
6555
|
ErrorMessage?: string;
|
|
5941
6556
|
/**
|
|
6557
|
+
* @public
|
|
5942
6558
|
* <p>The timestamp of the last status update.</p>
|
|
5943
6559
|
*/
|
|
5944
6560
|
LastUpdateTime?: Date;
|
|
@@ -5948,10 +6564,12 @@ export interface OrganizationConformancePackDetailedStatus {
|
|
|
5948
6564
|
*/
|
|
5949
6565
|
export interface GetOrganizationConformancePackDetailedStatusResponse {
|
|
5950
6566
|
/**
|
|
6567
|
+
* @public
|
|
5951
6568
|
* <p>A list of <code>OrganizationConformancePackDetailedStatus</code> objects. </p>
|
|
5952
6569
|
*/
|
|
5953
6570
|
OrganizationConformancePackDetailedStatuses?: OrganizationConformancePackDetailedStatus[];
|
|
5954
6571
|
/**
|
|
6572
|
+
* @public
|
|
5955
6573
|
* <p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
5956
6574
|
*/
|
|
5957
6575
|
NextToken?: string;
|
|
@@ -5961,6 +6579,7 @@ export interface GetOrganizationConformancePackDetailedStatusResponse {
|
|
|
5961
6579
|
*/
|
|
5962
6580
|
export interface GetOrganizationCustomRulePolicyRequest {
|
|
5963
6581
|
/**
|
|
6582
|
+
* @public
|
|
5964
6583
|
* <p>The name of your organization Config Custom Policy rule. </p>
|
|
5965
6584
|
*/
|
|
5966
6585
|
OrganizationConfigRuleName: string | undefined;
|
|
@@ -5970,6 +6589,7 @@ export interface GetOrganizationCustomRulePolicyRequest {
|
|
|
5970
6589
|
*/
|
|
5971
6590
|
export interface GetOrganizationCustomRulePolicyResponse {
|
|
5972
6591
|
/**
|
|
6592
|
+
* @public
|
|
5973
6593
|
* <p>The policy definition containing the logic for your organization Config Custom Policy rule.</p>
|
|
5974
6594
|
*/
|
|
5975
6595
|
PolicyText?: string;
|
|
@@ -5981,20 +6601,24 @@ export interface GetOrganizationCustomRulePolicyResponse {
|
|
|
5981
6601
|
*/
|
|
5982
6602
|
export interface GetResourceConfigHistoryRequest {
|
|
5983
6603
|
/**
|
|
6604
|
+
* @public
|
|
5984
6605
|
* <p>The resource type.</p>
|
|
5985
6606
|
*/
|
|
5986
6607
|
resourceType: ResourceType | string | undefined;
|
|
5987
6608
|
/**
|
|
6609
|
+
* @public
|
|
5988
6610
|
* <p>The ID of the resource (for example.,
|
|
5989
6611
|
* <code>sg-xxxxxx</code>).</p>
|
|
5990
6612
|
*/
|
|
5991
6613
|
resourceId: string | undefined;
|
|
5992
6614
|
/**
|
|
6615
|
+
* @public
|
|
5993
6616
|
* <p>The time stamp that indicates a later time. If not specified,
|
|
5994
6617
|
* current time is taken.</p>
|
|
5995
6618
|
*/
|
|
5996
6619
|
laterTime?: Date;
|
|
5997
6620
|
/**
|
|
6621
|
+
* @public
|
|
5998
6622
|
* <p>The time stamp that indicates an earlier time. If not
|
|
5999
6623
|
* specified, the action returns paginated results that contain
|
|
6000
6624
|
* configuration items that start when the first configuration item was
|
|
@@ -6002,18 +6626,21 @@ export interface GetResourceConfigHistoryRequest {
|
|
|
6002
6626
|
*/
|
|
6003
6627
|
earlierTime?: Date;
|
|
6004
6628
|
/**
|
|
6629
|
+
* @public
|
|
6005
6630
|
* <p>The chronological order for configuration items listed. By
|
|
6006
6631
|
* default, the results are listed in reverse chronological
|
|
6007
6632
|
* order.</p>
|
|
6008
6633
|
*/
|
|
6009
6634
|
chronologicalOrder?: ChronologicalOrder | string;
|
|
6010
6635
|
/**
|
|
6636
|
+
* @public
|
|
6011
6637
|
* <p>The maximum number of configuration items returned on each
|
|
6012
6638
|
* page. The default is 10. You cannot specify a number greater than
|
|
6013
6639
|
* 100. If you specify 0, Config uses the default.</p>
|
|
6014
6640
|
*/
|
|
6015
6641
|
limit?: number;
|
|
6016
6642
|
/**
|
|
6643
|
+
* @public
|
|
6017
6644
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
6018
6645
|
* that you use to get the next page of results in a paginated
|
|
6019
6646
|
* response.</p>
|
|
@@ -6027,11 +6654,13 @@ export interface GetResourceConfigHistoryRequest {
|
|
|
6027
6654
|
*/
|
|
6028
6655
|
export interface GetResourceConfigHistoryResponse {
|
|
6029
6656
|
/**
|
|
6657
|
+
* @public
|
|
6030
6658
|
* <p>A list that contains the configuration history of one or more
|
|
6031
6659
|
* resources.</p>
|
|
6032
6660
|
*/
|
|
6033
6661
|
configurationItems?: ConfigurationItem[];
|
|
6034
6662
|
/**
|
|
6663
|
+
* @public
|
|
6035
6664
|
* <p>The string that you use in a subsequent request to get the next
|
|
6036
6665
|
* page of results in a paginated response.</p>
|
|
6037
6666
|
*/
|
|
@@ -6055,6 +6684,7 @@ export declare class InvalidTimeRangeException extends __BaseException {
|
|
|
6055
6684
|
*/
|
|
6056
6685
|
export interface GetResourceEvaluationSummaryRequest {
|
|
6057
6686
|
/**
|
|
6687
|
+
* @public
|
|
6058
6688
|
* <p>The unique <code>ResourceEvaluationId</code> of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.</p>
|
|
6059
6689
|
*/
|
|
6060
6690
|
ResourceEvaluationId: string | undefined;
|
|
@@ -6076,18 +6706,22 @@ export type ResourceConfigurationSchemaType = (typeof ResourceConfigurationSchem
|
|
|
6076
6706
|
*/
|
|
6077
6707
|
export interface ResourceDetails {
|
|
6078
6708
|
/**
|
|
6709
|
+
* @public
|
|
6079
6710
|
* <p>A unique resource ID for an evaluation.</p>
|
|
6080
6711
|
*/
|
|
6081
6712
|
ResourceId: string | undefined;
|
|
6082
6713
|
/**
|
|
6714
|
+
* @public
|
|
6083
6715
|
* <p>The type of resource being evaluated.</p>
|
|
6084
6716
|
*/
|
|
6085
6717
|
ResourceType: string | undefined;
|
|
6086
6718
|
/**
|
|
6719
|
+
* @public
|
|
6087
6720
|
* <p>The resource definition to be evaluated as per the resource configuration schema type.</p>
|
|
6088
6721
|
*/
|
|
6089
6722
|
ResourceConfiguration: string | undefined;
|
|
6090
6723
|
/**
|
|
6724
|
+
* @public
|
|
6091
6725
|
* <p>The schema type of the resource configuration.</p>
|
|
6092
6726
|
* <note>
|
|
6093
6727
|
* <p>You can find the
|
|
@@ -6104,30 +6738,37 @@ export interface ResourceDetails {
|
|
|
6104
6738
|
*/
|
|
6105
6739
|
export interface GetResourceEvaluationSummaryResponse {
|
|
6106
6740
|
/**
|
|
6741
|
+
* @public
|
|
6107
6742
|
* <p>The unique <code>ResourceEvaluationId</code> of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.</p>
|
|
6108
6743
|
*/
|
|
6109
6744
|
ResourceEvaluationId?: string;
|
|
6110
6745
|
/**
|
|
6746
|
+
* @public
|
|
6111
6747
|
* <p>Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.</p>
|
|
6112
6748
|
*/
|
|
6113
6749
|
EvaluationMode?: EvaluationMode | string;
|
|
6114
6750
|
/**
|
|
6751
|
+
* @public
|
|
6115
6752
|
* <p>Returns an <code>EvaluationStatus</code> object.</p>
|
|
6116
6753
|
*/
|
|
6117
6754
|
EvaluationStatus?: EvaluationStatus;
|
|
6118
6755
|
/**
|
|
6756
|
+
* @public
|
|
6119
6757
|
* <p>The start timestamp when Config rule starts evaluating compliance for the provided resource details.</p>
|
|
6120
6758
|
*/
|
|
6121
6759
|
EvaluationStartTimestamp?: Date;
|
|
6122
6760
|
/**
|
|
6761
|
+
* @public
|
|
6123
6762
|
* <p>The compliance status of the resource evaluation summary.</p>
|
|
6124
6763
|
*/
|
|
6125
6764
|
Compliance?: ComplianceType | string;
|
|
6126
6765
|
/**
|
|
6766
|
+
* @public
|
|
6127
6767
|
* <p>Returns an <code>EvaluationContext</code> object.</p>
|
|
6128
6768
|
*/
|
|
6129
6769
|
EvaluationContext?: EvaluationContext;
|
|
6130
6770
|
/**
|
|
6771
|
+
* @public
|
|
6131
6772
|
* <p>Returns a <code>ResourceDetails</code> object.</p>
|
|
6132
6773
|
*/
|
|
6133
6774
|
ResourceDetails?: ResourceDetails;
|
|
@@ -6137,6 +6778,7 @@ export interface GetResourceEvaluationSummaryResponse {
|
|
|
6137
6778
|
*/
|
|
6138
6779
|
export interface GetStoredQueryRequest {
|
|
6139
6780
|
/**
|
|
6781
|
+
* @public
|
|
6140
6782
|
* <p>The name of the query.</p>
|
|
6141
6783
|
*/
|
|
6142
6784
|
QueryName: string | undefined;
|
|
@@ -6147,22 +6789,27 @@ export interface GetStoredQueryRequest {
|
|
|
6147
6789
|
*/
|
|
6148
6790
|
export interface StoredQuery {
|
|
6149
6791
|
/**
|
|
6792
|
+
* @public
|
|
6150
6793
|
* <p>The ID of the query.</p>
|
|
6151
6794
|
*/
|
|
6152
6795
|
QueryId?: string;
|
|
6153
6796
|
/**
|
|
6797
|
+
* @public
|
|
6154
6798
|
* <p>Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.</p>
|
|
6155
6799
|
*/
|
|
6156
6800
|
QueryArn?: string;
|
|
6157
6801
|
/**
|
|
6802
|
+
* @public
|
|
6158
6803
|
* <p>The name of the query.</p>
|
|
6159
6804
|
*/
|
|
6160
6805
|
QueryName: string | undefined;
|
|
6161
6806
|
/**
|
|
6807
|
+
* @public
|
|
6162
6808
|
* <p>A unique description for the query.</p>
|
|
6163
6809
|
*/
|
|
6164
6810
|
Description?: string;
|
|
6165
6811
|
/**
|
|
6812
|
+
* @public
|
|
6166
6813
|
* <p>The expression of the query. For example, <code>SELECT
|
|
6167
6814
|
* resourceId,
|
|
6168
6815
|
* resourceType,
|
|
@@ -6179,6 +6826,7 @@ export interface StoredQuery {
|
|
|
6179
6826
|
*/
|
|
6180
6827
|
export interface GetStoredQueryResponse {
|
|
6181
6828
|
/**
|
|
6829
|
+
* @public
|
|
6182
6830
|
* <p>Returns a <code>StoredQuery</code> object.</p>
|
|
6183
6831
|
*/
|
|
6184
6832
|
StoredQuery?: StoredQuery;
|
|
@@ -6363,18 +7011,22 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
6363
7011
|
*/
|
|
6364
7012
|
export interface ResourceFilters {
|
|
6365
7013
|
/**
|
|
7014
|
+
* @public
|
|
6366
7015
|
* <p>The 12-digit source account ID.</p>
|
|
6367
7016
|
*/
|
|
6368
7017
|
AccountId?: string;
|
|
6369
7018
|
/**
|
|
7019
|
+
* @public
|
|
6370
7020
|
* <p>The ID of the resource.</p>
|
|
6371
7021
|
*/
|
|
6372
7022
|
ResourceId?: string;
|
|
6373
7023
|
/**
|
|
7024
|
+
* @public
|
|
6374
7025
|
* <p>The name of the resource.</p>
|
|
6375
7026
|
*/
|
|
6376
7027
|
ResourceName?: string;
|
|
6377
7028
|
/**
|
|
7029
|
+
* @public
|
|
6378
7030
|
* <p>The source region.</p>
|
|
6379
7031
|
*/
|
|
6380
7032
|
Region?: string;
|
|
@@ -6384,22 +7036,27 @@ export interface ResourceFilters {
|
|
|
6384
7036
|
*/
|
|
6385
7037
|
export interface ListAggregateDiscoveredResourcesRequest {
|
|
6386
7038
|
/**
|
|
7039
|
+
* @public
|
|
6387
7040
|
* <p>The name of the configuration aggregator. </p>
|
|
6388
7041
|
*/
|
|
6389
7042
|
ConfigurationAggregatorName: string | undefined;
|
|
6390
7043
|
/**
|
|
7044
|
+
* @public
|
|
6391
7045
|
* <p>The type of resources that you want Config to list in the response.</p>
|
|
6392
7046
|
*/
|
|
6393
7047
|
ResourceType: ResourceType | string | undefined;
|
|
6394
7048
|
/**
|
|
7049
|
+
* @public
|
|
6395
7050
|
* <p>Filters the results based on the <code>ResourceFilters</code> object.</p>
|
|
6396
7051
|
*/
|
|
6397
7052
|
Filters?: ResourceFilters;
|
|
6398
7053
|
/**
|
|
7054
|
+
* @public
|
|
6399
7055
|
* <p>The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default.</p>
|
|
6400
7056
|
*/
|
|
6401
7057
|
Limit?: number;
|
|
6402
7058
|
/**
|
|
7059
|
+
* @public
|
|
6403
7060
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
6404
7061
|
*/
|
|
6405
7062
|
NextToken?: string;
|
|
@@ -6409,10 +7066,12 @@ export interface ListAggregateDiscoveredResourcesRequest {
|
|
|
6409
7066
|
*/
|
|
6410
7067
|
export interface ListAggregateDiscoveredResourcesResponse {
|
|
6411
7068
|
/**
|
|
7069
|
+
* @public
|
|
6412
7070
|
* <p>Returns a list of <code>ResourceIdentifiers</code> objects.</p>
|
|
6413
7071
|
*/
|
|
6414
7072
|
ResourceIdentifiers?: AggregateResourceIdentifier[];
|
|
6415
7073
|
/**
|
|
7074
|
+
* @public
|
|
6416
7075
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
6417
7076
|
*/
|
|
6418
7077
|
NextToken?: string;
|
|
@@ -6445,26 +7104,31 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
6445
7104
|
*/
|
|
6446
7105
|
export interface ListConformancePackComplianceScoresRequest {
|
|
6447
7106
|
/**
|
|
7107
|
+
* @public
|
|
6448
7108
|
* <p>Filters the results based on the <code>ConformancePackComplianceScoresFilters</code>.</p>
|
|
6449
7109
|
*/
|
|
6450
7110
|
Filters?: ConformancePackComplianceScoresFilters;
|
|
6451
7111
|
/**
|
|
7112
|
+
* @public
|
|
6452
7113
|
* <p>Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.</p>
|
|
6453
7114
|
* <p>By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter <code>DESCENDING</code>.</p>
|
|
6454
7115
|
* <p>You can sort conformance pack compliance scores by the numerical value of the compliance score by entering <code>SCORE</code> in the <code>SortBy</code> action. When compliance scores are sorted by <code>SCORE</code>, conformance packs with a compliance score of <code>INSUFFICIENT_DATA</code> will be last when sorting by ascending order and first when sorting by descending order.</p>
|
|
6455
7116
|
*/
|
|
6456
7117
|
SortOrder?: SortOrder | string;
|
|
6457
7118
|
/**
|
|
7119
|
+
* @public
|
|
6458
7120
|
* <p>Sorts your conformance pack compliance scores in either ascending or descending order, depending on <code>SortOrder</code>.</p>
|
|
6459
7121
|
* <p>By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack.
|
|
6460
7122
|
* Enter <code>SCORE</code>, to sort conformance pack compliance scores by the numerical value of the compliance score.</p>
|
|
6461
7123
|
*/
|
|
6462
7124
|
SortBy?: SortBy | string;
|
|
6463
7125
|
/**
|
|
7126
|
+
* @public
|
|
6464
7127
|
* <p>The maximum number of conformance pack compliance scores returned on each page.</p>
|
|
6465
7128
|
*/
|
|
6466
7129
|
Limit?: number;
|
|
6467
7130
|
/**
|
|
7131
|
+
* @public
|
|
6468
7132
|
* <p>The <code>nextToken</code> string in a prior request that you can use to get the paginated response for the next set of conformance pack compliance scores.</p>
|
|
6469
7133
|
*/
|
|
6470
7134
|
NextToken?: string;
|
|
@@ -6474,10 +7138,12 @@ export interface ListConformancePackComplianceScoresRequest {
|
|
|
6474
7138
|
*/
|
|
6475
7139
|
export interface ListConformancePackComplianceScoresResponse {
|
|
6476
7140
|
/**
|
|
7141
|
+
* @public
|
|
6477
7142
|
* <p>The <code>nextToken</code> string that you can use to get the next page of results in a paginated response.</p>
|
|
6478
7143
|
*/
|
|
6479
7144
|
NextToken?: string;
|
|
6480
7145
|
/**
|
|
7146
|
+
* @public
|
|
6481
7147
|
* <p>A list of <code>ConformancePackComplianceScore</code> objects.</p>
|
|
6482
7148
|
*/
|
|
6483
7149
|
ConformancePackComplianceScores: ConformancePackComplianceScore[] | undefined;
|
|
@@ -6488,34 +7154,40 @@ export interface ListConformancePackComplianceScoresResponse {
|
|
|
6488
7154
|
*/
|
|
6489
7155
|
export interface ListDiscoveredResourcesRequest {
|
|
6490
7156
|
/**
|
|
7157
|
+
* @public
|
|
6491
7158
|
* <p>The type of resources that you want Config to list in the
|
|
6492
7159
|
* response.</p>
|
|
6493
7160
|
*/
|
|
6494
7161
|
resourceType: ResourceType | string | undefined;
|
|
6495
7162
|
/**
|
|
7163
|
+
* @public
|
|
6496
7164
|
* <p>The IDs of only those resources that you want Config to
|
|
6497
7165
|
* list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has
|
|
6498
7166
|
* discovered. You can list a minimum of 1 resourceID and a maximum of 20 resourceIds.</p>
|
|
6499
7167
|
*/
|
|
6500
7168
|
resourceIds?: string[];
|
|
6501
7169
|
/**
|
|
7170
|
+
* @public
|
|
6502
7171
|
* <p>The custom name of only those resources that you want Config to list in the response. If you do not specify this
|
|
6503
7172
|
* parameter, Config lists all resources of the specified type that
|
|
6504
7173
|
* it has discovered.</p>
|
|
6505
7174
|
*/
|
|
6506
7175
|
resourceName?: string;
|
|
6507
7176
|
/**
|
|
7177
|
+
* @public
|
|
6508
7178
|
* <p>The maximum number of resource identifiers returned on each
|
|
6509
7179
|
* page. The default is 100. You cannot specify a number greater than
|
|
6510
7180
|
* 100. If you specify 0, Config uses the default.</p>
|
|
6511
7181
|
*/
|
|
6512
7182
|
limit?: number;
|
|
6513
7183
|
/**
|
|
7184
|
+
* @public
|
|
6514
7185
|
* <p>Specifies whether Config includes deleted resources in the
|
|
6515
7186
|
* results. By default, deleted resources are not included.</p>
|
|
6516
7187
|
*/
|
|
6517
7188
|
includeDeletedResources?: boolean;
|
|
6518
7189
|
/**
|
|
7190
|
+
* @public
|
|
6519
7191
|
* <p>The <code>nextToken</code> string returned on a previous page
|
|
6520
7192
|
* that you use to get the next page of results in a paginated
|
|
6521
7193
|
* response.</p>
|
|
@@ -6529,19 +7201,23 @@ export interface ListDiscoveredResourcesRequest {
|
|
|
6529
7201
|
*/
|
|
6530
7202
|
export interface ResourceIdentifier {
|
|
6531
7203
|
/**
|
|
7204
|
+
* @public
|
|
6532
7205
|
* <p>The type of resource.</p>
|
|
6533
7206
|
*/
|
|
6534
7207
|
resourceType?: ResourceType | string;
|
|
6535
7208
|
/**
|
|
7209
|
+
* @public
|
|
6536
7210
|
* <p>The ID of the resource (for example,
|
|
6537
7211
|
* <code>sg-xxxxxx</code>).</p>
|
|
6538
7212
|
*/
|
|
6539
7213
|
resourceId?: string;
|
|
6540
7214
|
/**
|
|
7215
|
+
* @public
|
|
6541
7216
|
* <p>The custom name of the resource (if available).</p>
|
|
6542
7217
|
*/
|
|
6543
7218
|
resourceName?: string;
|
|
6544
7219
|
/**
|
|
7220
|
+
* @public
|
|
6545
7221
|
* <p>The time that the resource was deleted.</p>
|
|
6546
7222
|
*/
|
|
6547
7223
|
resourceDeletionTime?: Date;
|
|
@@ -6552,11 +7228,13 @@ export interface ResourceIdentifier {
|
|
|
6552
7228
|
*/
|
|
6553
7229
|
export interface ListDiscoveredResourcesResponse {
|
|
6554
7230
|
/**
|
|
7231
|
+
* @public
|
|
6555
7232
|
* <p>The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the
|
|
6556
7233
|
* custom resource name.</p>
|
|
6557
7234
|
*/
|
|
6558
7235
|
resourceIdentifiers?: ResourceIdentifier[];
|
|
6559
7236
|
/**
|
|
7237
|
+
* @public
|
|
6560
7238
|
* <p>The string that you use in a subsequent request to get the next
|
|
6561
7239
|
* page of results in a paginated response.</p>
|
|
6562
7240
|
*/
|
|
@@ -6568,10 +7246,12 @@ export interface ListDiscoveredResourcesResponse {
|
|
|
6568
7246
|
*/
|
|
6569
7247
|
export interface TimeWindow {
|
|
6570
7248
|
/**
|
|
7249
|
+
* @public
|
|
6571
7250
|
* <p>The start time of an execution.</p>
|
|
6572
7251
|
*/
|
|
6573
7252
|
StartTime?: Date;
|
|
6574
7253
|
/**
|
|
7254
|
+
* @public
|
|
6575
7255
|
* <p>The end time of an execution. The end time must be after the start date.</p>
|
|
6576
7256
|
*/
|
|
6577
7257
|
EndTime?: Date;
|
|
@@ -6582,14 +7262,17 @@ export interface TimeWindow {
|
|
|
6582
7262
|
*/
|
|
6583
7263
|
export interface ResourceEvaluationFilters {
|
|
6584
7264
|
/**
|
|
7265
|
+
* @public
|
|
6585
7266
|
* <p>Filters all resource evaluations results based on an evaluation mode. the valid value for this API is <code>Proactive</code>.</p>
|
|
6586
7267
|
*/
|
|
6587
7268
|
EvaluationMode?: EvaluationMode | string;
|
|
6588
7269
|
/**
|
|
7270
|
+
* @public
|
|
6589
7271
|
* <p>Returns a <code>TimeWindow</code> object.</p>
|
|
6590
7272
|
*/
|
|
6591
7273
|
TimeWindow?: TimeWindow;
|
|
6592
7274
|
/**
|
|
7275
|
+
* @public
|
|
6593
7276
|
* <p>Filters evaluations for a given infrastructure deployment. For example: CFN Stack.</p>
|
|
6594
7277
|
*/
|
|
6595
7278
|
EvaluationContextIdentifier?: string;
|
|
@@ -6599,15 +7282,18 @@ export interface ResourceEvaluationFilters {
|
|
|
6599
7282
|
*/
|
|
6600
7283
|
export interface ListResourceEvaluationsRequest {
|
|
6601
7284
|
/**
|
|
7285
|
+
* @public
|
|
6602
7286
|
* <p>Returns a <code>ResourceEvaluationFilters</code> object.</p>
|
|
6603
7287
|
*/
|
|
6604
7288
|
Filters?: ResourceEvaluationFilters;
|
|
6605
7289
|
/**
|
|
7290
|
+
* @public
|
|
6606
7291
|
* <p>The maximum number of evaluations returned on each page. The default is 10.
|
|
6607
7292
|
* You cannot specify a number greater than 100. If you specify 0, Config uses the default.</p>
|
|
6608
7293
|
*/
|
|
6609
7294
|
Limit?: number;
|
|
6610
7295
|
/**
|
|
7296
|
+
* @public
|
|
6611
7297
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
6612
7298
|
*/
|
|
6613
7299
|
NextToken?: string;
|
|
@@ -6618,14 +7304,17 @@ export interface ListResourceEvaluationsRequest {
|
|
|
6618
7304
|
*/
|
|
6619
7305
|
export interface ResourceEvaluation {
|
|
6620
7306
|
/**
|
|
7307
|
+
* @public
|
|
6621
7308
|
* <p>The ResourceEvaluationId of a evaluation.</p>
|
|
6622
7309
|
*/
|
|
6623
7310
|
ResourceEvaluationId?: string;
|
|
6624
7311
|
/**
|
|
7312
|
+
* @public
|
|
6625
7313
|
* <p>The mode of an evaluation. The valid values are Detective or Proactive.</p>
|
|
6626
7314
|
*/
|
|
6627
7315
|
EvaluationMode?: EvaluationMode | string;
|
|
6628
7316
|
/**
|
|
7317
|
+
* @public
|
|
6629
7318
|
* <p>The starting time of an execution.</p>
|
|
6630
7319
|
*/
|
|
6631
7320
|
EvaluationStartTimestamp?: Date;
|
|
@@ -6635,10 +7324,12 @@ export interface ResourceEvaluation {
|
|
|
6635
7324
|
*/
|
|
6636
7325
|
export interface ListResourceEvaluationsResponse {
|
|
6637
7326
|
/**
|
|
7327
|
+
* @public
|
|
6638
7328
|
* <p>Returns a <code>ResourceEvaluations</code> object.</p>
|
|
6639
7329
|
*/
|
|
6640
7330
|
ResourceEvaluations?: ResourceEvaluation[];
|
|
6641
7331
|
/**
|
|
7332
|
+
* @public
|
|
6642
7333
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
|
|
6643
7334
|
*/
|
|
6644
7335
|
NextToken?: string;
|
|
@@ -6648,10 +7339,12 @@ export interface ListResourceEvaluationsResponse {
|
|
|
6648
7339
|
*/
|
|
6649
7340
|
export interface ListStoredQueriesRequest {
|
|
6650
7341
|
/**
|
|
7342
|
+
* @public
|
|
6651
7343
|
* <p>The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.</p>
|
|
6652
7344
|
*/
|
|
6653
7345
|
NextToken?: string;
|
|
6654
7346
|
/**
|
|
7347
|
+
* @public
|
|
6655
7348
|
* <p>The maximum number of results to be returned with a single call.</p>
|
|
6656
7349
|
*/
|
|
6657
7350
|
MaxResults?: number;
|
|
@@ -6662,18 +7355,22 @@ export interface ListStoredQueriesRequest {
|
|
|
6662
7355
|
*/
|
|
6663
7356
|
export interface StoredQueryMetadata {
|
|
6664
7357
|
/**
|
|
7358
|
+
* @public
|
|
6665
7359
|
* <p>The ID of the query. </p>
|
|
6666
7360
|
*/
|
|
6667
7361
|
QueryId: string | undefined;
|
|
6668
7362
|
/**
|
|
7363
|
+
* @public
|
|
6669
7364
|
* <p>Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.</p>
|
|
6670
7365
|
*/
|
|
6671
7366
|
QueryArn: string | undefined;
|
|
6672
7367
|
/**
|
|
7368
|
+
* @public
|
|
6673
7369
|
* <p>The name of the query.</p>
|
|
6674
7370
|
*/
|
|
6675
7371
|
QueryName: string | undefined;
|
|
6676
7372
|
/**
|
|
7373
|
+
* @public
|
|
6677
7374
|
* <p>A unique description for the query.</p>
|
|
6678
7375
|
*/
|
|
6679
7376
|
Description?: string;
|
|
@@ -6683,10 +7380,12 @@ export interface StoredQueryMetadata {
|
|
|
6683
7380
|
*/
|
|
6684
7381
|
export interface ListStoredQueriesResponse {
|
|
6685
7382
|
/**
|
|
7383
|
+
* @public
|
|
6686
7384
|
* <p>A list of <code>StoredQueryMetadata</code> objects.</p>
|
|
6687
7385
|
*/
|
|
6688
7386
|
StoredQueryMetadata?: StoredQueryMetadata[];
|
|
6689
7387
|
/**
|
|
7388
|
+
* @public
|
|
6690
7389
|
* <p>If the previous paginated request didn't return all of the remaining results, the response object's <code>NextToken</code> parameter value is set to a token.
|
|
6691
7390
|
* To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter.
|
|
6692
7391
|
* If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>. </p>
|
|
@@ -6698,14 +7397,17 @@ export interface ListStoredQueriesResponse {
|
|
|
6698
7397
|
*/
|
|
6699
7398
|
export interface ListTagsForResourceRequest {
|
|
6700
7399
|
/**
|
|
7400
|
+
* @public
|
|
6701
7401
|
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are <code>ConfigRule</code>, <code>ConfigurationAggregator</code> and <code>AggregatorAuthorization</code>.</p>
|
|
6702
7402
|
*/
|
|
6703
7403
|
ResourceArn: string | undefined;
|
|
6704
7404
|
/**
|
|
7405
|
+
* @public
|
|
6705
7406
|
* <p>The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default. </p>
|
|
6706
7407
|
*/
|
|
6707
7408
|
Limit?: number;
|
|
6708
7409
|
/**
|
|
7410
|
+
* @public
|
|
6709
7411
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
6710
7412
|
*/
|
|
6711
7413
|
NextToken?: string;
|
|
@@ -6718,10 +7420,12 @@ export interface ListTagsForResourceRequest {
|
|
|
6718
7420
|
*/
|
|
6719
7421
|
export interface Tag {
|
|
6720
7422
|
/**
|
|
7423
|
+
* @public
|
|
6721
7424
|
* <p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.</p>
|
|
6722
7425
|
*/
|
|
6723
7426
|
Key?: string;
|
|
6724
7427
|
/**
|
|
7428
|
+
* @public
|
|
6725
7429
|
* <p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</p>
|
|
6726
7430
|
*/
|
|
6727
7431
|
Value?: string;
|
|
@@ -6731,10 +7435,12 @@ export interface Tag {
|
|
|
6731
7435
|
*/
|
|
6732
7436
|
export interface ListTagsForResourceResponse {
|
|
6733
7437
|
/**
|
|
7438
|
+
* @public
|
|
6734
7439
|
* <p>The tags for the resource.</p>
|
|
6735
7440
|
*/
|
|
6736
7441
|
Tags?: Tag[];
|
|
6737
7442
|
/**
|
|
7443
|
+
* @public
|
|
6738
7444
|
* <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>
|
|
6739
7445
|
*/
|
|
6740
7446
|
NextToken?: string;
|