aws-sdk-codegurusecurity 1.33.0 → 1.34.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.
@@ -41,37 +41,37 @@ module Aws::CodeGuruSecurity
41
41
 
42
42
  # A summary of findings metrics for an account on a specified date.
43
43
  #
44
- # @!attribute [rw] closed_findings
45
- # The number of closed findings of each severity on the specified
46
- # date.
47
- # @return [Types::FindingMetricsValuePerSeverity]
48
- #
49
44
  # @!attribute [rw] date
50
45
  # The date from which the findings metrics were retrieved.
51
46
  # @return [Time]
52
47
  #
53
- # @!attribute [rw] mean_time_to_close
54
- # The average time in days it takes to close findings of each severity
55
- # as of a specified date.
56
- # @return [Types::FindingMetricsValuePerSeverity]
57
- #
58
48
  # @!attribute [rw] new_findings
59
49
  # The number of new findings of each severity on the specified date.
60
50
  # @return [Types::FindingMetricsValuePerSeverity]
61
51
  #
52
+ # @!attribute [rw] closed_findings
53
+ # The number of closed findings of each severity on the specified
54
+ # date.
55
+ # @return [Types::FindingMetricsValuePerSeverity]
56
+ #
62
57
  # @!attribute [rw] open_findings
63
58
  # The number of open findings of each severity as of the specified
64
59
  # date.
65
60
  # @return [Types::FindingMetricsValuePerSeverity]
66
61
  #
62
+ # @!attribute [rw] mean_time_to_close
63
+ # The average time in days it takes to close findings of each severity
64
+ # as of a specified date.
65
+ # @return [Types::FindingMetricsValuePerSeverity]
66
+ #
67
67
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/AccountFindingsMetric AWS API Documentation
68
68
  #
69
69
  class AccountFindingsMetric < Struct.new(
70
- :closed_findings,
71
70
  :date,
72
- :mean_time_to_close,
73
71
  :new_findings,
74
- :open_findings)
72
+ :closed_findings,
73
+ :open_findings,
74
+ :mean_time_to_close)
75
75
  SENSITIVE = []
76
76
  include Aws::Structure
77
77
  end
@@ -79,29 +79,29 @@ module Aws::CodeGuruSecurity
79
79
  # Contains information about the error that caused a finding to fail to
80
80
  # be retrieved.
81
81
  #
82
- # @!attribute [rw] error_code
83
- # A code associated with the type of error.
82
+ # @!attribute [rw] scan_name
83
+ # The name of the scan that generated the finding.
84
84
  # @return [String]
85
85
  #
86
86
  # @!attribute [rw] finding_id
87
87
  # The finding ID of the finding that was not fetched.
88
88
  # @return [String]
89
89
  #
90
- # @!attribute [rw] message
91
- # Describes the error.
90
+ # @!attribute [rw] error_code
91
+ # A code associated with the type of error.
92
92
  # @return [String]
93
93
  #
94
- # @!attribute [rw] scan_name
95
- # The name of the scan that generated the finding.
94
+ # @!attribute [rw] message
95
+ # Describes the error.
96
96
  # @return [String]
97
97
  #
98
98
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindingsError AWS API Documentation
99
99
  #
100
100
  class BatchGetFindingsError < Struct.new(
101
- :error_code,
101
+ :scan_name,
102
102
  :finding_id,
103
- :message,
104
- :scan_name)
103
+ :error_code,
104
+ :message)
105
105
  SENSITIVE = []
106
106
  include Aws::Structure
107
107
  end
@@ -120,21 +120,21 @@ module Aws::CodeGuruSecurity
120
120
  include Aws::Structure
121
121
  end
122
122
 
123
+ # @!attribute [rw] findings
124
+ # A list of all findings which were successfully fetched.
125
+ # @return [Array<Types::Finding>]
126
+ #
123
127
  # @!attribute [rw] failed_findings
124
128
  # A list of errors for individual findings which were not fetched.
125
129
  # Each BatchGetFindingsError contains the `scanName`, `findingId`,
126
130
  # `errorCode` and error `message`.
127
131
  # @return [Array<Types::BatchGetFindingsError>]
128
132
  #
129
- # @!attribute [rw] findings
130
- # A list of all findings which were successfully fetched.
131
- # @return [Array<Types::Finding>]
132
- #
133
133
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindingsResponse AWS API Documentation
134
134
  #
135
135
  class BatchGetFindingsResponse < Struct.new(
136
- :failed_findings,
137
- :findings)
136
+ :findings,
137
+ :failed_findings)
138
138
  SENSITIVE = []
139
139
  include Aws::Structure
140
140
  end
@@ -161,19 +161,19 @@ module Aws::CodeGuruSecurity
161
161
 
162
162
  # The line of code where a finding was detected.
163
163
  #
164
- # @!attribute [rw] content
165
- # The code that contains a vulnerability.
166
- # @return [String]
167
- #
168
164
  # @!attribute [rw] number
169
165
  # The code line number.
170
166
  # @return [Integer]
171
167
  #
168
+ # @!attribute [rw] content
169
+ # The code that contains a vulnerability.
170
+ # @return [String]
171
+ #
172
172
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CodeLine AWS API Documentation
173
173
  #
