@aws-sdk/client-codeguru-security 3.379.1 → 3.385.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.
@@ -8,14 +8,17 @@ export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
9
9
  readonly $fault: "client";
10
10
  /**
11
+ * @public
11
12
  * <p>The identifier for the error.</p>
12
13
  */
13
14
  errorCode: string | undefined;
14
15
  /**
16
+ * @public
15
17
  * <p>The identifier for the resource you don't have access to.</p>
16
18
  */
17
19
  resourceId?: string;
18
20
  /**
21
+ * @public
19
22
  * <p>The type of resource you don't have access to.</p>
20
23
  */
21
24
  resourceType?: string;
@@ -30,23 +33,28 @@ export declare class AccessDeniedException extends __BaseException {
30
33
  */
31
34
  export interface FindingMetricsValuePerSeverity {
32
35
  /**
36
+ * @public
33
37
  * <p>The finding is related to quality or readability improvements and not considered
34
38
  * actionable.</p>
35
39
  */
36
40
  info?: number;
37
41
  /**
42
+ * @public
38
43
  * <p>The severity of the finding is low and does require action on its own.</p>
39
44
  */
40
45
  low?: number;
41
46
  /**
47
+ * @public
42
48
  * <p>The severity of the finding is medium and should be addressed as a mid-term priority.</p>
43
49
  */
44
50
  medium?: number;
45
51
  /**
52
+ * @public
46
53
  * <p>The severity of the finding is high and should be addressed as a near-term priority.</p>
47
54
  */
48
55
  high?: number;
49
56
  /**
57
+ * @public
50
58
  * <p>The severity of the finding is critical and should be addressed immediately.</p>
51
59
  */
52
60
  critical?: number;
@@ -57,22 +65,27 @@ export interface FindingMetricsValuePerSeverity {
57
65
  */
58
66
  export interface AccountFindingsMetric {
59
67
  /**
68
+ * @public
60
69
  * <p>The date from which the finding metrics were retrieved.</p>
61
70
  */
62
71
  date?: Date;
63
72
  /**
73
+ * @public
64
74
  * <p>The number of new findings of each severity in account on the specified date.</p>
65
75
  */
66
76
  newFindings?: FindingMetricsValuePerSeverity;
67
77
  /**
78
+ * @public
68
79
  * <p>The number of closed findings of each severity in an account on the specified date.</p>
69
80
  */
70
81
  closedFindings?: FindingMetricsValuePerSeverity;
71
82
  /**
83
+ * @public
72
84
  * <p>The number of open findings of each severity in an account as of the specified date.</p>
73
85
  */
74
86
  openFindings?: FindingMetricsValuePerSeverity;
75
87
  /**
88
+ * @public
76
89
  * <p>The average time it takes to close findings of each severity in days.</p>
77
90
  */
78
91
  meanTimeToClose?: FindingMetricsValuePerSeverity;
@@ -95,10 +108,12 @@ export type AnalysisType = (typeof AnalysisType)[keyof typeof AnalysisType];
95
108
  */
96
109
  export interface FindingIdentifier {
97
110
  /**
111
+ * @public
98
112
  * <p>The name of the scan that generated the finding. </p>
99
113
  */
100
114
  scanName: string | undefined;
101
115
  /**
116
+ * @public
102
117
  * <p>The identifier for a finding.</p>
103
118
  */
104
119
  findingId: string | undefined;
@@ -108,6 +123,7 @@ export interface FindingIdentifier {
108
123
  */
109
124
  export interface BatchGetFindingsRequest {
110
125
  /**
126
+ * @public
111
127
  * <p>A list of finding identifiers. Each identifier consists of a <code>scanName</code> and a
112
128
  * <code>findingId</code>. You retrieve the <code>findingId</code> when you call
113
129
  * <code>GetFindings</code>.</p>
@@ -135,18 +151,22 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
135
151
  */
136
152
  export interface BatchGetFindingsError {
137
153
  /**
154
+ * @public
138
155
  * <p>The name of the scan that generated the finding.</p>
139
156
  */
140
157
  scanName: string | undefined;
141
158
  /**
159
+ * @public
142
160
  * <p>The finding ID of the finding that was not fetched.</p>
143
161
  */
144
162
  findingId: string | undefined;
145
163
  /**
164
+ * @public
146
165
  * <p>A code associated with the type of error.</p>
147
166
  */
148
167
  errorCode: ErrorCode | string | undefined;
149
168
  /**
169
+ * @public
150
170
  * <p>Describes the error.</p>
151
171
  */
152
172
  message: string | undefined;
@@ -157,10 +177,12 @@ export interface BatchGetFindingsError {
157
177
  */
158
178
  export interface Recommendation {
159
179
  /**
180
+ * @public
160
181
  * <p>The recommended course of action to remediate the finding.</p>
161
182
  */
162
183
  text?: string;
163
184
  /**
185
+ * @public
164
186
  * <p>The URL address to the recommendation for remediating the finding. </p>
165
187
  */
166
188
  url?: string;
@@ -171,10 +193,12 @@ export interface Recommendation {
171
193
  */
172
194
  export interface SuggestedFix {
173
195
  /**
196
+ * @public
174
197
  * <p>A description of the suggested code fix and why it is being suggested. </p>
175
198
  */
176
199
  description?: string;
177
200
  /**
201
+ * @public
178
202
  * <p>The suggested code to add to your file. </p>
179
203
  */
180
204
  code?: string;
@@ -185,10 +209,12 @@ export interface SuggestedFix {
185
209
  */
186
210
  export interface Remediation {
187
211
  /**
212
+ * @public
188
213
  * <p>An object that contains information about the recommended course of action to remediate a finding.</p>
189
214
  */
190
215
  recommendation?: Recommendation;
191
216
  /**
217
+ * @public
192
218
  * <p>A list of <code>SuggestedFix</code> objects. Each object contains information about a suggested code
193
219
  * fix to remediate the finding.</p>
194
220
  */
@@ -201,10 +227,12 @@ export interface Remediation {
201
227
  */
202
228
  export interface Resource {
203
229
  /**
230
+ * @public
204
231
  * <p>The identifier for the resource.</p>
205
232
  */
206
233
  id?: string;
207
234
  /**
235
+ * @public
208
236
  * <p>The identifier for a section of the resource, such as an AWS Lambda layer.</p>
209
237
  */
210
238
  subResourceId?: string;
@@ -243,10 +271,12 @@ export type Status = (typeof Status)[keyof typeof Status];
243
271
  */
244
272
  export interface CodeLine {
245
273
  /**
274
+ * @public
246
275
  * <p>The code line number.</p>
247
276
  */
248
277
  number?: number;
249
278
  /**
279
+ * @public
250
280
  * <p>The code that contains a vulnerability.</p>
251
281
  */
252
282
  content?: string;
@@ -258,23 +288,28 @@ export interface CodeLine {
258
288
  */
259
289
  export interface FilePath {
260
290
  /**
291
+ * @public
261
292
  * <p>The name of the file.</p>
262
293
  */
263
294
  name?: string;
264
295
  /**
296
+ * @public
265
297
  * <p>The path to the resource with the security vulnerability.</p>
266
298
  */
267
299
  path?: string;
268
300
  /**
301
+ * @public
269
302
  * <p>The first line number of the code snippet where the security vulnerability appears in your code.</p>
270
303
  */
271
304
  startLine?: number;
272
305
  /**
306
+ * @public
273
307
  * <p>The last line number of the code snippet where the security vulnerability appears in your
274
308
  * code.</p>
275
309
  */
276
310
  endLine?: number;
277
311
  /**
312
+ * @public
278
313
  * <p>A list of <code>CodeLine</code> objects that describe where the security vulnerability
279
314
  * appears in your code.</p>
280
315
  */
@@ -286,23 +321,28 @@ export interface FilePath {
286
321
  */
287
322
  export interface Vulnerability {
288
323
  /**
324
+ * @public
289
325
  * <p>One or more URL addresses that contain details about a vulnerability.</p>
290
326
  */
291
327
  referenceUrls?: string[];
292
328
  /**
329
+ * @public
293
330
  * <p>One or more vulnerabilities that are related to the vulnerability being described.</p>
294
331
  */
295
332
  relatedVulnerabilities?: string[];
296
333
  /**
334
+ * @public
297
335
  * <p>The identifier for the vulnerability.</p>
298
336
  */
299
337
  id?: string;
300
338
  /**
339
+ * @public
301
340
  * <p> An object that describes the location of the detected security vulnerability in your
302
341
  * code.</p>
303
342
  */
304
343
  filePath?: FilePath;
305
344
  /**
345
+ * @public
306
346
  * <p> The number of times the vulnerability appears in your code.</p>
307
347
  */
308
348
  itemCount?: number;
@@ -313,71 +353,87 @@ export interface Vulnerability {
313
353
  */
314
354
  export interface Finding {
315
355
  /**
356
+ * @public
316
357
  * <p>The time when the finding was created.</p>
317
358
  */
318
359
  createdAt?: Date;
319
360
  /**
361
+ * @public
320
362
  * <p>A description of the finding.</p>
321
363
  */
322
364
  description?: string;
323
365
  /**
366
+ * @public
324
367
  * <p>The identifier for the component that generated a finding such as AWSCodeGuruSecurity or
325
368
  * AWSInspector.</p>
326
369
  */
327
370
  generatorId?: string;
328
371
  /**
372
+ * @public
329
373
  * <p>The identifier for a finding.</p>
330
374
  */
331
375
  id?: string;
332
376
  /**
377
+ * @public
333
378
  * <p>The time when the finding was last updated. Findings are updated when you remediate them
334
379
  * or when the finding code location changes. </p>
335
380
  */
336
381
  updatedAt?: Date;
337
382
  /**
383
+ * @public
338
384
  * <p>The type of finding. </p>
339
385
  */
340
386
  type?: string;
341
387
  /**
388
+ * @public
342
389
  * <p>The status of the finding. A finding status can be open or closed. </p>
343
390
  */
344
391
  status?: Status | string;
345
392
  /**
393
+ * @public
346
394
  * <p>The resource where Amazon CodeGuru Security detected a finding.</p>
347
395
  */
348
396
  resource?: Resource;
349
397
  /**
398
+ * @public
350
399
  * <p>An object that describes the detected security vulnerability.</p>
351
400
  */
352
401
  vulnerability?: Vulnerability;
353
402
  /**
403
+ * @public
354
404
  * <p>The severity of the finding.</p>
355
405
  */
356
406
  severity?: Severity | string;
357
407
  /**
408
+ * @public
358
409
  * <p>An object that contains the details about how to remediate a finding.</p>
359
410
  */
360
411
  remediation?: Remediation;
361
412
  /**
413
+ * @public
362
414
  * <p>The title of the finding.</p>
363
415
  */
364
416
  title?: string;
365
417
  /**
418
+ * @public
366
419
  * <p>One or more tags or categorizations that are associated with a detector. These tags are
367
420
  * defined by type, programming language, or other classification such as maintainability or
368
421
  * consistency.</p>
369
422
  */
370
423
  detectorTags?: string[];
371
424
  /**
425
+ * @public
372
426
  * <p>The identifier for the detector that detected the finding in your code. A detector is a
373
427
  * defined rule based on industry standards and AWS best practices. </p>
374
428
  */
375
429
  detectorId?: string;
376
430
  /**
431
+ * @public
377
432
  * <p>The name of the detector that identified the security vulnerability in your code. </p>
378
433
  */
379
434
  detectorName?: string;
380
435
  /**
436
+ * @public
381
437
  * <p>The identifier for the rule that generated the finding.</p>
382
438
  */
383
439
  ruleId?: string;
@@ -387,10 +443,12 @@ export interface Finding {
387
443
  */
388
444
  export interface BatchGetFindingsResponse {
389
445
  /**
446
+ * @public
390
447
  * <p> A list of all requested findings.</p>
391
448
  */
392
449
  findings: Finding[] | undefined;
393
450
  /**
451
+ * @public
394
452
  * <p>A list of errors for individual findings which were not fetched. Each
395
453
  * BatchGetFindingsError contains the <code>scanName</code>, <code>findingId</code>,
396
454
  * <code>errorCode</code> and error <code>message</code>.</p>
@@ -406,6 +464,7 @@ export declare class InternalServerException extends __BaseException {
406
464
  readonly $fault: "server";
407
465
  $retryable: {};
408
466
  /**
467
+ * @public
409
468
  * <p>The internal error encountered by the server.</p>
410
469
  */
411
470
  error?: string;
@@ -425,14 +484,17 @@ export declare class ThrottlingException extends __BaseException {
425
484
  throttling: boolean;
426
485
  };
427
486
  /**
487
+ * @public
428
488
  * <p>The identifier for the error.</p>
429
489
  */
430
490
  errorCode: string | undefined;
431
491
  /**
492
+ * @public
432
493
  * <p>The identifier for the originating service.</p>
433
494
  */
434
495
  serviceCode?: string;
435
496
  /**
497
+ * @public
436
498
  * <p>The identifier for the originating quota.</p>
437
499
  */
438
500
  quotaCode?: string;
@@ -447,10 +509,12 @@ export declare class ThrottlingException extends __BaseException {
447
509
  */
448
510
  export interface ValidationExceptionField {
449
511
  /**
512
+ * @public
450
513
  * <p>The name of the exception.</p>
451
514
  */
452
515
  name: string | undefined;
453
516
  /**
517
+ * @public
454
518
  * <p>Describes the exception.</p>
455
519
  */
456
520
  message: string | undefined;
@@ -478,14 +542,17 @@ export declare class ValidationException extends __BaseException {
478
542
  readonly name: "ValidationException";
479
543
  readonly $fault: "client";
480
544
  /**
545
+ * @public
481
546
  * <p>The identifier for the error.</p>
482
547
  */
483
548
  errorCode: string | undefined;
484
549
  /**
550
+ * @public
485
551
  * <p>The reason the request failed validation.</p>
486
552
  */
487
553
  reason: ValidationExceptionReason | string | undefined;
488
554
  /**
555
+ * @public
489
556
  * <p>The field that caused the error, if applicable.</p>
490
557
  */
491
558
  fieldList?: ValidationExceptionField[];
@@ -504,14 +571,17 @@ export declare class ConflictException extends __BaseException {
504
571
  readonly name: "ConflictException";
505
572
  readonly $fault: "client";
506
573
  /**
574
+ * @public
507
575
  * <p>The identifier for the error.</p>
508
576
  */
509
577
  errorCode: string | undefined;
510
578
  /**
579
+ * @public
511
580
  * <p>The identifier for the service resource associated with the request.</p>
512
581
  */
513
582
  resourceId: string | undefined;
514
583
  /**
584
+ * @public
515
585
  * <p>The type of resource associated with the request.</p>
516
586
  */
517
587
  resourceType: string | undefined;
@@ -530,12 +600,16 @@ export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMe
530
600
  */
531
601
  export declare namespace ResourceId {
532
602
  /**
603
+ * @public
533
604
  * <p>The identifier for the code file uploaded to the resource where a finding was detected.</p>
534
605
  */
535
606
  interface CodeArtifactIdMember {
536
607
  codeArtifactId: string;
537
608
  $unknown?: never;
538
609
  }
610
+ /**
611
+ * @public
612
+ */
539
613
  interface $UnknownMember {
540
614
  codeArtifactId?: never;
541
615
  $unknown: [string, any];
@@ -563,21 +637,25 @@ export type ScanType = (typeof ScanType)[keyof typeof ScanType];
563
637
  */
564
638
  export interface CreateScanRequest {
565
639
  /**
640
+ * @public
566
641
  * <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent
567
642
  * the accidental creation of duplicate scans if there are failures and retries.</p>
568
643
  */
569
644
  clientToken?: string;
570
645
  /**
646
+ * @public
571
647
  * <p>The identifier for an input resource used to create a scan.</p>
572
648
  */
573
649
  resourceId: ResourceId | undefined;
574
650
  /**
651
+ * @public
575
652
  * <p>The unique name that CodeGuru Security uses to track revisions across multiple
576
653
  * scans of the same resource. Only allowed for a <code>STANDARD</code> scan type. If not
577
654
  * specified, it will be auto generated. </p>
578
655
  */
579
656
  scanName: string | undefined;
580
657
  /**
658
+ * @public
581
659
  * <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to
582
660
  * <code>Standard</code> type if missing.</p>
583
661
  * <p>
@@ -587,6 +665,7 @@ export interface CreateScanRequest {
587
665
  */
588
666
  scanType?: ScanType | string;
589
667
  /**
668
+ * @public
590
669
  * <p>The type of analysis you want CodeGuru Security to perform in the scan, either
591
670
  * <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates
592
671
  * findings related to security. The <code>All</code> type generates both security findings and
@@ -594,6 +673,7 @@ export interface CreateScanRequest {
594
673
  */
595
674
  analysisType?: AnalysisType | string;
596
675
  /**
676
+ * @public
597
677
  * <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute
598
678
  * label with two parts:</p>
599
679
  * <ul>
@@ -628,23 +708,28 @@ export type ScanState = (typeof ScanState)[keyof typeof ScanState];
628
708
  */
629
709
  export interface CreateScanResponse {
630
710
  /**
711
+ * @public
631
712
  * <p>The name of the scan.</p>
632
713
  */
633
714
  scanName: string | undefined;
634
715
  /**
716
+ * @public
635
717
  * <p>UUID that identifies the individual scan run.</p>
636
718
  */
637
719
  runId: string | undefined;
638
720
  /**
721
+ * @public
639
722
  * <p>The identifier for the resource object that contains resources that were scanned.</p>
640
723
  */
641
724
  resourceId: ResourceId | undefined;
642
725
  /**
726
+ * @public
643
727
  * <p>The current state of the scan. Returns either <code>InProgress</code>,
644
728
  * <code>Successful</code>, or <code>Failed</code>.</p>
645
729
  */
646
730
  scanState: ScanState | string | undefined;
647
731
  /**
732
+ * @public
648
733
  * <p>The ARN for the scan name.</p>
649
734
  */
650
735
  scanNameArn?: string;
@@ -657,14 +742,17 @@ export declare class ResourceNotFoundException extends __BaseException {
657
742
  readonly name: "ResourceNotFoundException";
658
743
  readonly $fault: "client";
659
744
  /**
745
+ * @public
660
746
  * <p>The identifier for the error.</p>
661
747
  */
662
748
  errorCode: string | undefined;
663
749
  /**
750
+ * @public
664
751
  * <p>The identifier for the resource that was not found.</p>
665
752
  */
666
753
  resourceId: string | undefined;
667
754
  /**
755
+ * @public
668
756
  * <p>The type of resource that was not found.</p>
669
757
  */
670
758
  resourceType: string | undefined;
@@ -678,6 +766,7 @@ export declare class ResourceNotFoundException extends __BaseException {
678
766
  */
679
767
  export interface CreateUploadUrlRequest {
680
768
  /**
769
+ * @public
681
770
  * <p>The name of the scan that will use the uploaded resource. CodeGuru Security uses the
682
771
  * unique scan name to track revisions across multiple scans of the same resource. Use this
683
772
  * <code>scanName</code> when you call <code>CreateScan</code> on the code resource you upload to this URL.</p>
@@ -689,16 +778,19 @@ export interface CreateUploadUrlRequest {
689
778
  */
690
779
  export interface CreateUploadUrlResponse {
691
780
  /**
781
+ * @public
692
782
  * <p>A pre-signed S3 URL. You can upload the code file you want to scan and add the required
693
783
  * <code>requestHeaders</code> using any HTTP client.</p>
694
784
  */
695
785
  s3Url: string | undefined;
696
786
  /**
787
+ * @public
697
788
  * <p>A set of key-value pairs that contain the required headers when uploading your
698
789
  * resource.</p>
699
790
  */
700
791
  requestHeaders: Record<string, string> | undefined;
701
792
  /**
793
+ * @public
702
794
  * <p>The identifier for the uploaded code resource. </p>
703
795
  */
704
796
  codeArtifactId: string | undefined;
@@ -714,6 +806,7 @@ export interface GetAccountConfigurationRequest {
714
806
  */
715
807
  export interface EncryptionConfig {
716
808
  /**
809
+ * @public
717
810
  * <p>The KMS key ARN to use for encryption. This must be provided as a header when uploading
718
811
  * your code resource.</p>
719
812
  */
@@ -724,6 +817,7 @@ export interface EncryptionConfig {
724
817
  */
725
818
  export interface GetAccountConfigurationResponse {
726
819
  /**
820
+ * @public
727
821
  * <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN to use for
728
822
  * encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify
729
823
  * your own key, call <code>UpdateAccountConfiguration</code>.</p>
@@ -735,16 +829,19 @@ export interface GetAccountConfigurationResponse {
735
829
  */
736
830
  export interface GetFindingsRequest {
737
831
  /**
832
+ * @public
738
833
  * <p>The name of the scan you want to retrieve findings from.</p>
739
834
  */
740
835
  scanName: string | undefined;
741
836
  /**
837
+ * @public
742
838
  * <p>A token to use for paginating results that are returned in the response. Set the value of
743
839
  * this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value
744
840
  * returned from the previous request to continue listing results after the first page.</p>
745
841
  */
746
842
  nextToken?: string;
747
843
  /**
844
+ * @public
748
845
  * <p>The maximum number of results to return in the response. Use this parameter when
749
846
  * paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
750
847
  * element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
@@ -752,6 +849,7 @@ export interface GetFindingsRequest {
752
849
  */
753
850
  maxResults?: number;
754
851
  /**
852
+ * @public
755
853
  * <p>The status of the findings you want to get. Pass either <code>Open</code>,
756
854
  * <code>Closed</code>, or <code>All</code>.</p>
757
855
  */
@@ -762,10 +860,12 @@ export interface GetFindingsRequest {
762
860
  */
763
861
  export interface GetFindingsResponse {
764
862
  /**
863
+ * @public
765
864
  * <p>A list of findings generated by the specified scan.</p>
766
865
  */
767
866
  findings?: Finding[];
768
867
  /**
868
+ * @public
769
869
  * <p>A pagination token. You can use this in future calls to <code>GetFindings</code> to continue listing
770
870
  * results after the current page. </p>
771
871
  */
@@ -776,6 +876,7 @@ export interface GetFindingsResponse {
776
876
  */
777
877
  export interface GetMetricsSummaryRequest {
778
878
  /**
879
+ * @public
779
880
  * <p>The date you want to retrieve summary metrics from, rounded to the nearest day. The date
780
881
  * must be within the past two years since metrics data is only stored for two years. If a date
781
882
  * outside of this range is passed, the response will be empty.</p>
@@ -788,11 +889,13 @@ export interface GetMetricsSummaryRequest {
788
889
  */
789
890
  export interface CategoryWithFindingNum {
790
891
  /**
892
+ * @public
791
893
  * <p>The name of the finding category. A finding category is determined by the detector that
792
894
  * detected the finding.</p>
793
895
  */
794
896
  categoryName?: string;
795
897
  /**
898
+ * @public
796
899
  * <p>The number of open findings in the category.</p>
797
900
  */
798
901
  findingNumber?: number;
@@ -803,10 +906,12 @@ export interface CategoryWithFindingNum {
803
906
  */
804
907
  export interface ScanNameWithFindingNum {
805
908
  /**
909
+ * @public
806
910
  * <p>The name of the scan.</p>
807
911
  */
808
912
  scanName?: string;
809
913
  /**
914
+ * @public
810
915
  * <p>The number of open findings generated by a scan.</p>
811
916
  */
812
917
  findingNumber?: number;
@@ -817,24 +922,29 @@ export interface ScanNameWithFindingNum {
817
922
  */
818
923
  export interface MetricsSummary {
819
924
  /**
925
+ * @public
820
926
  * <p>The date from which the metrics summary information was retrieved.</p>
821
927
  */
822
928
  date?: Date;
823
929
  /**
930
+ * @public
824
931
  * <p>The number of open findings of each severity in an account.</p>
825
932
  */
826
933
  openFindings?: FindingMetricsValuePerSeverity;
827
934
  /**
935
+ * @public
828
936
  * <p>A list of <code>CategoryWithFindingNum</code> objects for the top 5 finding categories
829
937
  * with the most open findings in an account.</p>
830
938
  */
831
939
  categoriesWithMostFindings?: CategoryWithFindingNum[];
832
940
  /**
941
+ * @public
833
942
  * <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most
834
943
  * number of open critical findings in an account.</p>
835
944
  */
836
945
  scansWithMostOpenFindings?: ScanNameWithFindingNum[];
837
946
  /**
947
+ * @public
838
948
  * <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most
839
949
  * number of open findings in an account.</p>
840
950
  */
@@ -845,6 +955,7 @@ export interface MetricsSummary {
845
955
  */
846
956
  export interface GetMetricsSummaryResponse {
847
957
  /**
958
+ * @public
848
959
  * <p>The summary metrics from the specified date.</p>
849
960
  */
850
961
  metricsSummary?: MetricsSummary;
@@ -854,10 +965,12 @@ export interface GetMetricsSummaryResponse {
854
965
  */
855
966
  export interface GetScanRequest {
856
967
  /**
968
+ * @public
857
969
  * <p>The name of the scan you want to view details about.</p>
858
970
  */
859
971
  scanName: string | undefined;
860
972
  /**
973
+ * @public
861
974
  * <p>UUID that identifies the individual scan run you want to view details about. You retrieve
862
975
  * this when you call the <code>CreateScan</code> operation. Defaults to the latest scan run if missing.</p>
863
976
  */
@@ -868,23 +981,28 @@ export interface GetScanRequest {
868
981
  */
869
982
  export interface GetScanResponse {
870
983
  /**
984
+ * @public
871
985
  * <p>The name of the scan.</p>
872
986
  */
873
987
  scanName: string | undefined;
874
988
  /**
989
+ * @public
875
990
  * <p>UUID that identifies the individual scan run.</p>
876
991
  */
877
992
  runId: string | undefined;
878
993
  /**
994
+ * @public
879
995
  * <p>The current state of the scan. Pass either <code>InProgress</code>,
880
996
  * <code>Successful</code>, or <code>Failed</code>.</p>
881
997
  */
882
998
  scanState: ScanState | string | undefined;
883
999
  /**
1000
+ * @public
884
1001
  * <p>The time the scan was created.</p>
885
1002
  */
886
1003
  createdAt: Date | undefined;
887
1004
  /**
1005
+ * @public
888
1006
  * <p>The type of analysis CodeGuru Security performed in the scan, either
889
1007
  * <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates
890
1008
  * findings related to security. The <code>All</code> type generates both security findings and
@@ -892,14 +1010,17 @@ export interface GetScanResponse {
892
1010
  */
893
1011
  analysisType: AnalysisType | string | undefined;
894
1012
  /**
1013
+ * @public
895
1014
  * <p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>
896
1015
  */
897
1016
  updatedAt?: Date;
898
1017
  /**
1018
+ * @public
899
1019
  * <p>The number of times a scan has been re-run on a revised resource.</p>
900
1020
  */
901
1021
  numberOfRevisions?: number;
902
1022
  /**
1023
+ * @public
903
1024
  * <p>The ARN for the scan name.</p>
904
1025
  */
905
1026
  scanNameArn?: string;
@@ -909,6 +1030,7 @@ export interface GetScanResponse {
909
1030
  */
910
1031
  export interface ListFindingsMetricsRequest {
911
1032
  /**
1033
+ * @public
912
1034
  * <p>A token to use for paginating results that are returned in the response. Set the
913
1035
  * value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code>
914
1036
  * value returned from the previous request to continue listing results after the first
@@ -916,6 +1038,7 @@ export interface ListFindingsMetricsRequest {
916
1038
  */
917
1039
  nextToken?: string;
918
1040
  /**
1041
+ * @public
919
1042
  * <p>The maximum number of results to return in the response. Use this parameter when
920
1043
  * paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
921
1044
  * element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
@@ -923,10 +1046,12 @@ export interface ListFindingsMetricsRequest {
923
1046
  */
924
1047
  maxResults?: number;
925
1048
  /**
1049
+ * @public
926
1050
  * <p>The start date of the interval which you want to retrieve metrics from.</p>
927
1051
  */
928
1052
  startDate: Date | undefined;
929
1053
  /**
1054
+ * @public
930
1055
  * <p>The end date of the interval which you want to retrieve metrics from.</p>
931
1056
  */
932
1057
  endDate: Date | undefined;
@@ -936,10 +1061,12 @@ export interface ListFindingsMetricsRequest {
936
1061
  */
937
1062
  export interface ListFindingsMetricsResponse {
938
1063
  /**
1064
+ * @public
939
1065
  * <p>A list of <code>AccountFindingsMetric</code> objects retrieved from the specified time interval.</p>
940
1066
  */
941
1067
  findingsMetrics?: AccountFindingsMetric[];
942
1068
  /**
1069
+ * @public
943
1070
  * <p>A pagination token. You can use this in future calls to <code>ListFindingMetrics</code> to continue
944
1071
  * listing results after the current page. </p>
945
1072
  */
@@ -950,12 +1077,14 @@ export interface ListFindingsMetricsResponse {
950
1077
  */
951
1078
  export interface ListScansRequest {
952
1079
  /**
1080
+ * @public
953
1081
  * <p>A token to use for paginating results that are returned in the response. Set the value of
954
1082
  * this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value
955
1083
  * returned from the previous request to continue listing results after the first page.</p>
956
1084
  */
957
1085
  nextToken?: string;
958
1086
  /**
1087
+ * @public
959
1088
  * <p>The maximum number of results to return in the response. Use this parameter when
960
1089
  * paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
961
1090
  * element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
@@ -969,27 +1098,33 @@ export interface ListScansRequest {
969
1098
  */
970
1099
  export interface ScanSummary {
971
1100
  /**
1101
+ * @public
972
1102
  * <p>The state of the scan. A scan can be <code>In Progress</code>,
973
1103
  * <code>Complete</code>, or <code>Failed</code>. </p>
974
1104
  */
975
1105
  scanState: ScanState | string | undefined;
976
1106
  /**
1107
+ * @public
977
1108
  * <p> The time when the scan was created. </p>
978
1109
  */
979
1110
  createdAt: Date | undefined;
980
1111
  /**
1112
+ * @public
981
1113
  * <p>The time the scan was last updated. A scan is updated when it is re-run.</p>
982
1114
  */
983
1115
  updatedAt?: Date;
984
1116
  /**
1117
+ * @public
985
1118
  * <p>The name of the scan. </p>
986
1119
  */
987
1120
  scanName: string | undefined;
988
1121
  /**
1122
+ * @public
989
1123
  * <p>The identifier for the scan run. </p>
990
1124
  */
991
1125
  runId: string | undefined;
992
1126
  /**
1127
+ * @public
993
1128
  * <p>The ARN for the scan name.</p>
994
1129
  */
995
1130
  scanNameArn?: string;
@@ -999,10 +1134,12 @@ export interface ScanSummary {
999
1134
  */
1000
1135
  export interface ListScansResponse {
1001
1136
  /**
1137
+ * @public
1002
1138
  * <p>A list of <code>ScanSummary</code> objects with information about all scans in an account.</p>
1003
1139
  */
1004
1140
  summaries?: ScanSummary[];
1005
1141
  /**
1142
+ * @public
1006
1143
  * <p>A pagination token. You can use this in future calls to <code>ListScans</code> to continue listing
1007
1144
  * results after the current page.</p>
1008
1145
  */
@@ -1013,6 +1150,7 @@ export interface ListScansResponse {
1013
1150
  */
1014
1151
  export interface ListTagsForResourceRequest {
1015
1152
  /**
1153
+ * @public
1016
1154
  * <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
1017
1155
  * <code>ListScans</code> or <code>GetScan</code>.</p>
1018
1156
  */
@@ -1023,6 +1161,7 @@ export interface ListTagsForResourceRequest {
1023
1161
  */
1024
1162
  export interface ListTagsForResourceResponse {
1025
1163
  /**
1164
+ * @public
1026
1165
  * <p>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute
1027
1166
  * label with two parts:</p>
1028
1167
  * <ul>
@@ -1044,11 +1183,13 @@ export interface ListTagsForResourceResponse {
1044
1183
  */
1045
1184
  export interface TagResourceRequest {
1046
1185
  /**
1186
+ * @public
1047
1187
  * <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
1048
1188
  * <code>ListScans</code> or <code>GetScan</code>.</p>
1049
1189
  */
1050
1190
  resourceArn: string | undefined;
1051
1191
  /**
1192
+ * @public
1052
1193
  * <p>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute
1053
1194
  * label with two parts:</p>
1054
1195
  * <ul>
@@ -1075,11 +1216,13 @@ export interface TagResourceResponse {
1075
1216
  */
1076
1217
  export interface UntagResourceRequest {
1077
1218
  /**
1219
+ * @public
1078
1220
  * <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
1079
1221
  * <code>ListScans</code> or <code>GetScan</code>.</p>
1080
1222
  */
1081
1223
  resourceArn: string | undefined;
1082
1224
  /**
1225
+ * @public
1083
1226
  * <p>A list of keys for each tag you want to remove from a scan.</p>
1084
1227
  */
1085
1228
  tagKeys: string[] | undefined;
@@ -1094,6 +1237,7 @@ export interface UntagResourceResponse {
1094
1237
  */
1095
1238
  export interface UpdateAccountConfigurationRequest {
1096
1239
  /**
1240
+ * @public
1097
1241
  * <p>The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.</p>
1098
1242
  */
1099
1243
  encryptionConfig: EncryptionConfig | undefined;
@@ -1103,6 +1247,7 @@ export interface UpdateAccountConfigurationRequest {
1103
1247
  */
1104
1248
  export interface UpdateAccountConfigurationResponse {
1105
1249
  /**
1250
+ * @public
1106
1251
  * <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN to use for
1107
1252
  * encryption.</p>
1108
1253
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codeguru-security",
3
3
  "description": "AWS SDK for JavaScript Codeguru Security Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",