@aws-sdk/client-inspector 3.533.0 → 3.535.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/dist-types/Inspector.d.ts +8 -1
  2. package/dist-types/InspectorClient.d.ts +1 -1
  3. package/dist-types/commands/AddAttributesToFindingsCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateAssessmentTargetCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateAssessmentTemplateCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateExclusionsPreviewCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateResourceGroupCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteAssessmentRunCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteAssessmentTargetCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteAssessmentTemplateCommand.d.ts +2 -1
  11. package/dist-types/commands/DescribeAssessmentRunsCommand.d.ts +2 -1
  12. package/dist-types/commands/DescribeAssessmentTargetsCommand.d.ts +2 -1
  13. package/dist-types/commands/DescribeAssessmentTemplatesCommand.d.ts +2 -1
  14. package/dist-types/commands/DescribeCrossAccountAccessRoleCommand.d.ts +2 -1
  15. package/dist-types/commands/DescribeExclusionsCommand.d.ts +2 -1
  16. package/dist-types/commands/DescribeFindingsCommand.d.ts +2 -1
  17. package/dist-types/commands/DescribeResourceGroupsCommand.d.ts +2 -1
  18. package/dist-types/commands/DescribeRulesPackagesCommand.d.ts +2 -1
  19. package/dist-types/commands/GetAssessmentReportCommand.d.ts +2 -1
  20. package/dist-types/commands/GetExclusionsPreviewCommand.d.ts +2 -1
  21. package/dist-types/commands/GetTelemetryMetadataCommand.d.ts +2 -1
  22. package/dist-types/commands/ListAssessmentRunAgentsCommand.d.ts +2 -1
  23. package/dist-types/commands/ListAssessmentRunsCommand.d.ts +2 -1
  24. package/dist-types/commands/ListAssessmentTargetsCommand.d.ts +2 -1
  25. package/dist-types/commands/ListAssessmentTemplatesCommand.d.ts +2 -1
  26. package/dist-types/commands/ListEventSubscriptionsCommand.d.ts +2 -1
  27. package/dist-types/commands/ListExclusionsCommand.d.ts +2 -1
  28. package/dist-types/commands/ListFindingsCommand.d.ts +2 -1
  29. package/dist-types/commands/ListRulesPackagesCommand.d.ts +2 -1
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  31. package/dist-types/commands/PreviewAgentsCommand.d.ts +2 -1
  32. package/dist-types/commands/RegisterCrossAccountAccessRoleCommand.d.ts +2 -1
  33. package/dist-types/commands/RemoveAttributesFromFindingsCommand.d.ts +2 -1
  34. package/dist-types/commands/SetTagsForResourceCommand.d.ts +2 -1
  35. package/dist-types/commands/StartAssessmentRunCommand.d.ts +2 -1
  36. package/dist-types/commands/StopAssessmentRunCommand.d.ts +2 -1
  37. package/dist-types/commands/SubscribeToEventCommand.d.ts +2 -1
  38. package/dist-types/commands/UnsubscribeFromEventCommand.d.ts +2 -1
  39. package/dist-types/commands/UpdateAssessmentTargetCommand.d.ts +2 -1
  40. package/dist-types/models/models_0.d.ts +351 -351
  41. package/dist-types/ts3.4/Inspector.d.ts +7 -0
  42. package/dist-types/ts3.4/commands/AddAttributesToFindingsCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/CreateAssessmentTargetCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/CreateAssessmentTemplateCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/CreateExclusionsPreviewCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/CreateResourceGroupCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/DeleteAssessmentRunCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/DeleteAssessmentTargetCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/DeleteAssessmentTemplateCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/DescribeAssessmentRunsCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/DescribeAssessmentTargetsCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/DescribeAssessmentTemplatesCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/DescribeCrossAccountAccessRoleCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/DescribeExclusionsCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/DescribeFindingsCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/DescribeResourceGroupsCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/DescribeRulesPackagesCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/GetAssessmentReportCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/GetExclusionsPreviewCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/GetTelemetryMetadataCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/ListAssessmentRunAgentsCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/ListAssessmentRunsCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/ListAssessmentTargetsCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/ListAssessmentTemplatesCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/ListEventSubscriptionsCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/ListExclusionsCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/ListFindingsCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/ListRulesPackagesCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/PreviewAgentsCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/commands/RegisterCrossAccountAccessRoleCommand.d.ts +9 -0
  72. package/dist-types/ts3.4/commands/RemoveAttributesFromFindingsCommand.d.ts +9 -0
  73. package/dist-types/ts3.4/commands/SetTagsForResourceCommand.d.ts +9 -0
  74. package/dist-types/ts3.4/commands/StartAssessmentRunCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/StopAssessmentRunCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/SubscribeToEventCommand.d.ts +9 -0
  77. package/dist-types/ts3.4/commands/UnsubscribeFromEventCommand.d.ts +9 -0
  78. package/dist-types/ts3.4/commands/UpdateAssessmentTargetCommand.d.ts +9 -0
  79. package/package.json +40 -40