174
174
  class CodeLine < Struct.new(
175
- :content,
176
- :number)
175
+ :number,
176
+ :content)
177
177
  SENSITIVE = []
178
178
  include Aws::Structure
179
179
  end
@@ -209,14 +209,6 @@ module Aws::CodeGuruSecurity
209
209
  include Aws::Structure
210
210
  end
211
211
 
212
- # @!attribute [rw] analysis_type
213
- # The type of analysis you want CodeGuru Security to perform in the
214
- # scan, either `Security` or `All`. The `Security` type only generates
215
- # findings related to security. The `All` type generates both security
216
- # findings and quality findings. Defaults to `Security` type if
217
- # missing.
218
- # @return [String]
219
- #
220
212
  # @!attribute [rw] client_token
221
213
  # The idempotency token for the request. Amazon CodeGuru Security uses
222
214
  # this value to prevent the accidental creation of duplicate scans if
@@ -246,6 +238,14 @@ module Aws::CodeGuruSecurity
246
238
  # analyze your code.
247
239
  # @return [String]
248
240
  #
241
+ # @!attribute [rw] analysis_type
242
+ # The type of analysis you want CodeGuru Security to perform in the
243
+ # scan, either `Security` or `All`. The `Security` type only generates
244
+ # findings related to security. The `All` type generates both security
245
+ # findings and quality findings. Defaults to `Security` type if
246
+ # missing.
247
+ # @return [String]
248
+ #
249
249
  # @!attribute [rw] tags
250
250
  # An array of key-value pairs used to tag a scan. A tag is a custom
251
251
  # attribute label with two parts:
@@ -261,46 +261,46 @@ module Aws::CodeGuruSecurity
261
261
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateScanRequest AWS API Documentation
262
262
  #
263
263
  class CreateScanRequest < Struct.new(
264
- :analysis_type,
265
264
  :client_token,
266
265
  :resource_id,
267
266
  :scan_name,
268
267
  :scan_type,
268
+ :analysis_type,
269
269
  :tags)
270
270
  SENSITIVE = []
271
271
  include Aws::Structure
272
272
  end
273
273
 
274
- # @!attribute [rw] resource_id
275
- # The identifier for the resource object that contains resources that
276
- # were scanned.
277
- # @return [Types::ResourceId]
278
- #
279
- # @!attribute [rw] run_id
280
- # UUID that identifies the individual scan run.
281
- # @return [String]
282
- #
283
274
  # @!attribute [rw] scan_name
284
275
  # The name of the scan.
285
276
  # @return [String]
286
277
  #
287
- # @!attribute [rw] scan_name_arn
288
- # The ARN for the scan name.
278
+ # @!attribute [rw] run_id
279
+ # UUID that identifies the individual scan run.
289
280
  # @return [String]
290
281
  #
282
+ # @!attribute [rw] resource_id
283
+ # The identifier for the resource object that contains resources that
284
+ # were scanned.
285
+ # @return [Types::ResourceId]
286
+ #
291
287
  # @!attribute [rw] scan_state
292
288
  # The current state of the scan. Returns either `InProgress`,
293
289
  # `Successful`, or `Failed`.
294
290
  # @return [String]
295
291
  #
292
+ # @!attribute [rw] scan_name_arn
293
+ # The ARN for the scan name.
294
+ # @return [String]
295
+ #
296
296
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateScanResponse AWS API Documentation
297
297
  #
298
298
  class CreateScanResponse < Struct.new(
299
- :resource_id,
300
- :run_id,
301
299
  :scan_name,
302
- :scan_name_arn,
303
- :scan_state)
300
+ :run_id,
301
+ :resource_id,
302
+ :scan_state,
303
+ :scan_name_arn)
304
304
  SENSITIVE = []
305
305
  include Aws::Structure
306
306
  end
@@ -320,9 +320,9 @@ module Aws::CodeGuruSecurity
320
320
  include Aws::Structure
321
321
  end
322
322
 
323
- # @!attribute [rw] code_artifact_id
324
- # The identifier for the uploaded code resource. Pass this to
325
- # `CreateScan` to use the uploaded resources.
323
+ # @!attribute [rw] s3_url
324
+ # A pre-signed S3 URL. You can upload the code file you want to scan
325
+ # with the required `requestHeaders` using any HTTP client.
326
326
  # @return [String]
327
327
  #
328
328
  # @!attribute [rw] request_headers
@@ -330,18 +330,18 @@ module Aws::CodeGuruSecurity
330
330
  # uploading your resource.
331
331
  # @return [Hash<String,String>]
332
332
  #
333
- # @!attribute [rw] s3_url
334
- # A pre-signed S3 URL. You can upload the code file you want to scan
335
- # with the required `requestHeaders` using any HTTP client.
333
+ # @!attribute [rw] code_artifact_id
334
+ # The identifier for the uploaded code resource. Pass this to
335
+ # `CreateScan` to use the uploaded resources.
336
336
  # @return [String]
337
337
  #
338
338
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateUploadUrlResponse AWS API Documentation
339
339
  #
340
340
  class CreateUploadUrlResponse < Struct.new(
341
- :code_artifact_id,
341
+ :s3_url,
342
342
  :request_headers,
343
- :s3_url)
344
- SENSITIVE = [:request_headers, :s3_url]
343
+ :code_artifact_id)
344
+ SENSITIVE = [:s3_url, :request_headers]
345
345
  include Aws::Structure
346
346
  end
347
347
 
@@ -364,16 +364,6 @@ module Aws::CodeGuruSecurity
364
364
  # Information about the location of security vulnerabilities that Amazon
365
365
  # CodeGuru Security detected in your code.
366
366
  #
367
- # @!attribute [rw] code_snippet
368
- # A list of `CodeLine` objects that describe where the security
369
- # vulnerability appears in your code.
370
- # @return [Array<Types::CodeLine>]
371
- #
372
- # @!attribute [rw] end_line
373
- # The last line number of the code snippet where the security
374
- # vulnerability appears in your code.
375
- # @return [Integer]
376
- #
377
367
  # @!attribute [rw] name
378
368
  # The name of the file.
379
369
  # @return [String]
@@ -387,14 +377,24 @@ module Aws::CodeGuruSecurity
387
377
  # vulnerability appears in your code.
388
378
  # @return [Integer]
389
379
  #
380
+ # @!attribute [rw] end_line
381
+ # The last line number of the code snippet where the security
382
+ # vulnerability appears in your code.
383
+ # @return [Integer]
384
+ #
385
+ # @!attribute [rw] code_snippet
386
+ # A list of `CodeLine` objects that describe where the security
387
+ # vulnerability appears in your code.
388
+ # @return [Array<Types::CodeLine>]
389
+ #
390
390
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/FilePath AWS API Documentation
391
391
  #
392
392
  class FilePath < Struct.new(
393
- :code_snippet,
394
- :end_line,
395
393
  :name,
396
394
  :path,
397
- :start_line)
395
+ :start_line,
396
+ :end_line,
397
+ :code_snippet)
398
398
  SENSITIVE = []
399
399
  include Aws::Structure
400
400
  end
@@ -409,23 +409,6 @@ module Aws::CodeGuruSecurity
409
409
  # A description of the finding.
410
410
  # @return [String]
411
411
  #
412
- # @!attribute [rw] detector_id
413
- # The identifier for the detector that detected the finding in your
414
- # code. A detector is a defined rule based on industry standards and
415
- # AWS best practices.
416
- # @return [String]
417
- #
418
- # @!attribute [rw] detector_name
419
- # The name of the detector that identified the security vulnerability
420
- # in your code.
421
- # @return [String]
422
- #
423
- # @!attribute [rw] detector_tags
424
- # One or more tags or categorizations that are associated with a
425
- # detector. These tags are defined by type, programming language, or
426
- # other classification such as maintainability or consistency.
427
- # @return [Array<String>]
428
- #
429
412
  # @!attribute [rw] generator_id
430
413
  # The identifier for the component that generated a finding such as
431
414
  # AmazonCodeGuruSecurity.
@@ -435,18 +418,26 @@ module Aws::CodeGuruSecurity
435
418
  # The identifier for a finding.
436
419
  # @return [String]
437
420
  #
438
- # @!attribute [rw] remediation
439
- # An object that contains the details about how to remediate a
440
- # finding.
441
- # @return [Types::Remediation]
421
+ # @!attribute [rw] updated_at
422
+ # The time when the finding was last updated. Findings are updated
423
+ # when you remediate them or when the finding code location changes.
424
+ # @return [Time]
425
+ #
426
+ # @!attribute [rw] type
427
+ # The type of finding.
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] status
431
+ # The status of the finding. A finding status can be open or closed.
432
+ # @return [String]
442
433
  #
443
434
  # @!attribute [rw] resource
444
435
  # The resource where Amazon CodeGuru Security detected a finding.
445
436
  # @return [Types::Resource]
446
437
  #
447
- # @!attribute [rw] rule_id
448
- # The identifier for the rule that generated the finding.
449
- # @return [String]
438
+ # @!attribute [rw] vulnerability
439
+ # An object that describes the detected security vulnerability.
440
+ # @return [Types::Vulnerability]
450
441
  #
451
442
  # @!attribute [rw] severity
452
443
  # The severity of the finding. Severity can be critical, high, medium,
@@ -458,46 +449,55 @@ module Aws::CodeGuruSecurity
458
449
  # [1]: https://docs.aws.amazon.com/codeguru/latest/security-ug/findings-overview.html#severity-distribution
459
450
  # @return [String]
460
451
  #
461
- # @!attribute [rw] status
462
- # The status of the finding. A finding status can be open or closed.
463
- # @return [String]
452
+ # @!attribute [rw] remediation
453
+ # An object that contains the details about how to remediate a
454
+ # finding.
455
+ # @return [Types::Remediation]
464
456
  #
465
457
  # @!attribute [rw] title
466
458
  # The title of the finding.
467
459
  # @return [String]
468
460
  #
469
- # @!attribute [rw] type
470
- # The type of finding.
461
+ # @!attribute [rw] detector_tags
462
+ # One or more tags or categorizations that are associated with a
463
+ # detector. These tags are defined by type, programming language, or
464
+ # other classification such as maintainability or consistency.
465
+ # @return [Array<String>]
466
+ #
467
+ # @!attribute [rw] detector_id
468
+ # The identifier for the detector that detected the finding in your
469
+ # code. A detector is a defined rule based on industry standards and
470
+ # AWS best practices.
471
471
  # @return [String]