@@ -19,20 +19,20 @@ export declare const AccessDeniedErrorCode: {
19
19
  */
20
20
  export type AccessDeniedErrorCode = (typeof AccessDeniedErrorCode)[keyof typeof AccessDeniedErrorCode];
21
21
  /**
22
- * @public
23
22
  * <p>You do not have required permissions to access the requested resource.</p>
23
+ * @public
24
24
  */
25
25
  export declare class AccessDeniedException extends __BaseException {
26
26
  readonly name: "AccessDeniedException";
27
27
  readonly $fault: "client";
28
28
  /**
29
- * @public
30
29
  * <p>Code that indicates the type of error that is generated.</p>
30
+ * @public
31
31
  */
32
32
  errorCode: AccessDeniedErrorCode | undefined;
33
33
  /**
34
- * @public
35
34
  * <p>You can immediately retry your request.</p>
35
+ * @public
36
36
  */
37
37
  canRetry: boolean | undefined;
38
38
  /**
@@ -41,19 +41,19 @@ export declare class AccessDeniedException extends __BaseException {
41
41
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
42
42
  }
43
43
  /**
44
- * @public
45
44
  * <p>This data type is used as a request parameter in the <a>AddAttributesToFindings</a> and <a>CreateAssessmentTemplate</a>
46
45
  * actions.</p>
46
+ * @public
47
47
  */
48
48
  export interface Attribute {
49
49
  /**
50
- * @public
51
50
  * <p>The attribute key.</p>
51
+ * @public
52
52
  */
53
53
  key: string | undefined;
54
54
  /**
55
- * @public
56
55
  * <p>The value assigned to the attribute key.</p>
56
+ * @public
57
57
  */
58
58
  value?: string;
59
59
  }
@@ -62,13 +62,13 @@ export interface Attribute {
62
62
  */
63
63
  export interface AddAttributesToFindingsRequest {
64
64
  /**
65
- * @public
66
65
  * <p>The ARNs that specify the findings that you want to assign attributes to.</p>
66
+ * @public
67
67
  */
68
68
  findingArns: string[] | undefined;
69
69
  /**
70
- * @public
71
70
  * <p>The array of attributes that you want to assign to specified findings.</p>
71
+ * @public
72
72
  */
73
73
  attributes: Attribute[] | undefined;
74
74
  }
@@ -89,19 +89,19 @@ export declare const FailedItemErrorCode: {
89
89
  */
90
90
  export type FailedItemErrorCode = (typeof FailedItemErrorCode)[keyof typeof FailedItemErrorCode];
91
91
  /**
92
- * @public
93
92
  * <p>Includes details about the failed items.</p>
93
+ * @public
94
94
  */
95
95
  export interface FailedItemDetails {
96
96
  /**
97
- * @public
98
97
  * <p>The status code of a failed item.</p>
98
+ * @public
99
99
  */
100
100
  failureCode: FailedItemErrorCode | undefined;
101
101
  /**
102
- * @public
103
102
  * <p>Indicates whether you can immediately retry a request for this item for a specified
104
103
  * resource.</p>
104
+ * @public
105
105
  */
106
106
  retryable: boolean | undefined;
107
107
  }
@@ -110,22 +110,22 @@ export interface FailedItemDetails {
110
110
  */
111
111
  export interface AddAttributesToFindingsResponse {
112
112
  /**
113
- * @public
114
113
  * <p>Attribute details that cannot be described. An error code is provided for each failed
115
114
  * item.</p>
115
+ * @public
116
116
  */
117
117
  failedItems: Record<string, FailedItemDetails> | undefined;
118
118
  }
119
119
  /**
120
- * @public
121
120
  * <p>Internal server error.</p>
121
+ * @public
122
122
  */
123
123
  export declare class InternalException extends __BaseException {
124
124
  readonly name: "InternalException";
125
125
  readonly $fault: "server";
126
126
  /**
127
- * @public
128
127
  * <p>You can immediately retry your request.</p>
128
+ * @public
129
129
  */
130
130
  canRetry: boolean | undefined;
131
131
  /**
@@ -198,21 +198,21 @@ export declare const InvalidInputErrorCode: {
198
198
  */
199
199
  export type InvalidInputErrorCode = (typeof InvalidInputErrorCode)[keyof typeof InvalidInputErrorCode];
200
200
  /**
201
- * @public
202
201
  * <p>The request was rejected because an invalid or out-of-range value was supplied for an
203
202
  * input parameter.</p>
203
+ * @public
204
204
  */
205
205
  export declare class InvalidInputException extends __BaseException {
206
206
  readonly name: "InvalidInputException";
207
207
  readonly $fault: "client";
208
208
  /**
209
- * @public
210
209
  * <p>Code that indicates the type of error that is generated.</p>
210
+ * @public
211
211
  */
212
212
  errorCode: InvalidInputErrorCode | undefined;
213
213
  /**
214
- * @public
215
214
  * <p>You can immediately retry your request.</p>
215
+ * @public
216
216
  */
217
217
  canRetry: boolean | undefined;
218
218
  /**
@@ -239,21 +239,21 @@ export declare const NoSuchEntityErrorCode: {
239
239
  */
240
240
  export type NoSuchEntityErrorCode = (typeof NoSuchEntityErrorCode)[keyof typeof NoSuchEntityErrorCode];
241
241
  /**
242
- * @public
243
242
  * <p>The request was rejected because it referenced an entity that does not exist. The
244
243
  * error code describes the entity.</p>
244
+ * @public
245
245
  */
246
246
  export declare class NoSuchEntityException extends __BaseException {
247
247
  readonly name: "NoSuchEntityException";
248
248
  readonly $fault: "client";
249
249
  /**
250
- * @public
251
250
  * <p>Code that indicates the type of error that is generated.</p>
251
+ * @public
252
252
  */
253
253
  errorCode: NoSuchEntityErrorCode | undefined;
254
254
  /**
255
- * @public
256
255
  * <p>You can immediately retry your request.</p>
256
+ * @public
257
257
  */
258
258
  canRetry: boolean | undefined;
259
259
  /**
@@ -262,15 +262,15 @@ export declare class NoSuchEntityException extends __BaseException {
262
262
  constructor(opts: __ExceptionOptionType<NoSuchEntityException, __BaseException>);
263
263
  }
264
264
  /**
265
- * @public
266
265
  * <p>The serice is temporary unavailable.</p>
266
+ * @public
267
267
  */
268
268
  export declare class ServiceTemporarilyUnavailableException extends __BaseException {
269
269
  readonly name: "ServiceTemporarilyUnavailableException";
270
270
  readonly $fault: "server";
271
271
  /**
272
- * @public
273
272
  * <p>You can wait and then retry your request.</p>
273
+ * @public
274
274
  */
275
275
  canRetry: boolean | undefined;
276
276
  /**
@@ -279,21 +279,21 @@ export declare class ServiceTemporarilyUnavailableException extends __BaseExcept
279
279
  constructor(opts: __ExceptionOptionType<ServiceTemporarilyUnavailableException, __BaseException>);
280
280
  }
281
281
  /**
282
- * @public
283
282
  * <p>Used in the exception error that is thrown if you start an assessment run for an
284
283
  * assessment target that includes an EC2 instance that is already participating in another
285
284
  * started assessment run.</p>
285
+ * @public
286
286
  */
287
287
  export interface AgentAlreadyRunningAssessment {
288
288
  /**
289
- * @public
290
289
  * <p>ID of the agent that is running on an EC2 instance that is already participating in
291
290
  * another started assessment run.</p>
291
+ * @public
292
292
  */
293
293
  agentId: string | undefined;
294
294
  /**
295
- * @public
296
295
  * <p>The ARN of the assessment run that has already been started.</p>
296
+ * @public
297
297
  */
298
298
  assessmentRunArn: string | undefined;
299
299
  }
@@ -327,93 +327,93 @@ export declare const AgentHealth: {
327
327
  */
328
328
  export type AgentHealth = (typeof AgentHealth)[keyof typeof AgentHealth];
329
329
  /**
330
- * @public
331
330
  * <p>Contains information about an Amazon Inspector agent. This data type is used as a
332
331
  * request parameter in the <a>ListAssessmentRunAgents</a> action.</p>
332
+ * @public
333
333
  */
334
334
  export interface AgentFilter {
335
335
  /**
336
- * @public
337
336
  * <p>The current health state of the agent. Values can be set to <b>HEALTHY</b> or <b>UNHEALTHY</b>.</p>
337
+ * @public
338
338
  */
339
339
  agentHealths: AgentHealth[] | undefined;
340
340
  /**
341
- * @public
342
341
  * <p>The detailed health state of the agent. Values can be set to <b>IDLE</b>, <b>RUNNING</b>, <b>SHUTDOWN</b>, <b>UNHEALTHY</b>, <b>THROTTLED</b>, and <b>UNKNOWN</b>. </p>
342
+ * @public
343
343
  */
344
344
  agentHealthCodes: AgentHealthCode[] | undefined;
345
345
  }
346
346
  /**
347
- * @public
348
347
  * <p>Used as a response element in the <a>PreviewAgents</a> action.</p>
348
+ * @public
349
349
  */
350
350
  export interface AgentPreview {
351
351
  /**
352
- * @public
353
352
  * <p>The hostname of the EC2 instance on which the Amazon Inspector Agent is
354
353
  * installed.</p>
354
+ * @public
355
355
  */
356
356
  hostname?: string;
357
357
  /**
358
- * @public
359
358
  * <p>The ID of the EC2 instance where the agent is installed.</p>
359
+ * @public
360
360
  */
361
361
  agentId: string | undefined;
362
362
  /**
363
- * @public
364
363
  * <p>The Auto Scaling group for the EC2 instance where the agent is installed.</p>
364
+ * @public
365
365
  */
366
366
  autoScalingGroup?: string;
367
367
  /**
368
- * @public
369
368
  * <p>The health status of the Amazon Inspector Agent.</p>
369
+ * @public
370
370
  */
371
371
  agentHealth?: AgentHealth;
372
372
  /**
373
- * @public
374
373
  * <p>The version of the Amazon Inspector Agent.</p>
374
+ * @public
375
375
  */
376
376
  agentVersion?: string;
377
377
  /**
378
- * @public
379
378
  * <p>The operating system running on the EC2 instance on which the Amazon Inspector Agent
380
379
  * is installed.</p>
380
+ * @public
381
381
  */
382
382
  operatingSystem?: string;
383
383
  /**
384
- * @public
385
384
  * <p>The kernel version of the operating system running on the EC2 instance on which the
386
385
  * Amazon Inspector Agent is installed.</p>
386
+ * @public
387
387
  */
388
388
  kernelVersion?: string;
389
389
  /**
390
- * @public
391
390
  * <p>The IP address of the EC2 instance on which the Amazon Inspector Agent is
392
391
  * installed.</p>
392
+ * @public
393
393
  */
394
394
  ipv4Address?: string;
395
395
  }
396
396
  /**
397
- * @public
398
397
  * <p>You started an assessment run, but one of the instances is already participating in
399
398
  * another assessment run.</p>
399
+ * @public
400
400
  */
401
401
  export declare class AgentsAlreadyRunningAssessmentException extends __BaseException {
402
402
  readonly name: "AgentsAlreadyRunningAssessmentException";
403
403
  readonly $fault: "client";
404
404
  /**
405
- * @public
406
405
  * <p></p>
406
+ * @public
407
407
  */
408
408
  agents: AgentAlreadyRunningAssessment[] | undefined;
409
409
  /**
410
- * @public
411
410
  * <p></p>
411
+ * @public
412
412
  */
413
413
  agentsTruncated: boolean | undefined;
414
414
  /**
415
- * @public
416
415
  * <p>You can immediately retry your request.</p>
416
+ * @public
417
417
  */
418
418
  canRetry: boolean | undefined;
419
419
  /**
@@ -466,40 +466,40 @@ export declare const AssessmentRunNotificationSnsStatusCode: {
466
466
  */
467
467
  export type AssessmentRunNotificationSnsStatusCode = (typeof AssessmentRunNotificationSnsStatusCode)[keyof typeof AssessmentRunNotificationSnsStatusCode];
468
468
  /**
469
- * @public
470
469
  * <p>Used as one of the elements of the <a>AssessmentRun</a> data
471
470
  * type.</p>
471
+ * @public
472
472
  */
473
473
  export interface AssessmentRunNotification {
474
474
  /**
475
- * @public
476
475
  * <p>The date of the notification.</p>
476
+ * @public
477
477
  */
478
478
  date: Date | undefined;
479
479
  /**
480
- * @public
481
480
  * <p>The event for which a notification is sent.</p>
481
+ * @public
482
482
  */
483
483
  event: InspectorEvent | undefined;
484
484
  /**
485
- * @public
486
485
  * <p>The message included in the notification.</p>
486
+ * @public
487
487
  */
488
488
  message?: string;
489
489
  /**
490
- * @public
491
490
  * <p>The Boolean value that specifies whether the notification represents an
492
491
  * error.</p>
492
+ * @public
493
493
  */
494
494
  error: boolean | undefined;
495
495
  /**
496
- * @public
497
496
  * <p>The SNS topic to which the SNS notification is sent.</p>
497
+ * @public
498
498
  */
499
499
  snsTopicArn?: string;
500
500
  /**
501
- * @public
502
501
  * <p>The status code of the SNS notification.</p>
502
+ * @public
503
503
  */
504
504
  snsPublishStatusCode?: AssessmentRunNotificationSnsStatusCode;
505
505
  }
@@ -527,290 +527,290 @@ export declare const AssessmentRunState: {
527
527
  */
528
528
  export type AssessmentRunState = (typeof AssessmentRunState)[keyof typeof AssessmentRunState];
529
529
  /**
530
- * @public
531
530
  * <p>Used as one of the elements of the <a>AssessmentRun</a> data
532
531
  * type.</p>
532
+ * @public
533
533
  */
534
534
  export interface AssessmentRunStateChange {
535
535
  /**
536
- * @public
537
536
  * <p>The last time the assessment run state changed.</p>
537
+ * @public
538
538
  */
539
539
  stateChangedAt: Date | undefined;
540
540
  /**
541
- * @public
542
541
  * <p>The assessment run state.</p>
542
+ * @public
543
543
  */
544
544
  state: AssessmentRunState | undefined;
545
545
  }
546
546
  /**
547
- * @public
548
547
  * <p>A snapshot of an Amazon Inspector assessment run that contains the findings of the
549
548
  * assessment run .</p>
550
549
  * <p>Used as the response element in the <a>DescribeAssessmentRuns</a>
551
550
  * action.</p>
551
+ * @public
552
552
  */
553
553
  export interface AssessmentRun {
554
554
  /**
555
- * @public
556
555
  * <p>The ARN of the assessment run.</p>
556
+ * @public
557
557
  */
558
558
  arn: string | undefined;
559
559
  /**
560
- * @public
561
560
  * <p>The auto-generated name for the assessment run.</p>
561
+ * @public
562
562
  */
563
563
  name: string | undefined;
564
564
  /**
565
- * @public
566
565
  * <p>The ARN of the assessment template that is associated with the assessment
567
566
  * run.</p>
567
+ * @public
568
568
  */
569
569
  assessmentTemplateArn: string | undefined;
570
570
  /**
571
- * @public
572
571
  * <p>The state of the assessment run.</p>
572
+ * @public
573
573
  */
574
574
  state: AssessmentRunState | undefined;
575
575
  /**
576
- * @public
577
576
  * <p>The duration of the assessment run.</p>
577
+ * @public
578
578
  */
579
579
  durationInSeconds: number | undefined;
580
580
  /**
581
- * @public
582
581
  * <p>The rules packages selected for the assessment run.</p>
582
+ * @public
583
583
  */
584
584
  rulesPackageArns: string[] | undefined;
585
585
  /**
586
- * @public
587
586
  * <p>The user-defined attributes that are assigned to every generated finding.</p>
587
+ * @public
588
588
  */
589
589
  userAttributesForFindings: Attribute[] | undefined;
590
590
  /**
591
- * @public
592
591
  * <p>The time when <a>StartAssessmentRun</a> was called.</p>
592
+ * @public
593
593
  */
594
594
  createdAt: Date | undefined;
595
595
  /**
596
- * @public
597
596
  * <p>The time when <a>StartAssessmentRun</a> was called.</p>
597
+ * @public
598
598
  */
599
599
  startedAt?: Date;
600
600
  /**
601
- * @public
602
601
  * <p>The assessment run completion time that corresponds to the rules packages evaluation
603
602
  * completion time or failure.</p>
603
+ * @public
604
604
  */
605
605
  completedAt?: Date;
606
606
  /**
607
- * @public
608
607
  * <p>The last time when the assessment run's state changed.</p>
608
+ * @public
609
609
  */
610
610
  stateChangedAt: Date | undefined;
611
611
  /**
612
- * @public
613
612
  * <p>A Boolean value (true or false) that specifies whether the process of collecting data
614
613
  * from the agents is completed.</p>
614
+ * @public
615
615
  */
616
616
  dataCollected: boolean | undefined;
617
617
  /**
618
- * @public
619
618
  * <p>A list of the assessment run state changes.</p>
619
+ * @public
620
620
  */
621
621
  stateChanges: AssessmentRunStateChange[] | undefined;
622
622
  /**
623
- * @public
624
623
  * <p>A list of notifications for the event subscriptions. A notification about a
625
624
  * particular generated finding is added to this list only once.</p>
625
+ * @public
626
626
  */
627
627
  notifications: AssessmentRunNotification[] | undefined;
628
628
  /**
629
- * @public
630
629
  * <p>Provides a total count of generated findings per severity.</p>
630
+ * @public
631
631
  */
632
632
  findingCounts: Partial<Record<Severity, number>> | undefined;
633
633
  }
634
634
  /**
635
- * @public
636
635
  * <p>The metadata about the Amazon Inspector application data metrics collected by the
637
636
  * agent. This data type is used as the response element in the <a>GetTelemetryMetadata</a> action.</p>
637
+ * @public
638
638
  */
639
639
  export interface TelemetryMetadata {
640
640
  /**
641
- * @public
642
641
  * <p>A specific type of behavioral data that is collected by the agent.</p>
642
+ * @public
643
643
  */
644
644
  messageType: string | undefined;
645
645
  /**
646
- * @public
647
646
  * <p>The count of messages that the agent sends to the Amazon Inspector service.</p>
647
+ * @public
648
648
  */
649
649
  count: number | undefined;
650
650
  /**
651
- * @public
652
651
  * <p>The data size of messages that the agent sends to the Amazon Inspector
653
652
  * service.</p>
653
+ * @public
654
654
  */
655
655
  dataSize?: number;
656
656
  }
657
657
  /**
658
- * @public
659
658
  * <p>Contains information about an Amazon Inspector agent. This data type is used as a
660
659
  * response element in the <a>ListAssessmentRunAgents</a> action.</p>
660
+ * @public
661
661
  */
662
662
  export interface AssessmentRunAgent {
663
663
  /**
664
- * @public
665
664
  * <p>The AWS account of the EC2 instance where the agent is installed.</p>
665
+ * @public
666
666
  */
667
667
  agentId: string | undefined;
668
668
  /**
669
- * @public
670
669
  * <p>The ARN of the assessment run that is associated with the agent.</p>
670
+ * @public
671
671
  */
672
672
  assessmentRunArn: string | undefined;
673
673
  /**
674
- * @public
675
674
  * <p>The current health state of the agent.</p>
675
+ * @public
676
676
  */
677
677
  agentHealth: AgentHealth | undefined;
678
678
  /**
679
- * @public
680
679
  * <p>The detailed health state of the agent.</p>
680
+ * @public
681
681
  */
682
682
  agentHealthCode: AgentHealthCode | undefined;
683
683
  /**
684
- * @public
685
684
  * <p>The description for the agent health code.</p>
685
+ * @public
686
686
  */
687
687
  agentHealthDetails?: string;
688
688
  /**
689
- * @public
690
689
  * <p>The Auto Scaling group of the EC2 instance that is specified by the agent
691
690
  * ID.</p>
691
+ * @public
692
692
  */
693
693
  autoScalingGroup?: string;
694
694
  /**
695
- * @public
696
695
  * <p>The Amazon Inspector application data metrics that are collected by the
697
696
  * agent.</p>
697
+ * @public
698
698
  */
699
699
  telemetryMetadata: TelemetryMetadata[] | undefined;
700
700
  }
701
701
  /**
702
- * @public
703
702
  * <p>This data type is used in the <a>AssessmentRunFilter</a> data
704
703
  * type.</p>
704
+ * @public
705
705
  */
706
706
  export interface TimestampRange {
707
707
  /**
708
- * @public
709
708
  * <p>The minimum value of the timestamp range.</p>
709
+ * @public
710
710
  */
711
711
  beginDate?: Date;
712
712
  /**
713
- * @public
714
713
  * <p>The maximum value of the timestamp range.</p>
714
+ * @public
715
715
  */
716
716
  endDate?: Date;
717
717
  }
718
718
  /**
719
- * @public
720
719
  * <p>This data type is used in the <a>AssessmentTemplateFilter</a> data
721
720
  * type.</p>
721
+ * @public
722
722
  */
723
723
  export interface DurationRange {
724
724
  /**
725
- * @public
726
725
  * <p>The minimum value of the duration range. Must be greater than zero.</p>
726
+ * @public
727
727
  */
728
728
  minSeconds?: number;
729
729
  /**
730
- * @public
731
730
  * <p>The maximum value of the duration range. Must be less than or equal to 604800 seconds
732
731
  * (1 week).</p>
732
+ * @public
733
733
  */
734
734
  maxSeconds?: number;
735
735
  }
736
736
  /**
737
- * @public
738
737
  * <p>Used as the request parameter in the <a>ListAssessmentRuns</a>
739
738
  * action.</p>
739
+ * @public
740
740
  */
741
741
  export interface AssessmentRunFilter {
742
742
  /**
743
- * @public
744
743
  * <p>For a record to match a filter, an explicit value or a string containing a wildcard
745
744
  * that is specified for this data type property must match the value of the <b>assessmentRunName</b> property of the <a>AssessmentRun</a>
746
745
  * data type.</p>
746
+ * @public
747
747
  */
748
748
  namePattern?: string;
749
749
  /**
750
- * @public
751
750
  * <p>For a record to match a filter, one of the values specified for this data type
752
751
  * property must be the exact match of the value of the <b>assessmentRunState</b> property of the <a>AssessmentRun</a> data
753
752
  * type.</p>
753
+ * @public
754
754
  */
755
755
  states?: AssessmentRunState[];
756
756
  /**
757
- * @public
758
757
  * <p>For a record to match a filter, the value that is specified for this data type
759
758
  * property must inclusively match any value between the specified minimum and maximum values
760
759
  * of the <b>durationInSeconds</b> property of the <a>AssessmentRun</a> data type.</p>
760
+ * @public
761
761
  */
762
762
  durationRange?: DurationRange;
763
763
  /**
764
- * @public
765
764
  * <p>For a record to match a filter, the value that is specified for this data type
766
765
  * property must be contained in the list of values of the <b>rulesPackages</b> property of the <a>AssessmentRun</a> data
767
766
  * type.</p>
767
+ * @public
768
768
  */
769
769
  rulesPackageArns?: string[];
770
770
  /**
771
- * @public
772
771
  * <p>For a record to match a filter, the value that is specified for this data type
773
772
  * property must inclusively match any value between the specified minimum and maximum values
774
773
  * of the <b>startTime</b> property of the <a>AssessmentRun</a> data type.</p>
774
+ * @public
775
775
  */
776
776
  startTimeRange?: TimestampRange;
777
777
  /**
778
- * @public
779
778
  * <p>For a record to match a filter, the value that is specified for this data type
780
779
  * property must inclusively match any value between the specified minimum and maximum values
781
780
  * of the <b>completedAt</b> property of the <a>AssessmentRun</a> data type.</p>
781
+ * @public
782
782
  */
783
783
  completionTimeRange?: TimestampRange;
784
784
  /**
785
- * @public
786
785
  * <p>For a record to match a filter, the value that is specified for this data type
787
786
  * property must match the <b>stateChangedAt</b> property of the
788
787
  * <a>AssessmentRun</a> data type.</p>
788
+ * @public
789
789
  */
790
790
  stateChangeTimeRange?: TimestampRange;
791
791
  }
792
792
  /**
793
- * @public
794
793
  * <p>You cannot perform a specified action if an assessment run is currently in
795
794
  * progress.</p>
795
+ * @public
796
796
  */
797
797
  export declare class AssessmentRunInProgressException extends __BaseException {
798
798
  readonly name: "AssessmentRunInProgressException";
799
799
  readonly $fault: "client";
800
800
  /**
801
- * @public
802
801
  * <p>The ARNs of the assessment runs that are currently in progress.</p>
802
+ * @public
803
803
  */
804
804
  assessmentRunArns: string[] | undefined;
805
805
  /**
806
- * @public
807
806
  * <p>Boolean value that indicates whether the ARN list of the assessment runs is
808
807
  * truncated.</p>
808
+ * @public
809
809
  */
810
810
  assessmentRunArnsTruncated: boolean | undefined;
811
811
  /**
812
- * @public
813
812
  * <p>You can immediately retry your request.</p>
813
+ * @public
814
814
  */
815
815
  canRetry: boolean | undefined;
816
816
  /**
@@ -819,298 +819,298 @@ export declare class AssessmentRunInProgressException extends __BaseException {
819
819
  constructor(opts: __ExceptionOptionType<AssessmentRunInProgressException, __BaseException>);
820
820
  }
821
821
  /**
822
- * @public
823
822
  * <p>Contains information about an Amazon Inspector application. This data type is used as
824
823
  * the response element in the <a>DescribeAssessmentTargets</a> action.</p>
824
+ * @public
825
825
  */
826
826
  export interface AssessmentTarget {
827
827
  /**
828
- * @public
829
828
  * <p>The ARN that specifies the Amazon Inspector assessment target.</p>
829
+ * @public
830
830
  */
831
831
  arn: string | undefined;
832
832
  /**
833
- * @public
834
833
  * <p>The name of the Amazon Inspector assessment target.</p>
834
+ * @public
835
835
  */
836
836
  name: string | undefined;
837
837
  /**
838
- * @public
839
838
  * <p>The ARN that specifies the resource group that is associated with the assessment
840
839
  * target.</p>
840
+ * @public
841
841
  */
842
842
  resourceGroupArn?: string;
843
843
  /**
844
- * @public
845
844
  * <p>The time at which the assessment target is created.</p>
845
+ * @public
846
846
  */
847
847
  createdAt: Date | undefined;
848
848
  /**
849
- * @public
850
849
  * <p>The time at which <a>UpdateAssessmentTarget</a> is called.</p>
850
+ * @public
851
851
  */
852
852
  updatedAt: Date | undefined;
853
853
  }
854
854
  /**
855
- * @public
856
855
  * <p>Used as the request parameter in the <a>ListAssessmentTargets</a>
857
856
  * action.</p>
857
+ * @public
858
858
  */
859
859
  export interface AssessmentTargetFilter {
860
860
  /**
861
- * @public
862
861
  * <p>For a record to match a filter, an explicit value or a string that contains a
863
862
  * wildcard that is specified for this data type property must match the value of the
864
863
  * <b>assessmentTargetName</b> property of the <a>AssessmentTarget</a> data type.</p>
864
+ * @public
865
865
  */
866
866
  assessmentTargetNamePattern?: string;
867
867
  }
868
868
  /**
869
- * @public
870
869
  * <p>Contains information about an Amazon Inspector assessment template. This data type is
871
870
  * used as the response element in the <a>DescribeAssessmentTemplates</a>
872
871
  * action.</p>
872
+ * @public
873
873
  */
874
874
  export interface AssessmentTemplate {
875
875
  /**
876
- * @public
877
876
  * <p>The ARN of the assessment template.</p>
877
+ * @public
878
878
  */
879
879
  arn: string | undefined;
880
880
  /**
881
- * @public
882
881
  * <p>The name of the assessment template.</p>
882
+ * @public
883
883
  */
884
884
  name: string | undefined;
885
885
  /**
886
- * @public
887
886
  * <p>The ARN of the assessment target that corresponds to this assessment
888
887
  * template.</p>
888
+ * @public
889
889
  */
890
890
  assessmentTargetArn: string | undefined;
891
891
  /**
892
- * @public
893
892
  * <p>The duration in seconds specified for this assessment template. The default value is
894
893
  * 3600 seconds (one hour). The maximum value is 86400 seconds (one day).</p>
894
+ * @public
895
895
  */
896
896
  durationInSeconds: number | undefined;
897
897
  /**
898
- * @public
899
898
  * <p>The rules packages that are specified for this assessment template.</p>
899
+ * @public
900
900
  */
901
901
  rulesPackageArns: string[] | undefined;
902
902
  /**
903
- * @public
904
903
  * <p>The user-defined attributes that are assigned to every generated finding from the
905
904
  * assessment run that uses this assessment template.</p>
905
+ * @public
906
906
  */
907
907
  userAttributesForFindings: Attribute[] | undefined;
908
908
  /**
909
- * @public
910
909
  * <p>The Amazon Resource Name (ARN) of the most recent assessment run associated with this
911
910
  * assessment template. This value exists only when the value of assessmentRunCount is
912
911
  * greaterpa than zero.</p>
912
+ * @public
913
913
  */
914
914
  lastAssessmentRunArn?: string;
915
915
  /**
916
- * @public
917
916
  * <p>The number of existing assessment runs associated with this assessment template. This
918
917
  * value can be zero or a positive integer.</p>
918
+ * @public
919
919
  */
920
920
  assessmentRunCount: number | undefined;
921
921
  /**
922
- * @public
923
922
  * <p>The time at which the assessment template is created.</p>
923
+ * @public
924
924
  */
925
925
  createdAt: Date | undefined;
926
926
  }
927
927
  /**
928
- * @public
929
928
  * <p>Used as the request parameter in the <a>ListAssessmentTemplates</a>
930
929
  * action.</p>
930
+ * @public
931
931
  */
932
932
  export interface AssessmentTemplateFilter {
933
933
  /**
934
- * @public
935
934
  * <p>For a record to match a filter, an explicit value or a string that contains a
936
935
  * wildcard that is specified for this data type property must match the value of the
937
936
  * <b>assessmentTemplateName</b> property of the <a>AssessmentTemplate</a> data type.</p>
937
+ * @public
938
938
  */
939
939
  namePattern?: string;
940
940
  /**
941
- * @public
942
941
  * <p>For a record to match a filter, the value specified for this data type property must
943
942
  * inclusively match any value between the specified minimum and maximum values of the
944
943
  * <b>durationInSeconds</b> property of the <a>AssessmentTemplate</a> data type.</p>
944
+ * @public
945
945
  */
946
946
  durationRange?: DurationRange;
947
947
  /**
948
- * @public
949
948
  * <p>For a record to match a filter, the values that are specified for this data type
950
949
  * property must be contained in the list of values of the <b>rulesPackageArns</b> property of the <a>AssessmentTemplate</a> data
951
950
  * type.</p>
951
+ * @public
952
952
  */
953
953
  rulesPackageArns?: string[];
954
954
  }
955
955
  /**
956
- * @public
957
956
  * <p>Contains information about a private IP address associated with a network interface. This
958
957
  * data type is used as a response element in the <a>DescribeFindings</a>
959
958
  * action.</p>
959
+ * @public
960
960
  */
961
961
  export interface PrivateIp {
962
962
  /**
963
- * @public
964
963
  * <p>The DNS name of the private IP address.</p>
964
+ * @public
965
965
  */
966
966
  privateDnsName?: string;
967
967
  /**
968
- * @public
969
968
  * <p>The full IP address of the network inteface.</p>
969
+ * @public
970
970
  */
971
971
  privateIpAddress?: string;
972
972
  }
973
973
  /**
974
- * @public
975
974
  * <p>Contains information about a security group associated with a network interface. This
976
975
  * data type is used as one of the elements of the <a>NetworkInterface</a> data
977
976
  * type.</p>
977
+ * @public
978
978
  */
979
979
  export interface SecurityGroup {
980
980
  /**
981
- * @public
982
981
  * <p>The name of the security group.</p>
982
+ * @public
983
983
  */
984
984
  groupName?: string;
985
985
  /**
986
- * @public
987
986
  * <p>The ID of the security group.</p>
987
+ * @public
988
988
  */
989
989
  groupId?: string;
990
990
  }
991
991
  /**
992
- * @public
993
992
  * <p>Contains information about the network interfaces interacting with an EC2 instance.
994
993
  * This data type is used as one of the elements of the <a>AssetAttributes</a> data
995
994
  * type.</p>
995
+ * @public
996
996
  */
997
997
  export interface NetworkInterface {
998
998
  /**
999
- * @public
1000
999
  * <p>The ID of the network interface.</p>
1000
+ * @public
1001
1001
  */
1002
1002
  networkInterfaceId?: string;
1003
1003
  /**
1004
- * @public
1005
1004
  * <p>The ID of a subnet associated with the network interface.</p>
1005
+ * @public
1006
1006
  */
1007
1007
  subnetId?: string;
1008
1008
  /**
1009
- * @public
1010
1009
  * <p>The ID of a VPC associated with the network interface.</p>
1010
+ * @public
1011
1011
  */
1012
1012
  vpcId?: string;
1013
1013
  /**
1014
- * @public
1015
1014
  * <p>The name of a private DNS associated with the network interface.</p>
1015
+ * @public
1016
1016
  */
1017
1017
  privateDnsName?: string;
1018
1018
  /**
1019
- * @public
1020
1019
  * <p>The private IP address associated with the network interface.</p>
1020
+ * @public
1021
1021
  */
1022
1022
  privateIpAddress?: string;
1023
1023
  /**
1024
- * @public
1025
1024
  * <p>A list of the private IP addresses associated with the network interface. Includes
1026
1025
  * the privateDnsName and privateIpAddress.</p>
1026
+ * @public
1027
1027
  */
1028
1028
  privateIpAddresses?: PrivateIp[];
1029
1029
  /**
1030
- * @public
1031
1030
  * <p>The name of a public DNS associated with the network interface.</p>
1031
+ * @public
1032
1032
  */
1033
1033
  publicDnsName?: string;
1034
1034
  /**
1035
- * @public
1036
1035
  * <p>The public IP address from which the network interface is reachable.</p>
1036
+ * @public
1037
1037
  */
1038
1038
  publicIp?: string;
1039
1039
  /**
1040
- * @public
1041
1040
  * <p>The IP addresses associated with the network interface.</p>
1041
+ * @public
1042
1042
  */
1043
1043
  ipv6Addresses?: string[];
1044
1044
  /**
1045
- * @public
1046
1045
  * <p>A list of the security groups associated with the network interface. Includes the
1047
1046
  * groupId and groupName.</p>
1047
+ * @public
1048
1048
  */
1049
1049
  securityGroups?: SecurityGroup[];
1050
1050
  }
1051
1051
  /**
1052
- * @public
1053
1052
  * <p>A key and value pair. This data type is used as a request parameter in the <a>SetTagsForResource</a> action and a response element in the <a>ListTagsForResource</a> action.</p>
1053
+ * @public
1054
1054
  */
1055
1055
  export interface Tag {
1056
1056
  /**
1057
- * @public
1058
1057
  * <p>A tag key.</p>
1058
+ * @public
1059
1059
  */
1060
1060
  key: string | undefined;
1061
1061
  /**
1062
- * @public
1063
1062
  * <p>A value assigned to a tag key.</p>
1063
+ * @public
1064
1064
  */
1065
1065
  value?: string;
1066
1066
  }
1067
1067
  /**
1068
- * @public
1069
1068
  * <p>A collection of attributes of the host from which the finding is generated.</p>
1069
+ * @public
1070
1070
  */
1071
1071
  export interface AssetAttributes {
1072
1072
  /**
1073
- * @public
1074
1073
  * <p>The schema version of this data type.</p>
1074
+ * @public
1075
1075
  */
1076
1076
  schemaVersion: number | undefined;
1077
1077
  /**
1078
- * @public
1079
1078
  * <p>The ID of the agent that is installed on the EC2 instance where the finding is
1080
1079
  * generated.</p>
1080
+ * @public
1081
1081
  */
1082
1082
  agentId?: string;
1083
1083
  /**
1084
- * @public
1085
1084
  * <p>The Auto Scaling group of the EC2 instance where the finding is generated.</p>
1085
+ * @public
1086
1086
  */
1087
1087
  autoScalingGroup?: string;
1088
1088
  /**
1089
- * @public
1090
1089
  * <p>The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where
1091
1090
  * the finding is generated.</p>
1091
+ * @public
1092
1092
  */
1093
1093
  amiId?: string;
1094
1094
  /**
1095
- * @public
1096
1095
  * <p>The hostname of the EC2 instance where the finding is generated.</p>
1096
+ * @public
1097
1097
  */
1098
1098
  hostname?: string;
1099
1099
  /**
1100
- * @public
1101
1100
  * <p>The list of IP v4 addresses of the EC2 instance where the finding is
1102
1101
  * generated.</p>
1102
+ * @public
1103
1103
  */
1104
1104
  ipv4Addresses?: string[];
1105
1105
  /**
1106
- * @public
1107
1106
  * <p>The tags related to the EC2 instance where the finding is generated.</p>
1107
+ * @public
1108
1108
  */
1109
1109
  tags?: Tag[];
1110
1110
  /**
1111
- * @public
1112
1111
  * <p>An array of the network interfaces interacting with the EC2 instance where the
1113
1112
  * finding is generated.</p>
1113
+ * @public
1114
1114
  */
1115
1115
  networkInterfaces?: NetworkInterface[];
1116
1116
  }
@@ -1130,16 +1130,16 @@ export type AssetType = (typeof AssetType)[keyof typeof AssetType];
1130
1130
  */
1131
1131
  export interface CreateAssessmentTargetRequest {
1132
1132
  /**
1133
- * @public
1134
1133
  * <p>The user-defined name that identifies the assessment target that you want to create.
1135
1134
  * The name must be unique within the AWS account.</p>
1135
+ * @public
1136
1136
  */
1137
1137
  assessmentTargetName: string | undefined;
1138
1138
  /**
1139
- * @public
1140
1139
  * <p>The ARN that specifies the resource group that is used to create the assessment
1141
1140
  * target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account
1142
1141
  * and region are included in the assessment target.</p>
1142
+ * @public
1143
1143
  */
1144
1144
  resourceGroupArn?: string;
1145
1145
  }
@@ -1148,8 +1148,8 @@ export interface CreateAssessmentTargetRequest {
1148
1148
  */
1149
1149
  export interface CreateAssessmentTargetResponse {
1150
1150
  /**
1151
- * @public
1152
1151
  * <p>The ARN that specifies the assessment target that is created.</p>
1152
+ * @public
1153
1153
  */
1154
1154
  assessmentTargetArn: string | undefined;
1155
1155
  }
@@ -1166,21 +1166,21 @@ export declare const InvalidCrossAccountRoleErrorCode: {
1166
1166
  */
1167
1167
  export type InvalidCrossAccountRoleErrorCode = (typeof InvalidCrossAccountRoleErrorCode)[keyof typeof InvalidCrossAccountRoleErrorCode];
1168
1168
  /**
1169
- * @public
1170
1169
  * <p>Amazon Inspector cannot assume the cross-account role that it needs to list your EC2
1171
1170
  * instances during the assessment run.</p>
1171
+ * @public
1172
1172
  */
1173
1173
  export declare class InvalidCrossAccountRoleException extends __BaseException {
1174
1174
  readonly name: "InvalidCrossAccountRoleException";
1175
1175
  readonly $fault: "client";
1176
1176
  /**
1177
- * @public
1178
1177
  * <p>Code that indicates the type of error that is generated.</p>
1178
+ * @public
1179
1179
  */
1180
1180
  errorCode: InvalidCrossAccountRoleErrorCode | undefined;
1181
1181
  /**
1182
- * @public
1183
1182
  * <p>You can immediately retry your request.</p>
1183
+ * @public
1184
1184
  */
1185
1185
  canRetry: boolean | undefined;
1186
1186
  /**
@@ -1204,21 +1204,21 @@ export declare const LimitExceededErrorCode: {
1204
1204
  */
1205
1205
  export type LimitExceededErrorCode = (typeof LimitExceededErrorCode)[keyof typeof LimitExceededErrorCode];
1206
1206
  /**
1207
- * @public
1208
1207
  * <p>The request was rejected because it attempted to create resources beyond the current
1209
1208
  * AWS account limits. The error code describes the limit exceeded.</p>
1209
+ * @public
1210
1210
  */
1211
1211
  export declare class LimitExceededException extends __BaseException {
1212
1212
  readonly name: "LimitExceededException";
1213
1213
  readonly $fault: "client";
1214
1214
  /**
1215
- * @public
1216
1215
  * <p>Code that indicates the type of error that is generated.</p>
1216
+ * @public
1217
1217
  */
1218
1218
  errorCode: LimitExceededErrorCode | undefined;
1219
1219
  /**
1220
- * @public
1221
1220
  * <p>You can immediately retry your request.</p>
1221
+ * @public
1222
1222
  */
1223
1223
  canRetry: boolean | undefined;
1224
1224
  /**
@@ -1231,36 +1231,36 @@ export declare class LimitExceededException extends __BaseException {
1231
1231
  */
1232
1232
  export interface CreateAssessmentTemplateRequest {
1233
1233
  /**
1234
- * @public
1235
1234
  * <p>The ARN that specifies the assessment target for which you want to create the
1236
1235
  * assessment template.</p>
1236
+ * @public
1237
1237
  */
1238
1238
  assessmentTargetArn: string | undefined;
1239
1239
  /**
1240
- * @public
1241
1240
  * <p>The user-defined name that identifies the assessment template that you want to
1242
1241
  * create. You can create several assessment templates for an assessment target. The names of
1243
1242
  * the assessment templates that correspond to a particular assessment target must be
1244
1243
  * unique.</p>
1244
+ * @public
1245
1245
  */
1246
1246
  assessmentTemplateName: string | undefined;
1247
1247
  /**
1248
- * @public
1249
1248
  * <p>The duration of the assessment run in seconds.</p>
1249
+ * @public
1250
1250
  */
1251
1251
  durationInSeconds: number | undefined;
1252
1252
  /**
1253
- * @public
1254
1253
  * <p>The ARNs that specify the rules packages that you want to attach to the assessment
1255
1254
  * template.</p>
1255
+ * @public
1256
1256
  */
1257
1257
  rulesPackageArns: string[] | undefined;
1258
1258
  /**
1259
- * @public
1260
1259
  * <p>The user-defined attributes that are assigned to every finding that is generated by
1261
1260
  * the assessment run that uses this assessment template. An attribute is a key and value pair
1262
1261
  * (an <a>Attribute</a> object). Within an assessment template, each key must be
1263
1262
  * unique.</p>
1263
+ * @public
1264
1264
  */
1265
1265
  userAttributesForFindings?: Attribute[];
1266
1266
  }
@@ -1269,8 +1269,8 @@ export interface CreateAssessmentTemplateRequest {
1269
1269
  */
1270
1270
  export interface CreateAssessmentTemplateResponse {
1271
1271
  /**
1272
- * @public
1273
1272
  * <p>The ARN that specifies the assessment template that is created.</p>
1273
+ * @public
1274
1274
  */
1275
1275
  assessmentTemplateArn: string | undefined;
1276
1276
  }
@@ -1279,9 +1279,9 @@ export interface CreateAssessmentTemplateResponse {
1279
1279
  */
1280
1280
  export interface CreateExclusionsPreviewRequest {
1281
1281
  /**
1282
- * @public
1283
1282
  * <p>The ARN that specifies the assessment template for which you want to create an
1284
1283
  * exclusions preview.</p>
1284
+ * @public
1285
1285
  */
1286
1286
  assessmentTemplateArn: string | undefined;
1287
1287
  }
@@ -1290,17 +1290,17 @@ export interface CreateExclusionsPreviewRequest {
1290
1290
  */
1291
1291
  export interface CreateExclusionsPreviewResponse {
1292
1292
  /**
1293
- * @public
1294
1293
  * <p>Specifies the unique identifier of the requested exclusions preview. You can use the
1295
1294
  * unique identifier to retrieve the exclusions preview when running the GetExclusionsPreview
1296
1295
  * API.</p>
1296
+ * @public
1297
1297
  */
1298
1298
  previewToken: string | undefined;
1299
1299
  }
1300
1300
  /**
1301
- * @public
1302
1301
  * <p>The request is rejected. The specified assessment template is currently generating an
1303
1302
  * exclusions preview.</p>
1303
+ * @public
1304
1304
  */
1305
1305
  export declare class PreviewGenerationInProgressException extends __BaseException {
1306
1306
  readonly name: "PreviewGenerationInProgressException";
@@ -1311,19 +1311,19 @@ export declare class PreviewGenerationInProgressException extends __BaseExceptio
1311
1311
  constructor(opts: __ExceptionOptionType<PreviewGenerationInProgressException, __BaseException>);
1312
1312
  }
1313
1313
  /**
1314
- * @public
1315
1314
  * <p>This data type is used as one of the elements of the <a>ResourceGroup</a>
1316
1315
  * data type.</p>
1316
+ * @public
1317
1317
  */
1318
1318
  export interface ResourceGroupTag {
1319
1319
  /**
1320
- * @public
1321
1320
  * <p>A tag key.</p>
1321
+ * @public
1322
1322
  */
1323
1323
  key: string | undefined;
1324
1324
  /**
1325
- * @public
1326
1325
  * <p>The value assigned to a tag key.</p>
1326
+ * @public
1327
1327
  */
1328
1328
  value?: string;
1329
1329
  }
@@ -1332,10 +1332,10 @@ export interface ResourceGroupTag {
1332
1332
  */
1333
1333
  export interface CreateResourceGroupRequest {
1334
1334
  /**
1335
- * @public
1336
1335
  * <p>A collection of keys and an array of possible values,
1337
1336
  * '[\{"key":"key1","values":["Value1","Value2"]\},\{"key":"Key2","values":["Value3"]\}]'.</p>
1338
1337
  * <p>For example,'[\{"key":"Name","values":["TestEC2Instance"]\}]'.</p>
1338
+ * @public
1339
1339
  */
1340
1340
  resourceGroupTags: ResourceGroupTag[] | undefined;
1341
1341
  }
@@ -1344,8 +1344,8 @@ export interface CreateResourceGroupRequest {
1344
1344
  */
1345
1345
  export interface CreateResourceGroupResponse {
1346
1346
  /**
1347
- * @public
1348
1347
  * <p>The ARN that specifies the resource group that is created.</p>
1348
+ * @public
1349
1349
  */
1350
1350
  resourceGroupArn: string | undefined;
1351
1351
  }
@@ -1354,8 +1354,8 @@ export interface CreateResourceGroupResponse {
1354
1354
  */
1355
1355
  export interface DeleteAssessmentRunRequest {
1356
1356
  /**
1357
- * @public
1358
1357
  * <p>The ARN that specifies the assessment run that you want to delete.</p>
1358
+ * @public
1359
1359
  */
1360
1360
  assessmentRunArn: string | undefined;
1361
1361
  }
@@ -1364,8 +1364,8 @@ export interface DeleteAssessmentRunRequest {
1364
1364
  */
1365
1365
  export interface DeleteAssessmentTargetRequest {
1366
1366
  /**
1367
- * @public
1368
1367
  * <p>The ARN that specifies the assessment target that you want to delete.</p>
1368
+ * @public
1369
1369
  */
1370
1370
  assessmentTargetArn: string | undefined;
1371
1371
  }
@@ -1374,8 +1374,8 @@ export interface DeleteAssessmentTargetRequest {
1374
1374
  */
1375
1375
  export interface DeleteAssessmentTemplateRequest {
1376
1376
  /**
1377
- * @public
1378
1377
  * <p>The ARN that specifies the assessment template that you want to delete.</p>
1378
+ * @public
1379
1379
  */
1380
1380
  assessmentTemplateArn: string | undefined;
1381
1381
  }
@@ -1384,8 +1384,8 @@ export interface DeleteAssessmentTemplateRequest {
1384
1384
  */
1385
1385
  export interface DescribeAssessmentRunsRequest {
1386
1386
  /**
1387
- * @public
1388
1387
  * <p>The ARN that specifies the assessment run that you want to describe.</p>
1388
+ * @public
1389
1389
  */
1390
1390
  assessmentRunArns: string[] | undefined;
1391
1391
  }
@@ -1394,14 +1394,14 @@ export interface DescribeAssessmentRunsRequest {
1394
1394
  */
1395
1395
  export interface DescribeAssessmentRunsResponse {
1396
1396
  /**
1397
- * @public
1398
1397
  * <p>Information about the assessment run.</p>
1398
+ * @public
1399
1399
  */
1400
1400
  assessmentRuns: AssessmentRun[] | undefined;
1401
1401
  /**
1402
- * @public
1403
1402
  * <p>Assessment run details that cannot be described. An error code is provided for each
1404
1403
  * failed item.</p>
1404
+ * @public
1405
1405
  */
1406
1406
  failedItems: Record<string, FailedItemDetails> | undefined;
1407
1407
  }
@@ -1410,8 +1410,8 @@ export interface DescribeAssessmentRunsResponse {
1410
1410
  */
1411
1411
  export interface DescribeAssessmentTargetsRequest {
1412
1412
  /**
1413
- * @public
1414
1413
  * <p>The ARNs that specifies the assessment targets that you want to describe.</p>
1414
+ * @public
1415
1415
  */
1416
1416
  assessmentTargetArns: string[] | undefined;
1417
1417
  }
@@ -1420,14 +1420,14 @@ export interface DescribeAssessmentTargetsRequest {
1420
1420
  */
1421
1421
  export interface DescribeAssessmentTargetsResponse {
1422
1422
  /**
1423
- * @public
1424
1423
  * <p>Information about the assessment targets.</p>
1424
+ * @public
1425
1425
  */
1426
1426
  assessmentTargets: AssessmentTarget[] | undefined;
1427
1427
  /**
1428
- * @public
1429
1428
  * <p>Assessment target details that cannot be described. An error code is provided for
1430
1429
  * each failed item.</p>
1430
+ * @public
1431
1431
  */
1432
1432
  failedItems: Record<string, FailedItemDetails> | undefined;
1433
1433
  }
@@ -1442,14 +1442,14 @@ export interface DescribeAssessmentTemplatesRequest {
1442
1442
  */
1443
1443
  export interface DescribeAssessmentTemplatesResponse {
1444
1444
  /**
1445
- * @public
1446
1445
  * <p>Information about the assessment templates.</p>
1446
+ * @public
1447
1447
  */
1448
1448
  assessmentTemplates: AssessmentTemplate[] | undefined;
1449
1449
  /**
1450
- * @public
1451
1450
  * <p>Assessment template details that cannot be described. An error code is provided for
1452
1451
  * each failed item.</p>
1452
+ * @public
1453
1453
  */
1454
1454
  failedItems: Record<string, FailedItemDetails> | undefined;
1455
1455
  }
@@ -1458,20 +1458,20 @@ export interface DescribeAssessmentTemplatesResponse {
1458
1458
  */
1459
1459
  export interface DescribeCrossAccountAccessRoleResponse {
1460
1460
  /**
1461
- * @public
1462
1461
  * <p>The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS
1463
1462
  * account.</p>
1463
+ * @public
1464
1464
  */
1465
1465
  roleArn: string | undefined;
1466
1466
  /**
1467
- * @public
1468
1467
  * <p>A Boolean value that specifies whether the IAM role has the necessary policies
1469
1468
  * attached to enable Amazon Inspector to access your AWS account.</p>
1469
+ * @public
1470
1470
  */
1471
1471
  valid: boolean | undefined;
1472
1472
  /**
1473
- * @public
1474
1473
  * <p>The date when the cross-account access role was registered.</p>
1474
+ * @public
1475
1475
  */
1476
1476
  registeredAt: Date | undefined;
1477
1477
  }
@@ -1491,14 +1491,14 @@ export type Locale = (typeof Locale)[keyof typeof Locale];
1491
1491
  */
1492
1492
  export interface DescribeExclusionsRequest {
1493
1493
  /**
1494
- * @public
1495
1494
  * <p>The list of ARNs that specify the exclusions that you want to describe.</p>
1495
+ * @public
1496
1496
  */
1497
1497
  exclusionArns: string[] | undefined;
1498
1498
  /**
1499
- * @public
1500
1499
  * <p>The locale into which you want to translate the exclusion's title, description, and
1501
1500
  * recommendation.</p>
1501
+ * @public
1502
1502
  */
1503
1503
  locale?: Locale;
1504
1504
  }
@@ -1515,55 +1515,55 @@ export declare const ScopeType: {
1515
1515
  */
1516
1516
  export type ScopeType = (typeof ScopeType)[keyof typeof ScopeType];
1517
1517
  /**
1518
- * @public
1519
1518
  * <p>This data type contains key-value pairs that identify various Amazon
1520
1519
  * resources.</p>
1520
+ * @public
1521
1521
  */
1522
1522
  export interface Scope {
1523
1523
  /**
1524
- * @public
1525
1524
  * <p>The type of the scope.</p>
1525
+ * @public
1526
1526
  */
1527
1527
  key?: ScopeType;
1528
1528
  /**
1529
- * @public
1530
1529
  * <p>The resource identifier for the specified scope type.</p>
1530
+ * @public
1531
1531
  */
1532
1532
  value?: string;
1533
1533
  }
1534
1534
  /**
1535
- * @public
1536
1535
  * <p>Contains information about what was excluded from an assessment run.</p>
1536
+ * @public
1537
1537
  */
1538
1538
  export interface Exclusion {
1539
1539
  /**
1540
- * @public
1541
1540
  * <p>The ARN that specifies the exclusion.</p>
1541
+ * @public
1542
1542
  */
1543
1543
  arn: string | undefined;
1544
1544
  /**
1545
- * @public
1546
1545
  * <p>The name of the exclusion.</p>
1546
+ * @public
1547
1547
  */
1548
1548
  title: string | undefined;
1549
1549
  /**
1550
- * @public
1551
1550
  * <p>The description of the exclusion.</p>
1551
+ * @public
1552
1552
  */
1553
1553
  description: string | undefined;
1554
1554
  /**
1555
- * @public
1556
1555
  * <p>The recommendation for the exclusion.</p>
1556
+ * @public
1557
1557
  */
1558
1558
  recommendation: string | undefined;
1559
1559
  /**
1560
- * @public
1561
1560
  * <p>The AWS resources for which the exclusion pertains.</p>
1561
+ * @public
1562
1562
  */
1563
1563
  scopes: Scope[] | undefined;
1564
1564
  /**
1565
- * @public
1566
1565
  * <p>The system-defined attributes for the exclusion.</p>
1566
+ * @public
1567
1567
  */
1568
1568
  attributes?: Attribute[];
1569
1569
  }
@@ -1572,14 +1572,14 @@ export interface Exclusion {
1572
1572
  */
1573
1573
  export interface DescribeExclusionsResponse {
1574
1574
  /**
1575
- * @public
1576
1575
  * <p>Information about the exclusions.</p>
1576
+ * @public
1577
1577
  */
1578
1578
  exclusions: Record<string, Exclusion> | undefined;
1579
1579
  /**
1580
- * @public
1581
1580
  * <p>Exclusion details that cannot be described. An error code is provided for each failed
1582
1581
  * item.</p>
1582
+ * @public
1583
1583
  */
1584
1584
  failedItems: Record<string, FailedItemDetails> | undefined;
1585
1585
  }
@@ -1588,133 +1588,133 @@ export interface DescribeExclusionsResponse {
1588
1588
  */
1589
1589
  export interface DescribeFindingsRequest {
1590
1590
  /**
1591
- * @public
1592
1591
  * <p>The ARN that specifies the finding that you want to describe.</p>
1592
+ * @public
1593
1593
  */
1594
1594
  findingArns: string[] | undefined;
1595
1595
  /**
1596
- * @public
1597
1596
  * <p>The locale into which you want to translate a finding description, recommendation,
1598
1597
  * and the short description that identifies the finding.</p>
1598
+ * @public
1599
1599
  */
1600
1600
  locale?: Locale;
1601
1601
  }
1602
1602
  /**
1603
- * @public
1604
1603
  * <p>This data type is used in the <a>Finding</a> data type.</p>
1604
+ * @public
1605
1605
  */
1606
1606
  export interface InspectorServiceAttributes {
1607
1607
  /**
1608
- * @public
1609
1608
  * <p>The schema version of this data type.</p>
1609
+ * @public
1610
1610
  */
1611
1611
  schemaVersion: number | undefined;
1612
1612
  /**
1613
- * @public
1614
1613
  * <p>The ARN of the assessment run during which the finding is generated.</p>
1614
+ * @public
1615
1615
  */
1616
1616
  assessmentRunArn?: string;
1617
1617
  /**
1618
- * @public
1619
1618
  * <p>The ARN of the rules package that is used to generate the finding.</p>
1619
+ * @public
1620
1620
  */
1621
1621
  rulesPackageArn?: string;
1622
1622
  }
1623
1623
  /**
1624
- * @public
1625
1624
  * <p>Contains information about an Amazon Inspector finding. This data type is used as the
1626
1625
  * response element in the <a>DescribeFindings</a> action.</p>
1626
+ * @public
1627
1627
  */
1628
1628
  export interface Finding {
1629
1629
  /**
1630
- * @public
1631
1630
  * <p>The ARN that specifies the finding.</p>
1631
+ * @public
1632
1632
  */
1633
1633
  arn: string | undefined;
1634
1634
  /**
1635
- * @public
1636
1635
  * <p>The schema version of this data type.</p>
1636
+ * @public
1637
1637
  */
1638
1638
  schemaVersion?: number;
1639
1639
  /**
1640
- * @public
1641
1640
  * <p>The data element is set to "Inspector".</p>
1641
+ * @public
1642
1642
  */
1643
1643
  service?: string;
1644
1644
  /**
1645
- * @public
1646
1645
  * <p>This data type is used in the <a>Finding</a> data type.</p>
1646
+ * @public
1647
1647
  */
1648
1648
  serviceAttributes?: InspectorServiceAttributes;
1649
1649
  /**
1650
- * @public
1651
1650
  * <p>The type of the host from which the finding is generated.</p>
1651
+ * @public
1652
1652
  */
1653
1653
  assetType?: AssetType;
1654
1654
  /**
1655
- * @public
1656
1655
  * <p>A collection of attributes of the host from which the finding is generated.</p>
1656
+ * @public
1657
1657
  */
1658
1658
  assetAttributes?: AssetAttributes;
1659
1659
  /**
1660
- * @public
1661
1660
  * <p>The ID of the finding.</p>
1661
+ * @public
1662
1662
  */
1663
1663
  id?: string;
1664
1664
  /**
1665
- * @public
1666
1665
  * <p>The name of the finding.</p>
1666
+ * @public
1667
1667
  */
1668
1668
  title?: string;
1669
1669
  /**
1670
- * @public
1671
1670
  * <p>The description of the finding.</p>
1671
+ * @public
1672
1672
  */
1673
1673
  description?: string;
1674
1674
  /**
1675
- * @public
1676
1675
  * <p>The recommendation for the finding.</p>
1676
+ * @public
1677
1677
  */
1678
1678
  recommendation?: string;
1679
1679
  /**
1680
- * @public
1681
1680
  * <p>The finding severity. Values can be set to High, Medium, Low, and
1682
1681
  * Informational.</p>
1682
+ * @public
1683
1683
  */
1684
1684
  severity?: Severity;
1685
1685
  /**
1686
- * @public
1687
1686
  * <p>The numeric value of the finding severity.</p>
1687
+ * @public
1688
1688
  */
1689
1689
  numericSeverity?: number;
1690
1690
  /**
1691
- * @public
1692
1691
  * <p>This data element is currently not used.</p>
1692
+ * @public
1693
1693
  */
1694
1694
  confidence?: number;
1695
1695
  /**
1696
- * @public
1697
1696
  * <p>This data element is currently not used.</p>
1697
+ * @public
1698
1698
  */
1699
1699
  indicatorOfCompromise?: boolean;
1700
1700
  /**
1701
- * @public
1702
1701
  * <p>The system-defined attributes for the finding.</p>
1702
+ * @public
1703
1703
  */
1704
1704
  attributes: Attribute[] | undefined;
1705
1705
  /**
1706
- * @public
1707
1706
  * <p>The user-defined attributes that are assigned to the finding.</p>
1707
+ * @public
1708
1708
  */
1709
1709
  userAttributes: Attribute[] | undefined;
1710
1710
  /**
1711
- * @public
1712
1711
  * <p>The time when the finding was generated.</p>
1712
+ * @public
1713
1713
  */
1714
1714
  createdAt: Date | undefined;
1715
1715
  /**
1716
- * @public
1717
1716
  * <p>The time when <a>AddAttributesToFindings</a> is called.</p>
1717
+ * @public
1718
1718
  */
1719
1719
  updatedAt: Date | undefined;
1720
1720
  }
@@ -1723,14 +1723,14 @@ export interface Finding {
1723
1723
  */
1724
1724
  export interface DescribeFindingsResponse {
1725
1725
  /**
1726
- * @public
1727
1726
  * <p>Information about the finding.</p>
1727
+ * @public
1728
1728
  */
1729
1729
  findings: Finding[] | undefined;
1730
1730
  /**
1731
- * @public
1732
1731
  * <p>Finding details that cannot be described. An error code is provided for each failed
1733
1732
  * item.</p>
1733
+ * @public
1734
1734
  */
1735
1735
  failedItems: Record<string, FailedItemDetails> | undefined;
1736
1736
  }
@@ -1739,33 +1739,33 @@ export interface DescribeFindingsResponse {
1739
1739
  */
1740
1740
  export interface DescribeResourceGroupsRequest {
1741
1741
  /**
1742
- * @public
1743
1742
  * <p>The ARN that specifies the resource group that you want to describe.</p>
1743
+ * @public
1744
1744
  */
1745
1745
  resourceGroupArns: string[] | undefined;
1746
1746
  }
1747
1747
  /**
1748
- * @public
1749
1748
  * <p>Contains information about a resource group. The resource group defines a set of tags
1750
1749
  * that, when queried, identify the AWS resources that make up the assessment target. This
1751
1750
  * data type is used as the response element in the <a>DescribeResourceGroups</a>
1752
1751
  * action.</p>
1752
+ * @public
1753
1753
  */
1754
1754
  export interface ResourceGroup {
1755
1755
  /**
1756
- * @public
1757
1756
  * <p>The ARN of the resource group.</p>
1757
+ * @public
1758
1758
  */
1759
1759
  arn: string | undefined;
1760
1760
  /**
1761
- * @public
1762
1761
  * <p>The tags (key and value pairs) of the resource group. This data type property is used
1763
1762
  * in the <a>CreateResourceGroup</a> action.</p>
1763
+ * @public
1764
1764
  */
1765
1765
  tags: ResourceGroupTag[] | undefined;
1766
1766
  /**
1767
- * @public
1768
1767
  * <p>The time at which resource group is created.</p>
1768
+ * @public
1769
1769
  */
1770
1770
  createdAt: Date | undefined;
1771
1771
  }
@@ -1774,14 +1774,14 @@ export interface ResourceGroup {
1774
1774
  */
1775
1775
  export interface DescribeResourceGroupsResponse {
1776
1776
  /**
1777
- * @public
1778
1777
  * <p>Information about a resource group.</p>
1778
+ * @public
1779
1779
  */
1780
1780
  resourceGroups: ResourceGroup[] | undefined;
1781
1781
  /**
1782
- * @public
1783
1782
  * <p>Resource group details that cannot be described. An error code is provided for each
1784
1783
  * failed item.</p>
1784
+ * @public
1785
1785
  */
1786
1786
  failedItems: Record<string, FailedItemDetails> | undefined;
1787
1787
  }
@@ -1790,45 +1790,45 @@ export interface DescribeResourceGroupsResponse {
1790
1790
  */
1791
1791
  export interface DescribeRulesPackagesRequest {
1792
1792
  /**
1793
- * @public
1794
1793
  * <p>The ARN that specifies the rules package that you want to describe.</p>
1794
+ * @public
1795
1795
  */
1796
1796
  rulesPackageArns: string[] | undefined;
1797
1797
  /**
1798
- * @public
1799
1798
  * <p>The locale that you want to translate a rules package description into.</p>
1799
+ * @public
1800
1800
  */
1801
1801
  locale?: Locale;
1802
1802
  }
1803
1803
  /**
1804
- * @public
1805
1804
  * <p>Contains information about an Amazon Inspector rules package. This data type is used
1806
1805
  * as the response element in the <a>DescribeRulesPackages</a> action.</p>
1806
+ * @public
1807
1807
  */
1808
1808
  export interface RulesPackage {
1809
1809
  /**
1810
- * @public
1811
1810
  * <p>The ARN of the rules package.</p>
1811
+ * @public
1812
1812
  */
1813
1813
  arn: string | undefined;
1814
1814
  /**
1815
- * @public
1816
1815
  * <p>The name of the rules package.</p>
1816
+ * @public
1817
1817
  */
1818
1818
  name: string | undefined;
1819
1819
  /**
1820
- * @public
1821
1820
  * <p>The version ID of the rules package.</p>
1821
+ * @public
1822
1822
  */
1823
1823
  version: string | undefined;
1824
1824
  /**
1825
- * @public
1826
1825
  * <p>The provider of the rules package.</p>
1826
+ * @public
1827
1827
  */
1828
1828
  provider: string | undefined;
1829
1829
  /**
1830
- * @public
1831
1830
  * <p>The description of the rules package.</p>
1831
+ * @public
1832
1832
  */
1833
1833
  description?: string;
1834
1834
  }
@@ -1837,120 +1837,120 @@ export interface RulesPackage {
1837
1837
  */
1838
1838
  export interface DescribeRulesPackagesResponse {
1839
1839
  /**
1840
- * @public
1841
1840
  * <p>Information about the rules package.</p>
1841
+ * @public
1842
1842
  */
1843
1843
  rulesPackages: RulesPackage[] | undefined;
1844
1844
  /**
1845
- * @public
1846
1845
  * <p>Rules package details that cannot be described. An error code is provided for each
1847
1846
  * failed item.</p>
1847
+ * @public
1848
1848
  */
1849
1849
  failedItems: Record<string, FailedItemDetails> | undefined;
1850
1850
  }
1851
1851
  /**
1852
- * @public
1853
1852
  * <p>This data type is used in the <a>Subscription</a> data type.</p>
1853
+ * @public
1854
1854
  */
1855
1855
  export interface EventSubscription {
1856
1856
  /**
1857
- * @public
1858
1857
  * <p>The event for which Amazon Simple Notification Service (SNS) notifications are
1859
1858
  * sent.</p>
1859
+ * @public
1860
1860
  */
1861
1861
  event: InspectorEvent | undefined;
1862
1862
  /**
1863
- * @public
1864
1863
  * <p>The time at which <a>SubscribeToEvent</a> is called.</p>
1864
+ * @public
1865
1865
  */
1866
1866
  subscribedAt: Date | undefined;
1867
1867
  }
1868
1868
  /**
1869
- * @public
1870
1869
  * <p>Contains information about what is excluded from an assessment run given the current
1871
1870
  * state of the assessment template.</p>
1871
+ * @public
1872
1872
  */
1873
1873
  export interface ExclusionPreview {
1874
1874
  /**
1875
- * @public
1876
1875
  * <p>The name of the exclusion preview.</p>
1876
+ * @public
1877
1877
  */
1878
1878
  title: string | undefined;
1879
1879
  /**
1880
- * @public
1881
1880
  * <p>The description of the exclusion preview.</p>
1881
+ * @public
1882
1882
  */
1883
1883
  description: string | undefined;
1884
1884
  /**
1885
- * @public
1886
1885
  * <p>The recommendation for the exclusion preview.</p>
1886
+ * @public
1887
1887
  */
1888
1888
  recommendation: string | undefined;
1889
1889
  /**
1890
- * @public
1891
1890
  * <p>The AWS resources for which the exclusion preview pertains.</p>
1891
+ * @public
1892
1892
  */
1893
1893
  scopes: Scope[] | undefined;
1894
1894
  /**
1895
- * @public
1896
1895
  * <p>The system-defined attributes for the exclusion preview.</p>
1896
+ * @public
1897
1897
  */
1898
1898
  attributes?: Attribute[];
1899
1899
  }
1900
1900
  /**
1901
- * @public
1902
1901
  * <p>This data type is used as a request parameter in the <a>ListFindings</a>
1903
1902
  * action.</p>
1903
+ * @public
1904
1904
  */
1905
1905
  export interface FindingFilter {
1906
1906
  /**
1907
- * @public
1908
1907
  * <p>For a record to match a filter, one of the values that is specified for this data
1909
1908
  * type property must be the exact match of the value of the <b>agentId</b> property of the <a>Finding</a> data type.</p>
1909
+ * @public
1910
1910
  */
1911
1911
  agentIds?: string[];
1912
1912
  /**
1913
- * @public
1914
1913
  * <p>For a record to match a filter, one of the values that is specified for this data
1915
1914
  * type property must be the exact match of the value of the <b>autoScalingGroup</b> property of the <a>Finding</a> data
1916
1915
  * type.</p>
1916
+ * @public
1917
1917
  */
1918
1918
  autoScalingGroups?: string[];
1919
1919
  /**
1920
- * @public
1921
1920
  * <p>For a record to match a filter, one of the values that is specified for this data
1922
1921
  * type property must be the exact match of the value of the <b>ruleName</b> property of the <a>Finding</a> data type.</p>
1922
+ * @public
1923
1923
  */
1924
1924
  ruleNames?: string[];
1925
1925
  /**
1926
- * @public
1927
1926
  * <p>For a record to match a filter, one of the values that is specified for this data
1928
1927
  * type property must be the exact match of the value of the <b>severity</b> property of the <a>Finding</a> data type.</p>
1928
+ * @public
1929
1929
  */
1930
1930
  severities?: Severity[];
1931
1931
  /**
1932
- * @public
1933
1932
  * <p>For a record to match a filter, one of the values that is specified for this data
1934
1933
  * type property must be the exact match of the value of the <b>rulesPackageArn</b> property of the <a>Finding</a> data
1935
1934
  * type.</p>
1935
+ * @public
1936
1936
  */
1937
1937
  rulesPackageArns?: string[];
1938
1938
  /**
1939
- * @public
1940
1939
  * <p>For a record to match a filter, the list of values that are specified for this data
1941
1940
  * type property must be contained in the list of values of the <b>attributes</b> property of the <a>Finding</a> data type.</p>
1941
+ * @public
1942
1942
  */
1943
1943
  attributes?: Attribute[];
1944
1944
  /**
1945
- * @public
1946
1945
  * <p>For a record to match a filter, the value that is specified for this data type
1947
1946
  * property must be contained in the list of values of the <b>userAttributes</b> property of the <a>Finding</a> data
1948
1947
  * type.</p>
1948
+ * @public
1949
1949
  */
1950
1950
  userAttributes?: Attribute[];
1951
1951
  /**
1952
- * @public
1953
1952
  * <p>The time range during which the finding is generated.</p>
1953
+ * @public
1954
1954
  */
1955
1955
  creationTimeRange?: TimestampRange;
1956
1956
  }
@@ -1983,22 +1983,22 @@ export type ReportType = (typeof ReportType)[keyof typeof ReportType];
1983
1983
  */
1984
1984
  export interface GetAssessmentReportRequest {
1985
1985
  /**
1986
- * @public
1987
1986
  * <p>The ARN that specifies the assessment run for which you want to generate a
1988
1987
  * report.</p>
1988
+ * @public
1989
1989
  */
1990
1990
  assessmentRunArn: string | undefined;
1991
1991
  /**
1992
- * @public
1993
1992
  * <p>Specifies the file format (html or pdf) of the assessment report that you want to
1994
1993
  * generate.</p>
1994
+ * @public
1995
1995
  */
1996
1996
  reportFileFormat: ReportFileFormat | undefined;
1997
1997
  /**
1998
- * @public
1999
1998
  * <p>Specifies the type of the assessment report that you want to generate. There are two
2000
1999
  * types of assessment reports: a finding report and a full report. For more information, see
2001
2000
  * <a href="https://docs.aws.amazon.com/inspector/latest/userguide/inspector_reports.html">Assessment Reports</a>. </p>
2001
+ * @public
2002
2002
  */
2003
2003
  reportType: ReportType | undefined;
2004
2004
  }
@@ -2020,24 +2020,24 @@ export type ReportStatus = (typeof ReportStatus)[keyof typeof ReportStatus];
2020
2020
  */
2021
2021
  export interface GetAssessmentReportResponse {
2022
2022
  /**
2023
- * @public
2024
2023
  * <p>Specifies the status of the request to generate an assessment report. </p>
2024
+ * @public
2025
2025
  */
2026
2026
  status: ReportStatus | undefined;
2027
2027
  /**
2028
- * @public
2029
2028
  * <p>Specifies the URL where you can find the generated assessment report. This parameter
2030
2029
  * is only returned if the report is successfully generated.</p>
2030
+ * @public
2031
2031
  */
2032
2032
  url?: string;
2033
2033
  }
2034
2034
  /**
2035
- * @public
2036
2035
  * <p>Used by the <a>GetAssessmentReport</a> API. The request was rejected
2037
2036
  * because you tried to generate a report for an assessment run that existed before reporting
2038
2037
  * was supported in Amazon Inspector. You can only generate reports for assessment runs that
2039
2038
  * took place or will take place after generating reports in Amazon Inspector became
2040
2039
  * available.</p>
2040
+ * @public
2041
2041
  */
2042
2042
  export declare class UnsupportedFeatureException extends __BaseException {
2043
2043
  readonly name: "UnsupportedFeatureException";
@@ -2053,34 +2053,34 @@ export declare class UnsupportedFeatureException extends __BaseException {
2053
2053
  */
2054
2054
  export interface GetExclusionsPreviewRequest {
2055
2055
  /**
2056
- * @public
2057
2056
  * <p>The ARN that specifies the assessment template for which the exclusions preview was
2058
2057
  * requested.</p>
2058
+ * @public
2059
2059
  */
2060
2060
  assessmentTemplateArn: string | undefined;
2061
2061
  /**
2062
- * @public
2063
2062
  * <p>The unique identifier associated of the exclusions preview.</p>
2063
+ * @public
2064
2064
  */
2065
2065
  previewToken: string | undefined;
2066
2066
  /**
2067
- * @public
2068
2067
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2069
2068
  * to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to
2070
2069
  * the action fill nextToken in the request with the value of nextToken from the previous
2071
2070
  * response to continue listing data.</p>
2071
+ * @public
2072
2072
  */
2073
2073
  nextToken?: string;
2074
2074
  /**
2075
- * @public
2076
2075
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2077
2076
  * response. The default value is 100. The maximum value is 500.</p>
2077
+ * @public
2078
2078
  */
2079
2079
  maxResults?: number;
2080
2080
  /**
2081
- * @public
2082
2081
  * <p>The locale into which you want to translate the exclusion's title, description, and
2083
2082
  * recommendation.</p>
2083
+ * @public
2084
2084
  */
2085
2085
  locale?: Locale;
2086
2086
  }
@@ -2101,21 +2101,21 @@ export type PreviewStatus = (typeof PreviewStatus)[keyof typeof PreviewStatus];
2101
2101
  */
2102
2102
  export interface GetExclusionsPreviewResponse {
2103
2103
  /**
2104
- * @public
2105
2104
  * <p>Specifies the status of the request to generate an exclusions preview.</p>
2105
+ * @public
2106
2106
  */
2107
2107
  previewStatus: PreviewStatus | undefined;
2108
2108
  /**
2109
- * @public
2110
2109
  * <p>Information about the exclusions included in the preview.</p>
2110
+ * @public
2111
2111
  */
2112
2112
  exclusionPreviews?: ExclusionPreview[];
2113
2113
  /**
2114
- * @public
2115
2114
  * <p>When a response is generated, if there is more data to be listed, this parameters is
2116
2115
  * present in the response and contains the value to use for the nextToken parameter in a
2117
2116
  * subsequent pagination request. If there is no more data to be listed, this parameter is set
2118
2117
  * to null.</p>
2118
+ * @public
2119
2119
  */
2120
2120
  nextToken?: string;
2121
2121
  }
@@ -2124,9 +2124,9 @@ export interface GetExclusionsPreviewResponse {
2124
2124
  */
2125
2125
  export interface GetTelemetryMetadataRequest {
2126
2126
  /**
2127
- * @public
2128
2127
  * <p>The ARN that specifies the assessment run that has the telemetry data that you want
2129
2128
  * to obtain.</p>
2129
+ * @public
2130
2130
  */
2131
2131
  assessmentRunArn: string | undefined;
2132
2132
  }
@@ -2135,8 +2135,8 @@ export interface GetTelemetryMetadataRequest {
2135
2135
  */
2136
2136
  export interface GetTelemetryMetadataResponse {
2137
2137
  /**
2138
- * @public
2139
2138
  * <p>Telemetry details.</p>
2139
+ * @public
2140
2140
  */
2141
2141
  telemetryMetadata: TelemetryMetadata[] | undefined;
2142
2142
  }
@@ -2145,32 +2145,32 @@ export interface GetTelemetryMetadataResponse {
2145
2145
  */
2146
2146
  export interface ListAssessmentRunAgentsRequest {
2147
2147
  /**
2148
- * @public
2149
2148
  * <p>The ARN that specifies the assessment run whose agents you want to list.</p>
2149
+ * @public
2150
2150
  */
2151
2151
  assessmentRunArn: string | undefined;
2152
2152
  /**
2153
- * @public
2154
2153
  * <p>You can use this parameter to specify a subset of data to be included in the action's
2155
2154
  * response.</p>
2156
2155
  * <p>For a record to match a filter, all specified filter attributes must match. When
2157
2156
  * multiple values are specified for a filter attribute, any of the values can
2158
2157
  * match.</p>
2158
+ * @public
2159
2159
  */
2160
2160
  filter?: AgentFilter;
2161
2161
  /**
2162
- * @public
2163
2162
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2164
2163
  * to null on your first call to the <b>ListAssessmentRunAgents</b>
2165
2164
  * action. Subsequent calls to the action fill <b>nextToken</b> in
2166
2165
  * the request with the value of <b>NextToken</b> from the previous
2167
2166
  * response to continue listing data.</p>
2167
+ * @public
2168
2168
  */
2169
2169
  nextToken?: string;
2170
2170
  /**
2171
- * @public
2172
2171
  * <p>You can use this parameter to indicate the maximum number of items that you want in
2173
2172
  * the response. The default value is 10. The maximum value is 500.</p>
2173
+ * @public
2174
2174
  */
2175
2175
  maxResults?: number;
2176
2176
  }
@@ -2179,15 +2179,15 @@ export interface ListAssessmentRunAgentsRequest {
2179
2179
  */
2180
2180
  export interface ListAssessmentRunAgentsResponse {
2181
2181
  /**
2182
- * @public
2183
2182
  * <p>A list of ARNs that specifies the agents returned by the action.</p>
2183
+ * @public
2184
2184
  */
2185
2185
  assessmentRunAgents: AssessmentRunAgent[] | undefined;
2186
2186
  /**
2187
- * @public
2188
2187
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2189
2188
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2190
2189
  * data to be listed, this parameter is set to null.</p>
2190
+ * @public
2191
2191
  */
2192
2192
  nextToken?: string;
2193
2193
  }
@@ -2196,33 +2196,33 @@ export interface ListAssessmentRunAgentsResponse {
2196
2196
  */
2197
2197
  export interface ListAssessmentRunsRequest {
2198
2198
  /**
2199
- * @public
2200
2199
  * <p>The ARNs that specify the assessment templates whose assessment runs you want to
2201
2200
  * list.</p>
2201
+ * @public
2202
2202
  */
2203
2203
  assessmentTemplateArns?: string[];
2204
2204
  /**
2205
- * @public
2206
2205
  * <p>You can use this parameter to specify a subset of data to be included in the action's
2207
2206
  * response.</p>
2208
2207
  * <p>For a record to match a filter, all specified filter attributes must match. When
2209
2208
  * multiple values are specified for a filter attribute, any of the values can
2210
2209
  * match.</p>
2210
+ * @public
2211
2211
  */
2212
2212
  filter?: AssessmentRunFilter;
2213
2213
  /**
2214
- * @public
2215
2214
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2216
2215
  * to null on your first call to the <b>ListAssessmentRuns</b>
2217
2216
  * action. Subsequent calls to the action fill <b>nextToken</b> in
2218
2217
  * the request with the value of <b>NextToken</b> from the previous
2219
2218
  * response to continue listing data.</p>
2219
+ * @public
2220
2220
  */
2221
2221
  nextToken?: string;
2222
2222
  /**
2223
- * @public
2224
2223
  * <p>You can use this parameter to indicate the maximum number of items that you want in
2225
2224
  * the response. The default value is 10. The maximum value is 500.</p>
2225
+ * @public
2226
2226
  */
2227
2227
  maxResults?: number;
2228
2228
  }
@@ -2231,16 +2231,16 @@ export interface ListAssessmentRunsRequest {
2231
2231
  */
2232
2232
  export interface ListAssessmentRunsResponse {
2233
2233
  /**
2234
- * @public
2235
2234
  * <p>A list of ARNs that specifies the assessment runs that are returned by the
2236
2235
  * action.</p>
2236
+ * @public
2237
2237
  */
2238
2238
  assessmentRunArns: string[] | undefined;
2239
2239
  /**
2240
- * @public
2241
2240
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2242
2241
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2243
2242
  * data to be listed, this parameter is set to null.</p>
2243
+ * @public
2244
2244
  */
2245
2245
  nextToken?: string;
2246
2246
  }
@@ -2249,27 +2249,27 @@ export interface ListAssessmentRunsResponse {
2249
2249
  */
2250
2250
  export interface ListAssessmentTargetsRequest {
2251
2251
  /**
2252
- * @public
2253
2252
  * <p>You can use this parameter to specify a subset of data to be included in the action's
2254
2253
  * response.</p>
2255
2254
  * <p>For a record to match a filter, all specified filter attributes must match. When
2256
2255
  * multiple values are specified for a filter attribute, any of the values can
2257
2256
  * match.</p>
2257
+ * @public
2258
2258
  */
2259
2259
  filter?: AssessmentTargetFilter;
2260
2260
  /**
2261
- * @public
2262
2261
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2263
2262
  * to null on your first call to the <b>ListAssessmentTargets</b>
2264
2263
  * action. Subsequent calls to the action fill <b>nextToken</b> in
2265
2264
  * the request with the value of <b>NextToken</b> from the previous
2266
2265
  * response to continue listing data.</p>
2266
+ * @public
2267
2267
  */
2268
2268
  nextToken?: string;
2269
2269
  /**
2270
- * @public
2271
2270
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2272
2271
  * response. The default value is 10. The maximum value is 500.</p>
2272
+ * @public
2273
2273
  */
2274
2274
  maxResults?: number;
2275
2275
  }
@@ -2278,16 +2278,16 @@ export interface ListAssessmentTargetsRequest {
2278
2278
  */
2279
2279
  export interface ListAssessmentTargetsResponse {
2280
2280
  /**
2281
- * @public
2282
2281
  * <p>A list of ARNs that specifies the assessment targets that are returned by the
2283
2282
  * action.</p>
2283
+ * @public
2284
2284
  */
2285
2285
  assessmentTargetArns: string[] | undefined;
2286
2286
  /**
2287
- * @public
2288
2287
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2289
2288
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2290
2289
  * data to be listed, this parameter is set to null.</p>
2290
+ * @public
2291
2291
  */
2292
2292
  nextToken?: string;
2293
2293
  }
@@ -2296,33 +2296,33 @@ export interface ListAssessmentTargetsResponse {
2296
2296
  */
2297
2297
  export interface ListAssessmentTemplatesRequest {
2298
2298
  /**
2299
- * @public
2300
2299
  * <p>A list of ARNs that specifies the assessment targets whose assessment templates you
2301
2300
  * want to list.</p>
2301
+ * @public
2302
2302
  */
2303
2303
  assessmentTargetArns?: string[];
2304
2304
  /**
2305
- * @public
2306
2305
  * <p>You can use this parameter to specify a subset of data to be included in the action's
2307
2306
  * response.</p>
2308
2307
  * <p>For a record to match a filter, all specified filter attributes must match. When
2309
2308
  * multiple values are specified for a filter attribute, any of the values can
2310
2309
  * match.</p>
2310
+ * @public
2311
2311
  */
2312
2312
  filter?: AssessmentTemplateFilter;
2313
2313
  /**
2314
- * @public
2315
2314
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2316
2315
  * to null on your first call to the <b>ListAssessmentTemplates</b>
2317
2316
  * action. Subsequent calls to the action fill <b>nextToken</b> in
2318
2317
  * the request with the value of <b>NextToken</b> from the previous
2319
2318
  * response to continue listing data.</p>
2319
+ * @public
2320
2320
  */
2321
2321
  nextToken?: string;
2322
2322
  /**
2323
- * @public
2324
2323
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2325
2324
  * response. The default value is 10. The maximum value is 500.</p>
2325
+ * @public
2326
2326
  */
2327
2327
  maxResults?: number;
2328
2328
  }
@@ -2331,16 +2331,16 @@ export interface ListAssessmentTemplatesRequest {
2331
2331
  */
2332
2332
  export interface ListAssessmentTemplatesResponse {
2333
2333
  /**
2334
- * @public
2335
2334
  * <p>A list of ARNs that specifies the assessment templates returned by the
2336
2335
  * action.</p>
2336
+ * @public
2337
2337
  */
2338
2338
  assessmentTemplateArns: string[] | undefined;
2339
2339
  /**
2340
- * @public
2341
2340
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2342
2341
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2343
2342
  * data to be listed, this parameter is set to null.</p>
2343
+ * @public
2344
2344
  */
2345
2345
  nextToken?: string;
2346
2346
  }
@@ -2349,47 +2349,47 @@ export interface ListAssessmentTemplatesResponse {
2349
2349
  */
2350
2350
  export interface ListEventSubscriptionsRequest {
2351
2351
  /**
2352
- * @public
2353
2352
  * <p>The ARN of the assessment template for which you want to list the existing event
2354
2353
  * subscriptions.</p>
2354
+ * @public
2355
2355
  */
2356
2356
  resourceArn?: string;
2357
2357
  /**
2358
- * @public
2359
2358
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2360
2359
  * to null on your first call to the <b>ListEventSubscriptions</b>
2361
2360
  * action. Subsequent calls to the action fill <b>nextToken</b> in
2362
2361
  * the request with the value of <b>NextToken</b> from the previous
2363
2362
  * response to continue listing data.</p>
2363
+ * @public
2364
2364
  */
2365
2365
  nextToken?: string;
2366
2366
  /**
2367
- * @public
2368
2367
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2369
2368
  * response. The default value is 10. The maximum value is 500.</p>
2369
+ * @public
2370
2370
  */
2371
2371
  maxResults?: number;
2372
2372
  }
2373
2373
  /**
2374
- * @public
2375
2374
  * <p>This data type is used as a response element in the <a>ListEventSubscriptions</a> action.</p>
2375
+ * @public
2376
2376
  */
2377
2377
  export interface Subscription {
2378
2378
  /**
2379
- * @public
2380
2379
  * <p>The ARN of the assessment template that is used during the event for which the SNS
2381
2380
  * notification is sent.</p>
2381
+ * @public
2382
2382
  */
2383
2383
  resourceArn: string | undefined;
2384
2384
  /**
2385
- * @public
2386
2385
  * <p>The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS
2387
2386
  * notifications are sent.</p>
2387
+ * @public
2388
2388
  */
2389
2389
  topicArn: string | undefined;
2390
2390
  /**
2391
- * @public
2392
2391
  * <p>The list of existing event subscriptions.</p>
2392
+ * @public
2393
2393
  */
2394
2394
  eventSubscriptions: EventSubscription[] | undefined;
2395
2395
  }
@@ -2398,15 +2398,15 @@ export interface Subscription {
2398
2398
  */
2399
2399
  export interface ListEventSubscriptionsResponse {
2400
2400
  /**
2401
- * @public
2402
2401
  * <p>Details of the returned event subscriptions.</p>
2402
+ * @public
2403
2403
  */
2404
2404
  subscriptions: Subscription[] | undefined;
2405
2405
  /**
2406
- * @public
2407
2406
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2408
2407
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2409
2408
  * data to be listed, this parameter is set to null.</p>
2409
+ * @public
2410
2410
  */
2411
2411
  nextToken?: string;
2412
2412
  }
@@ -2415,23 +2415,23 @@ export interface ListEventSubscriptionsResponse {
2415
2415
  */
2416
2416
  export interface ListExclusionsRequest {
2417
2417
  /**
2418
- * @public
2419
2418
  * <p>The ARN of the assessment run that generated the exclusions that you want to
2420
2419
  * list.</p>
2420
+ * @public
2421
2421
  */
2422
2422
  assessmentRunArn: string | undefined;
2423
2423
  /**
2424
- * @public
2425
2424
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2426
2425
  * to null on your first call to the ListExclusionsRequest action. Subsequent calls to the
2427
2426
  * action fill nextToken in the request with the value of nextToken from the previous response
2428
2427
  * to continue listing data.</p>
2428
+ * @public
2429
2429
  */
2430
2430
  nextToken?: string;
2431
2431
  /**
2432
- * @public
2433
2432
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2434
2433
  * response. The default value is 100. The maximum value is 500.</p>
2434
+ * @public
2435
2435
  */
2436
2436
  maxResults?: number;
2437
2437
  }
@@ -2440,16 +2440,16 @@ export interface ListExclusionsRequest {
2440
2440
  */
2441
2441
  export interface ListExclusionsResponse {
2442
2442
  /**
2443
- * @public
2444
2443
  * <p>A list of exclusions' ARNs returned by the action.</p>
2444
+ * @public
2445
2445
  */
2446
2446
  exclusionArns: string[] | undefined;
2447
2447
  /**
2448
- * @public
2449
2448
  * <p>When a response is generated, if there is more data to be listed, this parameters is
2450
2449
  * present in the response and contains the value to use for the nextToken parameter in a
2451
2450
  * subsequent pagination request. If there is no more data to be listed, this parameter is set
2452
2451
  * to null.</p>
2452
+ * @public
2453
2453
  */
2454
2454
  nextToken?: string;
2455
2455
  }
@@ -2458,33 +2458,33 @@ export interface ListExclusionsResponse {
2458
2458
  */
2459
2459
  export interface ListFindingsRequest {
2460
2460
  /**
2461
- * @public
2462
2461
  * <p>The ARNs of the assessment runs that generate the findings that you want to
2463
2462
  * list.</p>
2463
+ * @public
2464
2464
  */
2465
2465
  assessmentRunArns?: string[];
2466
2466
  /**
2467
- * @public
2468
2467
  * <p>You can use this parameter to specify a subset of data to be included in the action's
2469
2468
  * response.</p>
2470
2469
  * <p>For a record to match a filter, all specified filter attributes must match. When
2471
2470
  * multiple values are specified for a filter attribute, any of the values can
2472
2471
  * match.</p>
2472
+ * @public
2473
2473
  */
2474
2474
  filter?: FindingFilter;
2475
2475
  /**
2476
- * @public
2477
2476
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2478
2477
  * to null on your first call to the <b>ListFindings</b> action.
2479
2478
  * Subsequent calls to the action fill <b>nextToken</b> in the
2480
2479
  * request with the value of <b>NextToken</b> from the previous
2481
2480
  * response to continue listing data.</p>
2481
+ * @public
2482
2482
  */
2483
2483
  nextToken?: string;
2484
2484
  /**
2485
- * @public
2486
2485
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2487
2486
  * response. The default value is 10. The maximum value is 500.</p>
2487
+ * @public
2488
2488
  */
2489
2489
  maxResults?: number;
2490
2490
  }
@@ -2493,15 +2493,15 @@ export interface ListFindingsRequest {
2493
2493
  */
2494
2494
  export interface ListFindingsResponse {
2495
2495
  /**
2496
- * @public
2497
2496
  * <p>A list of ARNs that specifies the findings returned by the action.</p>
2497
+ * @public
2498
2498
  */
2499
2499
  findingArns: string[] | undefined;
2500
2500
  /**
2501
- * @public
2502
2501
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2503
2502
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2504
2503
  * data to be listed, this parameter is set to null.</p>
2504
+ * @public
2505
2505
  */
2506
2506
  nextToken?: string;
2507
2507
  }
@@ -2510,18 +2510,18 @@ export interface ListFindingsResponse {
2510
2510
  */
2511
2511
  export interface ListRulesPackagesRequest {
2512
2512
  /**
2513
- * @public
2514
2513
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2515
2514
  * to null on your first call to the <b>ListRulesPackages</b>
2516
2515
  * action. Subsequent calls to the action fill <b>nextToken</b> in
2517
2516
  * the request with the value of <b>NextToken</b> from the previous
2518
2517
  * response to continue listing data.</p>
2518
+ * @public
2519
2519
  */
2520
2520
  nextToken?: string;
2521
2521
  /**
2522
- * @public
2523
2522
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2524
2523
  * response. The default value is 10. The maximum value is 500.</p>
2524
+ * @public
2525
2525
  */
2526
2526
  maxResults?: number;
2527
2527
  }
@@ -2530,15 +2530,15 @@ export interface ListRulesPackagesRequest {
2530
2530
  */
2531
2531
  export interface ListRulesPackagesResponse {
2532
2532
  /**
2533
- * @public
2534
2533
  * <p>The list of ARNs that specifies the rules packages returned by the action.</p>
2534
+ * @public
2535
2535
  */
2536
2536
  rulesPackageArns: string[] | undefined;
2537
2537
  /**
2538
- * @public
2539
2538
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2540
2539
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2541
2540
  * data to be listed, this parameter is set to null.</p>
2541
+ * @public
2542
2542
  */
2543
2543
  nextToken?: string;
2544
2544
  }
@@ -2547,8 +2547,8 @@ export interface ListRulesPackagesResponse {
2547
2547
  */
2548
2548
  export interface ListTagsForResourceRequest {
2549
2549
  /**
2550
- * @public
2551
2550
  * <p>The ARN that specifies the assessment template whose tags you want to list.</p>
2551
+ * @public
2552
2552
  */
2553
2553
  resourceArn: string | undefined;
2554
2554
  }
@@ -2557,8 +2557,8 @@ export interface ListTagsForResourceRequest {
2557
2557
  */
2558
2558
  export interface ListTagsForResourceResponse {
2559
2559
  /**
2560
- * @public
2561
2560
  * <p>A collection of key and value pairs.</p>
2561
+ * @public
2562
2562
  */
2563
2563
  tags: Tag[] | undefined;
2564
2564
  }
@@ -2567,23 +2567,23 @@ export interface ListTagsForResourceResponse {
2567
2567
  */
2568
2568
  export interface PreviewAgentsRequest {
2569
2569
  /**
2570
- * @public
2571
2570
  * <p>The ARN of the assessment target whose agents you want to preview.</p>
2571
+ * @public
2572
2572
  */
2573
2573
  previewAgentsArn: string | undefined;
2574
2574
  /**
2575
- * @public
2576
2575
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2577
2576
  * to null on your first call to the <b>PreviewAgents</b> action.
2578
2577
  * Subsequent calls to the action fill <b>nextToken</b> in the
2579
2578
  * request with the value of <b>NextToken</b> from the previous
2580
2579
  * response to continue listing data.</p>
2580
+ * @public
2581
2581
  */
2582
2582
  nextToken?: string;
2583
2583
  /**
2584
- * @public
2585
2584
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2586
2585
  * response. The default value is 10. The maximum value is 500.</p>
2586
+ * @public
2587
2587
  */
2588
2588
  maxResults?: number;
2589
2589
  }
@@ -2592,15 +2592,15 @@ export interface PreviewAgentsRequest {
2592
2592
  */
2593
2593
  export interface PreviewAgentsResponse {
2594
2594
  /**
2595
- * @public
2596
2595
  * <p>The resulting list of agents.</p>
2596
+ * @public
2597
2597
  */
2598
2598
  agentPreviews: AgentPreview[] | undefined;
2599
2599
  /**
2600
- * @public
2601
2600
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2602
2601
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2603
2602
  * data to be listed, this parameter is set to null.</p>
2603
+ * @public
2604
2604
  */
2605
2605
  nextToken?: string;
2606
2606
  }
@@ -2609,9 +2609,9 @@ export interface PreviewAgentsResponse {
2609
2609
  */
2610
2610
  export interface RegisterCrossAccountAccessRoleRequest {
2611
2611
  /**
2612
- * @public
2613
2612
  * <p>The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to
2614
2613
  * perform security assessments. </p>
2614
+ * @public
2615
2615
  */
2616
2616
  roleArn: string | undefined;
2617
2617
  }
@@ -2620,14 +2620,14 @@ export interface RegisterCrossAccountAccessRoleRequest {
2620
2620
  */
2621
2621
  export interface RemoveAttributesFromFindingsRequest {
2622
2622
  /**
2623
- * @public
2624
2623
  * <p>The ARNs that specify the findings that you want to remove attributes from.</p>
2624
+ * @public
2625
2625
  */
2626
2626
  findingArns: string[] | undefined;
2627
2627
  /**
2628
- * @public
2629
2628
  * <p>The array of attribute keys that you want to remove from specified
2630
2629
  * findings.</p>
2630
+ * @public
2631
2631
  */
2632
2632
  attributeKeys: string[] | undefined;
2633
2633
  }
@@ -2636,9 +2636,9 @@ export interface RemoveAttributesFromFindingsRequest {
2636
2636
  */
2637
2637
  export interface RemoveAttributesFromFindingsResponse {
2638
2638
  /**
2639
- * @public
2640
2639
  * <p>Attributes details that cannot be described. An error code is provided for each
2641
2640
  * failed item.</p>
2641
+ * @public
2642
2642
  */
2643
2643
  failedItems: Record<string, FailedItemDetails> | undefined;
2644
2644
  }
@@ -2647,14 +2647,14 @@ export interface RemoveAttributesFromFindingsResponse {
2647
2647
  */
2648
2648
  export interface SetTagsForResourceRequest {
2649
2649
  /**
2650
- * @public
2651
2650
  * <p>The ARN of the assessment template that you want to set tags to.</p>
2651
+ * @public
2652
2652
  */
2653
2653
  resourceArn: string | undefined;
2654
2654
  /**
2655
- * @public
2656
2655
  * <p>A collection of key and value pairs that you want to set to the assessment
2657
2656
  * template.</p>
2657
+ * @public
2658
2658
  */
2659
2659
  tags?: Tag[];
2660
2660
  }
@@ -2663,15 +2663,15 @@ export interface SetTagsForResourceRequest {
2663
2663
  */
2664
2664
  export interface StartAssessmentRunRequest {
2665
2665
  /**
2666
- * @public
2667
2666
  * <p>The ARN of the assessment template of the assessment run that you want to
2668
2667
  * start.</p>
2668
+ * @public
2669
2669
  */
2670
2670
  assessmentTemplateArn: string | undefined;
2671
2671
  /**
2672
- * @public
2673
2672
  * <p>You can specify the name for the assessment run. The name must be unique for the
2674
2673
  * assessment template whose ARN is used to start the assessment run.</p>
2674
+ * @public
2675
2675
  */
2676
2676
  assessmentRunName?: string;
2677
2677
  }
@@ -2680,8 +2680,8 @@ export interface StartAssessmentRunRequest {
2680
2680
  */
2681
2681
  export interface StartAssessmentRunResponse {
2682
2682
  /**
2683
- * @public
2684
2683
  * <p>The ARN of the assessment run that has been started.</p>
2684
+ * @public
2685
2685
  */
2686
2686
  assessmentRunArn: string | undefined;
2687
2687
  }
@@ -2702,16 +2702,16 @@ export type StopAction = (typeof StopAction)[keyof typeof StopAction];
2702
2702
  */
2703
2703
  export interface StopAssessmentRunRequest {
2704
2704
  /**
2705
- * @public
2706
2705
  * <p>The ARN of the assessment run that you want to stop.</p>
2706
+ * @public
2707
2707
  */
2708
2708
  assessmentRunArn: string | undefined;
2709
2709
  /**
2710
- * @public
2711
2710
  * <p>An input option that can be set to either START_EVALUATION or SKIP_EVALUATION.
2712
2711
  * START_EVALUATION (the default value), stops the AWS agent from collecting data and begins
2713
2712
  * the results evaluation and the findings generation process. SKIP_EVALUATION cancels the
2714
2713
  * assessment run immediately, after which no findings are generated.</p>
2714
+ * @public
2715
2715
  */
2716
2716
  stopAction?: StopAction;
2717
2717
  }
@@ -2720,19 +2720,19 @@ export interface StopAssessmentRunRequest {
2720
2720
  */
2721
2721
  export interface SubscribeToEventRequest {
2722
2722
  /**
2723
- * @public
2724
2723
  * <p>The ARN of the assessment template that is used during the event for which you want
2725
2724
  * to receive SNS notifications.</p>
2725
+ * @public
2726
2726
  */
2727
2727
  resourceArn: string | undefined;
2728
2728
  /**
2729
- * @public
2730
2729
  * <p>The event for which you want to receive SNS notifications.</p>
2730
+ * @public
2731
2731
  */
2732
2732
  event: InspectorEvent | undefined;
2733
2733
  /**
2734
- * @public
2735
2734
  * <p>The ARN of the SNS topic to which the SNS notifications are sent.</p>
2735
+ * @public
2736
2736
  */
2737
2737
  topicArn: string | undefined;
2738
2738
  }
@@ -2741,19 +2741,19 @@ export interface SubscribeToEventRequest {
2741
2741
  */
2742
2742
  export interface UnsubscribeFromEventRequest {
2743
2743
  /**
2744
- * @public
2745
2744
  * <p>The ARN of the assessment template that is used during the event for which you want
2746
2745
  * to stop receiving SNS notifications.</p>
2746
+ * @public
2747
2747
  */
2748
2748
  resourceArn: string | undefined;
2749
2749
  /**
2750
- * @public
2751
2750
  * <p>The event for which you want to stop receiving SNS notifications.</p>
2751
+ * @public
2752
2752
  */
2753
2753
  event: InspectorEvent | undefined;
2754
2754
  /**
2755
- * @public
2756
2755
  * <p>The ARN of the SNS topic to which SNS notifications are sent.</p>
2756
+ * @public
2757
2757
  */
2758
2758
  topicArn: string | undefined;
2759
2759
  }
@@ -2762,19 +2762,19 @@ export interface UnsubscribeFromEventRequest {
2762
2762
  */
2763
2763
  export interface UpdateAssessmentTargetRequest {
2764
2764
  /**
2765
- * @public
2766
2765
  * <p>The ARN of the assessment target that you want to update.</p>
2766
+ * @public
2767
2767
  */
2768
2768
  assessmentTargetArn: string | undefined;
2769
2769
  /**
2770
- * @public
2771
2770
  * <p>The name of the assessment target that you want to update.</p>
2771
+ * @public
2772
2772
  */
2773
2773
  assessmentTargetName: string | undefined;
2774
2774
  /**
2775
- * @public
2776
2775
  * <p>The ARN of the resource group that is used to specify the new resource group to
2777
2776
  * associate with the assessment target.</p>
2777
+ * @public
2778
2778
  */
2779
2779
  resourceGroupArn?: string;
2780
2780
  }