472
472
  #
473
- # @!attribute [rw] updated_at
474
- # The time when the finding was last updated. Findings are updated
475
- # when you remediate them or when the finding code location changes.
476
- # @return [Time]
473
+ # @!attribute [rw] detector_name
474
+ # The name of the detector that identified the security vulnerability
475
+ # in your code.
476
+ # @return [String]
477
477
  #
478
- # @!attribute [rw] vulnerability
479
- # An object that describes the detected security vulnerability.
480
- # @return [Types::Vulnerability]
478
+ # @!attribute [rw] rule_id
479
+ # The identifier for the rule that generated the finding.
480
+ # @return [String]
481
481
  #
482
482
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Finding AWS API Documentation
483
483
  #
484
484
  class Finding < Struct.new(
485
485
  :created_at,
486
486
  :description,
487
- :detector_id,
488
- :detector_name,
489
- :detector_tags,
490
487
  :generator_id,
491
488
  :id,
492
- :remediation,
489
+ :updated_at,
490
+ :type,
491
+ :status,
493
492
  :resource,
494
- :rule_id,
493
+ :vulnerability,
495
494
  :severity,
496
- :status,
495
+ :remediation,
497
496
  :title,
498
- :type,
499
- :updated_at,
500
- :vulnerability)
497
+ :detector_tags,
498
+ :detector_id,
499
+ :detector_name,
500
+ :rule_id)
501
501
  SENSITIVE = []
502
502
  include Aws::Structure
503
503
  end
@@ -505,19 +505,19 @@ module Aws::CodeGuruSecurity
505
505
  # An object that contains information about a finding and the scan that
506
506
  # generated it.
507
507
  #
508
- # @!attribute [rw] finding_id
509
- # The identifier for a finding.
510
- # @return [String]
511
- #
512
508
  # @!attribute [rw] scan_name
513
509
  # The name of the scan that generated the finding.
514
510
  # @return [String]
515
511
  #
512
+ # @!attribute [rw] finding_id
513
+ # The identifier for a finding.
514
+ # @return [String]
515
+ #
516
516
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/FindingIdentifier AWS API Documentation
517
517
  #
518
518
  class FindingIdentifier < Struct.new(
519
- :finding_id,
520
- :scan_name)
519
+ :scan_name,
520
+ :finding_id)
521
521
  SENSITIVE = []
522
522
  include Aws::Structure
523
523
  end
@@ -526,14 +526,6 @@ module Aws::CodeGuruSecurity
526
526
  # the number of open findings or the average time it takes to close
527
527
  # findings of a given severity.
528
528
  #
529
- # @!attribute [rw] critical
530
- # A numeric value corresponding to a critical finding.
531
- # @return [Float]
532
- #
533
- # @!attribute [rw] high
534
- # A numeric value corresponding to a high severity finding.
535
- # @return [Float]
536
- #
537
529
  # @!attribute [rw] info
538
530
  # A numeric value corresponding to an informational finding.
539
531
  # @return [Float]
@@ -546,14 +538,22 @@ module Aws::CodeGuruSecurity
546
538
  # A numeric value corresponding to a medium severity finding.
547
539
  # @return [Float]
548
540
  #
541
+ # @!attribute [rw] high
542
+ # A numeric value corresponding to a high severity finding.
543
+ # @return [Float]
544
+ #
545
+ # @!attribute [rw] critical
546
+ # A numeric value corresponding to a critical finding.
547
+ # @return [Float]
548
+ #
549
549
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/FindingMetricsValuePerSeverity AWS API Documentation
550
550
  #
551
551
  class FindingMetricsValuePerSeverity < Struct.new(
552
- :critical,
553
- :high,
554
552
  :info,
555
553
  :low,
556
- :medium)
554
+ :medium,
555
+ :high,
556
+ :critical)
557
557
  SENSITIVE = []
558
558
  include Aws::Structure
559
559
  end
@@ -580,13 +580,9 @@ module Aws::CodeGuruSecurity
580
580
  include Aws::Structure
581
581
  end
582
582
 
583
- # @!attribute [rw] max_results
584
- # The maximum number of results to return in the response. Use this
585
- # parameter when paginating results. If additional results exist
586
- # beyond the number you specify, the `nextToken` element is returned
587
- # in the response. Use `nextToken` in a subsequent request to retrieve
588
- # additional results. If not specified, returns 1000 results.
589
- # @return [Integer]
583
+ # @!attribute [rw] scan_name
584
+ # The name of the scan you want to retrieve findings from.
585
+ # @return [String]
590
586
  #
591
587
  # @!attribute [rw] next_token
592
588
  # A token to use for paginating results that are returned in the
@@ -596,9 +592,13 @@ module Aws::CodeGuruSecurity
596
592
  # first page.
597
593
  # @return [String]
598
594
  #
599
- # @!attribute [rw] scan_name
600
- # The name of the scan you want to retrieve findings from.
601
- # @return [String]
595
+ # @!attribute [rw] max_results
596
+ # The maximum number of results to return in the response. Use this
597
+ # parameter when paginating results. If additional results exist
598
+ # beyond the number you specify, the `nextToken` element is returned
599
+ # in the response. Use `nextToken` in a subsequent request to retrieve
600
+ # additional results. If not specified, returns 1000 results.
601
+ # @return [Integer]
602
602
  #
603
603
  # @!attribute [rw] status
604
604
  # The status of the findings you want to get. Pass either `Open`,
@@ -608,9 +608,9 @@ module Aws::CodeGuruSecurity
608
608
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetFindingsRequest AWS API Documentation
609
609
  #
610
610
  class GetFindingsRequest < Struct.new(
611
- :max_results,
612
- :next_token,
613
611
  :scan_name,
612
+ :next_token,
613
+ :max_results,
614
614
  :status)
615
615
  SENSITIVE = []
616
616
  include Aws::Structure
@@ -659,25 +659,42 @@ module Aws::CodeGuruSecurity
659
659
  include Aws::Structure
660
660
  end
661
661
 
662
+ # @!attribute [rw] scan_name
663
+ # The name of the scan you want to view details about.
664
+ # @return [String]
665
+ #
662
666
  # @!attribute [rw] run_id
663
667
  # UUID that identifies the individual scan run you want to view
664
668
  # details about. You retrieve this when you call the `CreateScan`
665
669
  # operation. Defaults to the latest scan run if missing.
666
670
  # @return [String]
667
671
  #
668
- # @!attribute [rw] scan_name
669
- # The name of the scan you want to view details about.
670
- # @return [String]
671
- #
672
672
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetScanRequest AWS API Documentation
673
673
  #
674
674
  class GetScanRequest < Struct.new(
675
- :run_id,
676
- :scan_name)
675
+ :scan_name,
676
+ :run_id)
677
677
  SENSITIVE = []
678
678
  include Aws::Structure
679
679
  end
680
680
 
681
+ # @!attribute [rw] scan_name
682
+ # The name of the scan.
683
+ # @return [String]
684
+ #
685
+ # @!attribute [rw] run_id
686
+ # UUID that identifies the individual scan run.
687
+ # @return [String]
688
+ #
689
+ # @!attribute [rw] scan_state
690
+ # The current state of the scan. Returns either `InProgress`,
691
+ # `Successful`, or `Failed`.
692
+ # @return [String]
693
+ #
694
+ # @!attribute [rw] created_at
695
+ # The time the scan was created.
696
+ # @return [Time]
697
+ #
681
698
  # @!attribute [rw] analysis_type
682
699
  # The type of analysis CodeGuru Security performed in the scan, either
683
700
  # `Security` or `All`. The `Security` type only generates findings
@@ -685,52 +702,35 @@ module Aws::CodeGuruSecurity
685
702
  # and quality findings.
686
703
  # @return [String]
687
704
  #
688
- # @!attribute [rw] created_at
689
- # The time the scan was created.
705
+ # @!attribute [rw] updated_at
706
+ # The time when the scan was last updated. Only available for
707
+ # `STANDARD` scan types.
690
708
  # @return [Time]
691
709
  #
692
- # @!attribute [rw] error_message
693
- # Details about the error that causes a scan to fail to be retrieved.
694
- # @return [String]
695
- #
696
710
  # @!attribute [rw] number_of_revisions
697
711
  # The number of times a scan has been re-run on a revised resource.
698
712
  # @return [Integer]
699
713
  #
700
- # @!attribute [rw] run_id
701
- # UUID that identifies the individual scan run.
702
- # @return [String]
703
- #
704
- # @!attribute [rw] scan_name
705
- # The name of the scan.
706
- # @return [String]
707
- #
708
714
  # @!attribute [rw] scan_name_arn
709
715
  # The ARN for the scan name.
710
716
  # @return [String]
711
717
  #
712
- # @!attribute [rw] scan_state
713
- # The current state of the scan. Returns either `InProgress`,
714
- # `Successful`, or `Failed`.
718
+ # @!attribute [rw] error_message
719
+ # Details about the error that causes a scan to fail to be retrieved.
715
720
  # @return [String]
716
721
  #
717
- # @!attribute [rw] updated_at
718
- # The time when the scan was last updated. Only available for
719
- # `STANDARD` scan types.
720
- # @return [Time]
721
- #
722
722
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetScanResponse AWS API Documentation
723
723
  #
724
724
  class GetScanResponse < Struct.new(
725
- :analysis_type,
725
+ :scan_name,
726
+ :run_id,
727
+ :scan_state,
726
728
  :created_at,
727
- :error_message,
729
+ :analysis_type,
730
+ :updated_at,
728
731
  :number_of_revisions,
729
- :run_id,
730
- :scan_name,
731
732
  :scan_name_arn,
732
- :scan_state,
733
- :updated_at)
733
+ :error_message)
734
734
  SENSITIVE = []
735
735
  include Aws::Structure
736
736
  end
@@ -755,10 +755,13 @@ module Aws::CodeGuruSecurity
755
755
  include Aws::Structure
756
756
  end
757
757
 
758
- # @!attribute [rw] end_date
759
- # The end date of the interval which you want to retrieve metrics
760
- # from. Round to the nearest day.
761
- # @return [Time]
758
+ # @!attribute [rw] next_token
759
+ # A token to use for paginating results that are returned in the
760
+ # response. Set the value of this parameter to null for the first
761
+ # request. For subsequent calls, use the `nextToken` value returned
762
+ # from the previous request to continue listing results after the
763
+ # first page.
764
+ # @return [String]
762
765
  #
763
766
  # @!attribute [rw] max_results
764
767
  # The maximum number of results to return in the response. Use this
@@ -768,26 +771,23 @@ module Aws::CodeGuruSecurity
768
771
  # additional results. If not specified, returns 1000 results.
769
772
  # @return [Integer]
770
773
  #
771
- # @!attribute [rw] next_token
772
- # A token to use for paginating results that are returned in the
773
- # response. Set the value of this parameter to null for the first
774
- # request. For subsequent calls, use the `nextToken` value returned
775
- # from the previous request to continue listing results after the
776
- # first page.
777
- # @return [String]
778
- #
779
774
  # @!attribute [rw] start_date
780
775
  # The start date of the interval which you want to retrieve metrics
781
776
  # from. Rounds to the nearest day.
782
777
  # @return [Time]
783
778
  #
779
+ # @!attribute [rw] end_date
780
+ # The end date of the interval which you want to retrieve metrics
781
+ # from. Round to the nearest day.
782
+ # @return [Time]
783
+ #
784
784
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListFindingsMetricsRequest AWS API Documentation
785
785
  #
786
786
  class ListFindingsMetricsRequest < Struct.new(
787
- :end_date,
788
- :max_results,
789
787
  :next_token,
790
- :start_date)
788
+ :max_results,
789
+ :start_date,
790
+ :end_date)
791
791
  SENSITIVE = []
792
792
  include Aws::Structure
793
793
  end
@@ -812,14 +812,6 @@ module Aws::CodeGuruSecurity
812
812
  include Aws::Structure
813
813
  end
814
814
 
815
- # @!attribute [rw] max_results
816
- # The maximum number of results to return in the response. Use this
817
- # parameter when paginating results. If additional results exist
818
- # beyond the number you specify, the `nextToken` element is returned
819
- # in the response. Use `nextToken` in a subsequent request to retrieve
820
- # additional results. If not specified, returns 100 results.
821
- # @return [Integer]
822
- #
823
815
  # @!attribute [rw] next_token
824
816
  # A token to use for paginating results that are returned in the
825
817
  # response. Set the value of this parameter to null for the first
@@ -828,30 +820,38 @@ module Aws::CodeGuruSecurity
828
820
  # first page.
829
821
  # @return [String]
830
822
  #
823
+ # @!attribute [rw] max_results
824
+ # The maximum number of results to return in the response. Use this
825
+ # parameter when paginating results. If additional results exist
826
+ # beyond the number you specify, the `nextToken` element is returned
827
+ # in the response. Use `nextToken` in a subsequent request to retrieve
828
+ # additional results. If not specified, returns 100 results.
829
+ # @return [Integer]
830
+ #
831
831
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListScansRequest AWS API Documentation
832
832
  #
833
833
  class ListScansRequest < Struct.new(
834
- :max_results,
835
- :next_token)
834
+ :next_token,
835
+ :max_results)
836
836
  SENSITIVE = []
837
837
  include Aws::Structure
838
838
  end
839
839
 
840
- # @!attribute [rw] next_token
841
- # A pagination token. You can use this in future calls to `ListScans`
842
- # to continue listing results after the current page.
843
- # @return [String]
844
- #
845
840
  # @!attribute [rw] summaries
846
841
  # A list of `ScanSummary` objects with information about all scans in
847
842
  # an account.
848
843
  # @return [Array<Types::ScanSummary>]
849
844
  #
845
+ # @!attribute [rw] next_token
846
+ # A pagination token. You can use this in future calls to `ListScans`
847
+ # to continue listing results after the current page.
848
+ # @return [String]
849
+ #
850
850
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListScansResponse AWS API Documentation
851
851
  #
852
852
  class ListScansResponse < Struct.new(
853
- :next_token,
854
- :summaries)
853
+ :summaries,
854
+ :next_token)
855
855
  SENSITIVE = []
856
856
  include Aws::Structure
857
857
  end
@@ -891,11 +891,6 @@ module Aws::CodeGuruSecurity
891
891
 
892
892
  # A summary of metrics for an account as of a specified date.
893
893
  #
894
- # @!attribute [rw] categories_with_most_findings
895
- # A list of `CategoryWithFindingNum` objects for the top 5 finding
896
- # categories with the most findings.
897
- # @return [Array<Types::CategoryWithFindingNum>]
898
- #
899
894
  # @!attribute [rw] date
900
895
  # The date from which the metrics summary information was retrieved.
901
896
  # @return [Time]
@@ -904,24 +899,29 @@ module Aws::CodeGuruSecurity
904
899
  # The number of open findings of each severity.
905
900
  # @return [Types::FindingMetricsValuePerSeverity]
906
901
  #
907
- # @!attribute [rw] scans_with_most_open_critical_findings
908
- # A list of `ScanNameWithFindingNum` objects for the top 3 scans with
909
- # the most number of open critical findings.
910
- # @return [Array<Types::ScanNameWithFindingNum>]
902
+ # @!attribute [rw] categories_with_most_findings
903
+ # A list of `CategoryWithFindingNum` objects for the top 5 finding
904
+ # categories with the most findings.
905
+ # @return [Array<Types::CategoryWithFindingNum>]
911
906
  #
912
907
  # @!attribute [rw] scans_with_most_open_findings
913
908
  # A list of `ScanNameWithFindingNum` objects for the top 3 scans with
914
909
  # the most number of open findings.
915
910
  # @return [Array<Types::ScanNameWithFindingNum>]
916
911
  #
912
+ # @!attribute [rw] scans_with_most_open_critical_findings
913
+ # A list of `ScanNameWithFindingNum` objects for the top 3 scans with
914
+ # the most number of open critical findings.
915
+ # @return [Array<Types::ScanNameWithFindingNum>]
916
+ #
917
917
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/MetricsSummary AWS API Documentation
918
918
  #
919
919
  class MetricsSummary < Struct.new(
920
- :categories_with_most_findings,
921
920
  :date,
922
921
  :open_findings,
923
- :scans_with_most_open_critical_findings,
924
- :scans_with_most_open_findings)
922
+ :categories_with_most_findings,
923
+ :scans_with_most_open_findings,
924
+ :scans_with_most_open_critical_findings)
925
925
  SENSITIVE = []
926
926
  include Aws::Structure
927
927
  end
@@ -1043,81 +1043,81 @@ module Aws::CodeGuruSecurity
1043
1043
 
1044
1044
  # Information about the number of findings generated by a scan.
1045
1045
  #
1046
- # @!attribute [rw] finding_number
1047
- # The number of findings generated by a scan.
1048
- # @return [Integer]
1049
- #
1050
1046
  # @!attribute [rw] scan_name
1051
1047
  # The name of the scan.
1052
1048
  # @return [String]
1053
1049
  #
1050
+ # @!attribute [rw] finding_number
1051
+ # The number of findings generated by a scan.
1052
+ # @return [Integer]
1053
+ #
1054
1054
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ScanNameWithFindingNum AWS API Documentation
1055
1055
  #
1056
1056
  class ScanNameWithFindingNum < Struct.new(
1057
- :finding_number,
1058
- :scan_name)
1057
+ :scan_name,
1058
+ :finding_number)
1059
1059
  SENSITIVE = []
1060
1060
  include Aws::Structure
1061
1061
  end
1062
1062
 
1063
1063
  # Information about a scan.
1064
1064
  #
1065
+ # @!attribute [rw] scan_state
1066
+ # The state of the scan. A scan can be `In Progress`, `Complete`, or
1067
+ # `Failed`.
1068
+ # @return [String]
1069
+ #
1065
1070
  # @!attribute [rw] created_at
1066
1071
  # The time when the scan was created.
1067
1072
  # @return [Time]
1068
1073
  #
1069
- # @!attribute [rw] run_id
1070
- # The identifier for the scan run.
1071
- # @return [String]
1074
+ # @!attribute [rw] updated_at
1075
+ # The time the scan was last updated. A scan is updated when it is
1076
+ # re-run.
1077
+ # @return [Time]
1072
1078
  #
1073
1079
  # @!attribute [rw] scan_name
1074
1080
  # The name of the scan.
1075
1081
  # @return [String]
1076
1082
  #
1077
- # @!attribute [rw] scan_name_arn
1078
- # The ARN for the scan name.
1083
+ # @!attribute [rw] run_id
1084
+ # The identifier for the scan run.
1079
1085
  # @return [String]
1080
1086
  #
1081
- # @!attribute [rw] scan_state
1082
- # The state of the scan. A scan can be `In Progress`, `Complete`, or
1083
- # `Failed`.
1087
+ # @!attribute [rw] scan_name_arn
1088
+ # The ARN for the scan name.
1084
1089
  # @return [String]
1085
1090
  #
1086
- # @!attribute [rw] updated_at
1087
- # The time the scan was last updated. A scan is updated when it is
1088
- # re-run.
1089
- # @return [Time]
1090
- #
1091
1091
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ScanSummary AWS API Documentation
1092
1092
  #
1093
1093
  class ScanSummary < Struct.new(
1094
+ :scan_state,
1094
1095
  :created_at,
1095
- :run_id,
1096
+ :updated_at,
1096
1097
  :scan_name,
1097
- :scan_name_arn,
1098
- :scan_state,
1099
- :updated_at)
1098
+ :run_id,
1099
+ :scan_name_arn)
1100
1100
  SENSITIVE = []
1101
1101
  include Aws::Structure
1102
1102
  end
1103
1103
 
1104
1104
  # Information about the suggested code fix to remediate a finding.
1105
1105
  #
1106
- # @!attribute [rw] code
1107
- # The suggested code fix. If applicable, includes code patch to
1108
- # replace your source code.
1109
- # @return [String]
1110
- #
1111
1106
  # @!attribute [rw] description
1112
1107
  # A description of the suggested code fix and why it is being
1113
1108
  # suggested.
1114
1109
  # @return [String]
1115
1110
  #
1111
+ # @!attribute [rw] code
1112
+ # The suggested code fix. If applicable, includes code patch to
1113
+ # replace your source code.
1114
+ # @return [String]
1115
+ #
1116
1116
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/SuggestedFix AWS API Documentation
1117
1117
  #
1118
1118
  class SuggestedFix < Struct.new(
1119
- :code,
1120
- :description)
1119
+ :description,
1120
+ :code)
1121
1121
  SENSITIVE = []
1122
1122
  include Aws::Structure
1123
1123
  end
@@ -1162,21 +1162,21 @@ module Aws::CodeGuruSecurity
1162
1162
  # Description of the error.
1163
1163
  # @return [String]
1164
1164
  #
1165
- # @!attribute [rw] quota_code
1166
- # The identifier for the originating quota.
1167
- # @return [String]
1168
- #
1169
1165
  # @!attribute [rw] service_code
1170
1166
  # The identifier for the originating service.
1171
1167
  # @return [String]
1172
1168
  #
1169
+ # @!attribute [rw] quota_code
1170
+ # The identifier for the originating quota.
1171
+ # @return [String]
1172
+ #
1173
1173
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ThrottlingException AWS API Documentation
1174
1174
  #
1175
1175
  class ThrottlingException < Struct.new(
1176
1176
  :error_code,
1177
1177
  :message,
1178
- :quota_code,
1179
- :service_code)
1178
+ :service_code,
1179
+ :quota_code)
1180
1180
  SENSITIVE = []
1181
1181
  include Aws::Structure
1182
1182
  end
@@ -1239,10 +1239,6 @@ module Aws::CodeGuruSecurity
1239
1239
  # The identifier for the error.
1240
1240
  # @return [String]
1241
1241
  #
1242
- # @!attribute [rw] field_list
1243
- # The field that caused the error, if applicable.
1244
- # @return [Array<Types::ValidationExceptionField>]
1245
- #
1246
1242
  # @!attribute [rw] message
1247
1243
  # Description of the error.
1248
1244
  # @return [String]
@@ -1251,32 +1247,36 @@ module Aws::CodeGuruSecurity
1251
1247
  # The reason the request failed validation.
1252
1248
  # @return [String]
1253
1249
  #
1250
+ # @!attribute [rw] field_list
1251
+ # The field that caused the error, if applicable.
1252
+ # @return [Array<Types::ValidationExceptionField>]
1253
+ #
1254
1254
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ValidationException AWS API Documentation
1255
1255
  #
1256
1256
  class ValidationException < Struct.new(
1257
1257
  :error_code,
1258
- :field_list,
1259
1258
  :message,
1260
- :reason)
1259
+ :reason,
1260
+ :field_list)
1261
1261
  SENSITIVE = []
1262
1262
  include Aws::Structure
1263
1263
  end
1264
1264
 
1265
1265
  # Information about a validation exception.
1266
1266
  #
1267
- # @!attribute [rw] message
1268
- # Describes the exception.
1269
- # @return [String]
1270
- #
1271
1267
  # @!attribute [rw] name
1272
1268
  # The name of the exception.
1273
1269
  # @return [String]
1274
1270
  #
1271
+ # @!attribute [rw] message
1272
+ # Describes the exception.
1273
+ # @return [String]
1274
+ #
1275
1275
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ValidationExceptionField AWS API Documentation
1276
1276
  #
1277
1277
  class ValidationExceptionField < Struct.new(
1278
- :message,
1279
- :name)
1278
+ :name,
1279
+ :message)
1280
1280
  SENSITIVE = []
1281
1281
  include Aws::Structure
1282
1282
  end
@@ -1284,19 +1284,6 @@ module Aws::CodeGuruSecurity
1284
1284
  # Information about a security vulnerability that Amazon CodeGuru
1285
1285
  # Security detected.
1286
1286
  #
1287
- # @!attribute [rw] file_path
1288
- # An object that describes the location of the detected security
1289
- # vulnerability in your code.
1290
- # @return [Types::FilePath]
1291
- #
1292
- # @!attribute [rw] id
1293
- # The identifier for the vulnerability.
1294
- # @return [String]
1295
- #
1296
- # @!attribute [rw] item_count
1297
- # The number of times the vulnerability appears in your code.
1298
- # @return [Integer]
1299
- #
1300
1287
  # @!attribute [rw] reference_urls
1301
1288
  # One or more URL addresses that contain details about a
1302
1289
  # vulnerability.
@@ -1307,14 +1294,27 @@ module Aws::CodeGuruSecurity
1307
1294
  # being described.
1308
1295
  # @return [Array<String>]
1309
1296
  #
1297
+ # @!attribute [rw] id
1298
+ # The identifier for the vulnerability.
1299
+ # @return [String]
1300
+ #
1301
+ # @!attribute [rw] file_path
1302
+ # An object that describes the location of the detected security
1303
+ # vulnerability in your code.
1304
+ # @return [Types::FilePath]
1305
+ #
1306
+ # @!attribute [rw] item_count
1307
+ # The number of times the vulnerability appears in your code.
1308
+ # @return [Integer]
1309
+ #
1310
1310
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Vulnerability AWS API Documentation
1311
1311
  #
1312
1312
  class Vulnerability < Struct.new(
1313
- :file_path,
1314
- :id,
1315
- :item_count,
1316
1313
  :reference_urls,
1317
- :related_vulnerabilities)
1314
+ :related_vulnerabilities,
1315
+ :id,
1316
+ :file_path,
1317
+ :item_count)
1318
1318
  SENSITIVE = []
1319
1319
  include Aws::Structure
1320
1320
  end