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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-codegurusecurity/client.rb +145 -145
- data/lib/aws-sdk-codegurusecurity/client_api.rb +66 -66
- data/lib/aws-sdk-codegurusecurity/errors.rb +9 -9
- data/lib/aws-sdk-codegurusecurity/types.rb +297 -297
- data/lib/aws-sdk-codegurusecurity/waiters.rb +15 -0
- data/lib/aws-sdk-codegurusecurity.rb +2 -1
- data/sig/client.rbs +25 -25
- data/sig/errors.rbs +2 -2
- data/sig/types.rbs +53 -53
- metadata +4 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9b3ba5a9b0ec89ac7093b18e2468cde6e06e2b04cc551fec9bf1e79653ea3ea0
|
4
|
+
data.tar.gz: e5f058e752ce5faca679ab7c9d6ebf4b853e0bcc3660370438723e3137f79b27
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c65932cca4dad60d01b9bb75d75223ee54a9b6914759c4dddbc0baeeb33aaa17fc8484e602a67436b912a7daa7b67c4d354d4a1dafd3082d221286d7541a06b1
|
7
|
+
data.tar.gz: c1346de4838011666ebfe35dd67e17c479dc4dd3544277730bc9590de285956d0a2210a284662cae9cc8265a193cec12b494cab44f3ec8873b17bf06c0e1c85b
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.34.0
|
@@ -485,62 +485,62 @@ module Aws::CodeGuruSecurity
|
|
485
485
|
#
|
486
486
|
# @return [Types::BatchGetFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
487
487
|
#
|
488
|
-
# * {Types::BatchGetFindingsResponse#failed_findings #failed_findings} => Array<Types::BatchGetFindingsError>
|
489
488
|
# * {Types::BatchGetFindingsResponse#findings #findings} => Array<Types::Finding>
|
489
|
+
# * {Types::BatchGetFindingsResponse#failed_findings #failed_findings} => Array<Types::BatchGetFindingsError>
|
490
490
|
#
|
491
491
|
# @example Request syntax with placeholder values
|
492
492
|
#
|
493
493
|
# resp = client.batch_get_findings({
|
494
494
|
# finding_identifiers: [ # required
|
495
495
|
# {
|
496
|
-
# finding_id: "String", # required
|
497
496
|
# scan_name: "String", # required
|
497
|
+
# finding_id: "String", # required
|
498
498
|
# },
|
499
499
|
# ],
|
500
500
|
# })
|
501
501
|
#
|
502
502
|
# @example Response structure
|
503
503
|
#
|
504
|
-
# resp.failed_findings #=> Array
|
505
|
-
# resp.failed_findings[0].error_code #=> String, one of "DUPLICATE_IDENTIFIER", "ITEM_DOES_NOT_EXIST", "INTERNAL_ERROR", "INVALID_FINDING_ID", "INVALID_SCAN_NAME"
|
506
|
-
# resp.failed_findings[0].finding_id #=> String
|
507
|
-
# resp.failed_findings[0].message #=> String
|
508
|
-
# resp.failed_findings[0].scan_name #=> String
|
509
504
|
# resp.findings #=> Array
|
510
505
|
# resp.findings[0].created_at #=> Time
|
511
506
|
# resp.findings[0].description #=> String
|
512
|
-
# resp.findings[0].detector_id #=> String
|
513
|
-
# resp.findings[0].detector_name #=> String
|
514
|
-
# resp.findings[0].detector_tags #=> Array
|
515
|
-
# resp.findings[0].detector_tags[0] #=> String
|
516
507
|
# resp.findings[0].generator_id #=> String
|
517
508
|
# resp.findings[0].id #=> String
|
518
|
-
# resp.findings[0].
|
519
|
-
# resp.findings[0].
|
520
|
-
# resp.findings[0].
|
521
|
-
# resp.findings[0].remediation.suggested_fixes[0].code #=> String
|
522
|
-
# resp.findings[0].remediation.suggested_fixes[0].description #=> String
|
509
|
+
# resp.findings[0].updated_at #=> Time
|
510
|
+
# resp.findings[0].type #=> String
|
511
|
+
# resp.findings[0].status #=> String, one of "Closed", "Open", "All"
|
523
512
|
# resp.findings[0].resource.id #=> String
|
524
513
|
# resp.findings[0].resource.sub_resource_id #=> String
|
525
|
-
# resp.findings[0].rule_id #=> String
|
526
|
-
# resp.findings[0].severity #=> String, one of "Critical", "High", "Medium", "Low", "Info"
|
527
|
-
# resp.findings[0].status #=> String, one of "Closed", "Open", "All"
|
528
|
-
# resp.findings[0].title #=> String
|
529
|
-
# resp.findings[0].type #=> String
|
530
|
-
# resp.findings[0].updated_at #=> Time
|
531
|
-
# resp.findings[0].vulnerability.file_path.code_snippet #=> Array
|
532
|
-
# resp.findings[0].vulnerability.file_path.code_snippet[0].content #=> String
|
533
|
-
# resp.findings[0].vulnerability.file_path.code_snippet[0].number #=> Integer
|
534
|
-
# resp.findings[0].vulnerability.file_path.end_line #=> Integer
|
535
|
-
# resp.findings[0].vulnerability.file_path.name #=> String
|
536
|
-
# resp.findings[0].vulnerability.file_path.path #=> String
|
537
|
-
# resp.findings[0].vulnerability.file_path.start_line #=> Integer
|
538
|
-
# resp.findings[0].vulnerability.id #=> String
|
539
|
-
# resp.findings[0].vulnerability.item_count #=> Integer
|
540
514
|
# resp.findings[0].vulnerability.reference_urls #=> Array
|
541
515
|
# resp.findings[0].vulnerability.reference_urls[0] #=> String
|
542
516
|
# resp.findings[0].vulnerability.related_vulnerabilities #=> Array
|
543
517
|
# resp.findings[0].vulnerability.related_vulnerabilities[0] #=> String
|
518
|
+
# resp.findings[0].vulnerability.id #=> String
|
519
|
+
# resp.findings[0].vulnerability.file_path.name #=> String
|
520
|
+
# resp.findings[0].vulnerability.file_path.path #=> String
|
521
|
+
# resp.findings[0].vulnerability.file_path.start_line #=> Integer
|
522
|
+
# resp.findings[0].vulnerability.file_path.end_line #=> Integer
|
523
|
+
# resp.findings[0].vulnerability.file_path.code_snippet #=> Array
|
524
|
+
# resp.findings[0].vulnerability.file_path.code_snippet[0].number #=> Integer
|
525
|
+
# resp.findings[0].vulnerability.file_path.code_snippet[0].content #=> String
|
526
|
+
# resp.findings[0].vulnerability.item_count #=> Integer
|
527
|
+
# resp.findings[0].severity #=> String, one of "Critical", "High", "Medium", "Low", "Info"
|
528
|
+
# resp.findings[0].remediation.recommendation.text #=> String
|
529
|
+
# resp.findings[0].remediation.recommendation.url #=> String
|
530
|
+
# resp.findings[0].remediation.suggested_fixes #=> Array
|
531
|
+
# resp.findings[0].remediation.suggested_fixes[0].description #=> String
|
532
|
+
# resp.findings[0].remediation.suggested_fixes[0].code #=> String
|
533
|
+
# resp.findings[0].title #=> String
|
534
|
+
# resp.findings[0].detector_tags #=> Array
|
535
|
+
# resp.findings[0].detector_tags[0] #=> String
|
536
|
+
# resp.findings[0].detector_id #=> String
|
537
|
+
# resp.findings[0].detector_name #=> String
|
538
|
+
# resp.findings[0].rule_id #=> String
|
539
|
+
# resp.failed_findings #=> Array
|
540
|
+
# resp.failed_findings[0].scan_name #=> String
|
541
|
+
# resp.failed_findings[0].finding_id #=> String
|
542
|
+
# resp.failed_findings[0].error_code #=> String, one of "DUPLICATE_IDENTIFIER", "ITEM_DOES_NOT_EXIST", "INTERNAL_ERROR", "INVALID_FINDING_ID", "INVALID_SCAN_NAME"
|
543
|
+
# resp.failed_findings[0].message #=> String
|
544
544
|
#
|
545
545
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindings AWS API Documentation
|
546
546
|
#
|
@@ -553,12 +553,6 @@ module Aws::CodeGuruSecurity
|
|
553
553
|
|
554
554
|
# Use to create a scan using code uploaded to an Amazon S3 bucket.
|
555
555
|
#
|
556
|
-
# @option params [String] :analysis_type
|
557
|
-
# The type of analysis you want CodeGuru Security to perform in the
|
558
|
-
# scan, either `Security` or `All`. The `Security` type only generates
|
559
|
-
# findings related to security. The `All` type generates both security
|
560
|
-
# findings and quality findings. Defaults to `Security` type if missing.
|
561
|
-
#
|
562
556
|
# @option params [String] :client_token
|
563
557
|
# The idempotency token for the request. Amazon CodeGuru Security uses
|
564
558
|
# this value to prevent the accidental creation of duplicate scans if
|
@@ -584,6 +578,12 @@ module Aws::CodeGuruSecurity
|
|
584
578
|
# have standard resource limits and use the full set of detectors to
|
585
579
|
# analyze your code.
|
586
580
|
#
|
581
|
+
# @option params [String] :analysis_type
|
582
|
+
# The type of analysis you want CodeGuru Security to perform in the
|
583
|
+
# scan, either `Security` or `All`. The `Security` type only generates
|
584
|
+
# findings related to security. The `All` type generates both security
|
585
|
+
# findings and quality findings. Defaults to `Security` type if missing.
|
586
|
+
#
|
587
587
|
# @option params [Hash<String,String>] :tags
|
588
588
|
# An array of key-value pairs used to tag a scan. A tag is a custom
|
589
589
|
# attribute label with two parts:
|
@@ -597,22 +597,22 @@ module Aws::CodeGuruSecurity
|
|
597
597
|
#
|
598
598
|
# @return [Types::CreateScanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
599
599
|
#
|
600
|
-
# * {Types::CreateScanResponse#resource_id #resource_id} => Types::ResourceId
|
601
|
-
# * {Types::CreateScanResponse#run_id #run_id} => String
|
602
600
|
# * {Types::CreateScanResponse#scan_name #scan_name} => String
|
603
|
-
# * {Types::CreateScanResponse#
|
601
|
+
# * {Types::CreateScanResponse#run_id #run_id} => String
|
602
|
+
# * {Types::CreateScanResponse#resource_id #resource_id} => Types::ResourceId
|
604
603
|
# * {Types::CreateScanResponse#scan_state #scan_state} => String
|
604
|
+
# * {Types::CreateScanResponse#scan_name_arn #scan_name_arn} => String
|
605
605
|
#
|
606
606
|
# @example Request syntax with placeholder values
|
607
607
|
#
|
608
608
|
# resp = client.create_scan({
|
609
|
-
# analysis_type: "Security", # accepts Security, All
|
610
609
|
# client_token: "ClientToken",
|
611
610
|
# resource_id: { # required
|
612
611
|
# code_artifact_id: "Uuid",
|
613
612
|
# },
|
614
613
|
# scan_name: "ScanName", # required
|
615
614
|
# scan_type: "Standard", # accepts Standard, Express
|
615
|
+
# analysis_type: "Security", # accepts Security, All
|
616
616
|
# tags: {
|
617
617
|
# "TagKey" => "TagValue",
|
618
618
|
# },
|
@@ -620,11 +620,11 @@ module Aws::CodeGuruSecurity
|
|
620
620
|
#
|
621
621
|
# @example Response structure
|
622
622
|
#
|
623
|
-
# resp.resource_id.code_artifact_id #=> String
|
624
|
-
# resp.run_id #=> String
|
625
623
|
# resp.scan_name #=> String
|
626
|
-
# resp.
|
624
|
+
# resp.run_id #=> String
|
625
|
+
# resp.resource_id.code_artifact_id #=> String
|
627
626
|
# resp.scan_state #=> String, one of "InProgress", "Successful", "Failed"
|
627
|
+
# resp.scan_name_arn #=> String
|
628
628
|
#
|
629
629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateScan AWS API Documentation
|
630
630
|
#
|
@@ -649,9 +649,9 @@ module Aws::CodeGuruSecurity
|
|
649
649
|
#
|
650
650
|
# @return [Types::CreateUploadUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
651
651
|
#
|
652
|
-
# * {Types::CreateUploadUrlResponse#code_artifact_id #code_artifact_id} => String
|
653
|
-
# * {Types::CreateUploadUrlResponse#request_headers #request_headers} => Hash<String,String>
|
654
652
|
# * {Types::CreateUploadUrlResponse#s3_url #s3_url} => String
|
653
|
+
# * {Types::CreateUploadUrlResponse#request_headers #request_headers} => Hash<String,String>
|
654
|
+
# * {Types::CreateUploadUrlResponse#code_artifact_id #code_artifact_id} => String
|
655
655
|
#
|
656
656
|
# @example Request syntax with placeholder values
|
657
657
|
#
|
@@ -661,10 +661,10 @@ module Aws::CodeGuruSecurity
|
|
661
661
|
#
|
662
662
|
# @example Response structure
|
663
663
|
#
|
664
|
-
# resp.
|
664
|
+
# resp.s3_url #=> String
|
665
665
|
# resp.request_headers #=> Hash
|
666
666
|
# resp.request_headers["HeaderKey"] #=> String
|
667
|
-
# resp.
|
667
|
+
# resp.code_artifact_id #=> String
|
668
668
|
#
|
669
669
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateUploadUrl AWS API Documentation
|
670
670
|
#
|
@@ -696,12 +696,8 @@ module Aws::CodeGuruSecurity
|
|
696
696
|
|
697
697
|
# Returns a list of all findings generated by a particular scan.
|
698
698
|
#
|
699
|
-
# @option params [
|
700
|
-
# The
|
701
|
-
# parameter when paginating results. If additional results exist beyond
|
702
|
-
# the number you specify, the `nextToken` element is returned in the
|
703
|
-
# response. Use `nextToken` in a subsequent request to retrieve
|
704
|
-
# additional results. If not specified, returns 1000 results.
|
699
|
+
# @option params [required, String] :scan_name
|
700
|
+
# The name of the scan you want to retrieve findings from.
|
705
701
|
#
|
706
702
|
# @option params [String] :next_token
|
707
703
|
# A token to use for paginating results that are returned in the
|
@@ -709,8 +705,12 @@ module Aws::CodeGuruSecurity
|
|
709
705
|
# request. For subsequent calls, use the `nextToken` value returned from
|
710
706
|
# the previous request to continue listing results after the first page.
|
711
707
|
#
|
712
|
-
# @option params [
|
713
|
-
# The
|
708
|
+
# @option params [Integer] :max_results
|
709
|
+
# The maximum number of results to return in the response. Use this
|
710
|
+
# parameter when paginating results. If additional results exist beyond
|
711
|
+
# the number you specify, the `nextToken` element is returned in the
|
712
|
+
# response. Use `nextToken` in a subsequent request to retrieve
|
713
|
+
# additional results. If not specified, returns 1000 results.
|
714
714
|
#
|
715
715
|
# @option params [String] :status
|
716
716
|
# The status of the findings you want to get. Pass either `Open`,
|
@@ -726,9 +726,9 @@ module Aws::CodeGuruSecurity
|
|
726
726
|
# @example Request syntax with placeholder values
|
727
727
|
#
|
728
728
|
# resp = client.get_findings({
|
729
|
-
# max_results: 1,
|
730
|
-
# next_token: "NextToken",
|
731
729
|
# scan_name: "ScanName", # required
|
730
|
+
# next_token: "NextToken",
|
731
|
+
# max_results: 1,
|
732
732
|
# status: "Closed", # accepts Closed, Open, All
|
733
733
|
# })
|
734
734
|
#
|
@@ -737,38 +737,38 @@ module Aws::CodeGuruSecurity
|
|
737
737
|
# resp.findings #=> Array
|
738
738
|
# resp.findings[0].created_at #=> Time
|
739
739
|
# resp.findings[0].description #=> String
|
740
|
-
# resp.findings[0].detector_id #=> String
|
741
|
-
# resp.findings[0].detector_name #=> String
|
742
|
-
# resp.findings[0].detector_tags #=> Array
|
743
|
-
# resp.findings[0].detector_tags[0] #=> String
|
744
740
|
# resp.findings[0].generator_id #=> String
|
745
741
|
# resp.findings[0].id #=> String
|
746
|
-
# resp.findings[0].
|
747
|
-
# resp.findings[0].
|
748
|
-
# resp.findings[0].
|
749
|
-
# resp.findings[0].remediation.suggested_fixes[0].code #=> String
|
750
|
-
# resp.findings[0].remediation.suggested_fixes[0].description #=> String
|
742
|
+
# resp.findings[0].updated_at #=> Time
|
743
|
+
# resp.findings[0].type #=> String
|
744
|
+
# resp.findings[0].status #=> String, one of "Closed", "Open", "All"
|
751
745
|
# resp.findings[0].resource.id #=> String
|
752
746
|
# resp.findings[0].resource.sub_resource_id #=> String
|
753
|
-
# resp.findings[0].rule_id #=> String
|
754
|
-
# resp.findings[0].severity #=> String, one of "Critical", "High", "Medium", "Low", "Info"
|
755
|
-
# resp.findings[0].status #=> String, one of "Closed", "Open", "All"
|
756
|
-
# resp.findings[0].title #=> String
|
757
|
-
# resp.findings[0].type #=> String
|
758
|
-
# resp.findings[0].updated_at #=> Time
|
759
|
-
# resp.findings[0].vulnerability.file_path.code_snippet #=> Array
|
760
|
-
# resp.findings[0].vulnerability.file_path.code_snippet[0].content #=> String
|
761
|
-
# resp.findings[0].vulnerability.file_path.code_snippet[0].number #=> Integer
|
762
|
-
# resp.findings[0].vulnerability.file_path.end_line #=> Integer
|
763
|
-
# resp.findings[0].vulnerability.file_path.name #=> String
|
764
|
-
# resp.findings[0].vulnerability.file_path.path #=> String
|
765
|
-
# resp.findings[0].vulnerability.file_path.start_line #=> Integer
|
766
|
-
# resp.findings[0].vulnerability.id #=> String
|
767
|
-
# resp.findings[0].vulnerability.item_count #=> Integer
|
768
747
|
# resp.findings[0].vulnerability.reference_urls #=> Array
|
769
748
|
# resp.findings[0].vulnerability.reference_urls[0] #=> String
|
770
749
|
# resp.findings[0].vulnerability.related_vulnerabilities #=> Array
|
771
750
|
# resp.findings[0].vulnerability.related_vulnerabilities[0] #=> String
|
751
|
+
# resp.findings[0].vulnerability.id #=> String
|
752
|
+
# resp.findings[0].vulnerability.file_path.name #=> String
|
753
|
+
# resp.findings[0].vulnerability.file_path.path #=> String
|
754
|
+
# resp.findings[0].vulnerability.file_path.start_line #=> Integer
|
755
|
+
# resp.findings[0].vulnerability.file_path.end_line #=> Integer
|
756
|
+
# resp.findings[0].vulnerability.file_path.code_snippet #=> Array
|
757
|
+
# resp.findings[0].vulnerability.file_path.code_snippet[0].number #=> Integer
|
758
|
+
# resp.findings[0].vulnerability.file_path.code_snippet[0].content #=> String
|
759
|
+
# resp.findings[0].vulnerability.item_count #=> Integer
|
760
|
+
# resp.findings[0].severity #=> String, one of "Critical", "High", "Medium", "Low", "Info"
|
761
|
+
# resp.findings[0].remediation.recommendation.text #=> String
|
762
|
+
# resp.findings[0].remediation.recommendation.url #=> String
|
763
|
+
# resp.findings[0].remediation.suggested_fixes #=> Array
|
764
|
+
# resp.findings[0].remediation.suggested_fixes[0].description #=> String
|
765
|
+
# resp.findings[0].remediation.suggested_fixes[0].code #=> String
|
766
|
+
# resp.findings[0].title #=> String
|
767
|
+
# resp.findings[0].detector_tags #=> Array
|
768
|
+
# resp.findings[0].detector_tags[0] #=> String
|
769
|
+
# resp.findings[0].detector_id #=> String
|
770
|
+
# resp.findings[0].detector_name #=> String
|
771
|
+
# resp.findings[0].rule_id #=> String
|
772
772
|
# resp.next_token #=> String
|
773
773
|
#
|
774
774
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetFindings AWS API Documentation
|
@@ -801,21 +801,21 @@ module Aws::CodeGuruSecurity
|
|
801
801
|
#
|
802
802
|
# @example Response structure
|
803
803
|
#
|
804
|
-
# resp.metrics_summary.categories_with_most_findings #=> Array
|
805
|
-
# resp.metrics_summary.categories_with_most_findings[0].category_name #=> String
|
806
|
-
# resp.metrics_summary.categories_with_most_findings[0].finding_number #=> Integer
|
807
804
|
# resp.metrics_summary.date #=> Time
|
808
|
-
# resp.metrics_summary.open_findings.critical #=> Float
|
809
|
-
# resp.metrics_summary.open_findings.high #=> Float
|
810
805
|
# resp.metrics_summary.open_findings.info #=> Float
|
811
806
|
# resp.metrics_summary.open_findings.low #=> Float
|
812
807
|
# resp.metrics_summary.open_findings.medium #=> Float
|
813
|
-
# resp.metrics_summary.
|
814
|
-
# resp.metrics_summary.
|
815
|
-
# resp.metrics_summary.
|
808
|
+
# resp.metrics_summary.open_findings.high #=> Float
|
809
|
+
# resp.metrics_summary.open_findings.critical #=> Float
|
810
|
+
# resp.metrics_summary.categories_with_most_findings #=> Array
|
811
|
+
# resp.metrics_summary.categories_with_most_findings[0].category_name #=> String
|
812
|
+
# resp.metrics_summary.categories_with_most_findings[0].finding_number #=> Integer
|
816
813
|
# resp.metrics_summary.scans_with_most_open_findings #=> Array
|
817
|
-
# resp.metrics_summary.scans_with_most_open_findings[0].finding_number #=> Integer
|
818
814
|
# resp.metrics_summary.scans_with_most_open_findings[0].scan_name #=> String
|
815
|
+
# resp.metrics_summary.scans_with_most_open_findings[0].finding_number #=> Integer
|
816
|
+
# resp.metrics_summary.scans_with_most_open_critical_findings #=> Array
|
817
|
+
# resp.metrics_summary.scans_with_most_open_critical_findings[0].scan_name #=> String
|
818
|
+
# resp.metrics_summary.scans_with_most_open_critical_findings[0].finding_number #=> Integer
|
819
819
|
#
|
820
820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetMetricsSummary AWS API Documentation
|
821
821
|
#
|
@@ -829,44 +829,44 @@ module Aws::CodeGuruSecurity
|
|
829
829
|
# Returns details about a scan, including whether or not a scan has
|
830
830
|
# completed.
|
831
831
|
#
|
832
|
+
# @option params [required, String] :scan_name
|
833
|
+
# The name of the scan you want to view details about.
|
834
|
+
#
|
832
835
|
# @option params [String] :run_id
|
833
836
|
# UUID that identifies the individual scan run you want to view details
|
834
837
|
# about. You retrieve this when you call the `CreateScan` operation.
|
835
838
|
# Defaults to the latest scan run if missing.
|
836
839
|
#
|
837
|
-
# @option params [required, String] :scan_name
|
838
|
-
# The name of the scan you want to view details about.
|
839
|
-
#
|
840
840
|
# @return [Types::GetScanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
841
841
|
#
|
842
|
-
# * {Types::GetScanResponse#analysis_type #analysis_type} => String
|
843
|
-
# * {Types::GetScanResponse#created_at #created_at} => Time
|
844
|
-
# * {Types::GetScanResponse#error_message #error_message} => String
|
845
|
-
# * {Types::GetScanResponse#number_of_revisions #number_of_revisions} => Integer
|
846
|
-
# * {Types::GetScanResponse#run_id #run_id} => String
|
847
842
|
# * {Types::GetScanResponse#scan_name #scan_name} => String
|
848
|
-
# * {Types::GetScanResponse#
|
843
|
+
# * {Types::GetScanResponse#run_id #run_id} => String
|
849
844
|
# * {Types::GetScanResponse#scan_state #scan_state} => String
|
845
|
+
# * {Types::GetScanResponse#created_at #created_at} => Time
|
846
|
+
# * {Types::GetScanResponse#analysis_type #analysis_type} => String
|
850
847
|
# * {Types::GetScanResponse#updated_at #updated_at} => Time
|
848
|
+
# * {Types::GetScanResponse#number_of_revisions #number_of_revisions} => Integer
|
849
|
+
# * {Types::GetScanResponse#scan_name_arn #scan_name_arn} => String
|
850
|
+
# * {Types::GetScanResponse#error_message #error_message} => String
|
851
851
|
#
|
852
852
|
# @example Request syntax with placeholder values
|
853
853
|
#
|
854
854
|
# resp = client.get_scan({
|
855
|
-
# run_id: "Uuid",
|
856
855
|
# scan_name: "ScanName", # required
|
856
|
+
# run_id: "Uuid",
|
857
857
|
# })
|
858
858
|
#
|
859
859
|
# @example Response structure
|
860
860
|
#
|
861
|
-
# resp.analysis_type #=> String, one of "Security", "All"
|
862
|
-
# resp.created_at #=> Time
|
863
|
-
# resp.error_message #=> String
|
864
|
-
# resp.number_of_revisions #=> Integer
|
865
|
-
# resp.run_id #=> String
|
866
861
|
# resp.scan_name #=> String
|
867
|
-
# resp.
|
862
|
+
# resp.run_id #=> String
|
868
863
|
# resp.scan_state #=> String, one of "InProgress", "Successful", "Failed"
|
864
|
+
# resp.created_at #=> Time
|
865
|
+
# resp.analysis_type #=> String, one of "Security", "All"
|
869
866
|
# resp.updated_at #=> Time
|
867
|
+
# resp.number_of_revisions #=> Integer
|
868
|
+
# resp.scan_name_arn #=> String
|
869
|
+
# resp.error_message #=> String
|
870
870
|
#
|
871
871
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetScan AWS API Documentation
|
872
872
|
#
|
@@ -880,9 +880,11 @@ module Aws::CodeGuruSecurity
|
|
880
880
|
# Returns metrics about all findings in an account within a specified
|
881
881
|
# time range.
|
882
882
|
#
|
883
|
-
# @option params [
|
884
|
-
#
|
885
|
-
#
|
883
|
+
# @option params [String] :next_token
|
884
|
+
# A token to use for paginating results that are returned in the
|
885
|
+
# response. Set the value of this parameter to null for the first
|
886
|
+
# request. For subsequent calls, use the `nextToken` value returned from
|
887
|
+
# the previous request to continue listing results after the first page.
|
886
888
|
#
|
887
889
|
# @option params [Integer] :max_results
|
888
890
|
# The maximum number of results to return in the response. Use this
|
@@ -891,16 +893,14 @@ module Aws::CodeGuruSecurity
|
|
891
893
|
# response. Use `nextToken` in a subsequent request to retrieve
|
892
894
|
# additional results. If not specified, returns 1000 results.
|
893
895
|
#
|
894
|
-
# @option params [String] :next_token
|
895
|
-
# A token to use for paginating results that are returned in the
|
896
|
-
# response. Set the value of this parameter to null for the first
|
897
|
-
# request. For subsequent calls, use the `nextToken` value returned from
|
898
|
-
# the previous request to continue listing results after the first page.
|
899
|
-
#
|
900
896
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_date
|
901
897
|
# The start date of the interval which you want to retrieve metrics
|
902
898
|
# from. Rounds to the nearest day.
|
903
899
|
#
|
900
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_date
|
901
|
+
# The end date of the interval which you want to retrieve metrics from.
|
902
|
+
# Round to the nearest day.
|
903
|
+
#
|
904
904
|
# @return [Types::ListFindingsMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
905
905
|
#
|
906
906
|
# * {Types::ListFindingsMetricsResponse#findings_metrics #findings_metrics} => Array<Types::AccountFindingsMetric>
|
@@ -911,36 +911,36 @@ module Aws::CodeGuruSecurity
|
|
911
911
|
# @example Request syntax with placeholder values
|
912
912
|
#
|
913
913
|
# resp = client.list_findings_metrics({
|
914
|
-
# end_date: Time.now, # required
|
915
|
-
# max_results: 1,
|
916
914
|
# next_token: "NextToken",
|
915
|
+
# max_results: 1,
|
917
916
|
# start_date: Time.now, # required
|
917
|
+
# end_date: Time.now, # required
|
918
918
|
# })
|
919
919
|
#
|
920
920
|
# @example Response structure
|
921
921
|
#
|
922
922
|
# resp.findings_metrics #=> Array
|
923
|
-
# resp.findings_metrics[0].closed_findings.critical #=> Float
|
924
|
-
# resp.findings_metrics[0].closed_findings.high #=> Float
|
925
|
-
# resp.findings_metrics[0].closed_findings.info #=> Float
|
926
|
-
# resp.findings_metrics[0].closed_findings.low #=> Float
|
927
|
-
# resp.findings_metrics[0].closed_findings.medium #=> Float
|
928
923
|
# resp.findings_metrics[0].date #=> Time
|
929
|
-
# resp.findings_metrics[0].mean_time_to_close.critical #=> Float
|
930
|
-
# resp.findings_metrics[0].mean_time_to_close.high #=> Float
|
931
|
-
# resp.findings_metrics[0].mean_time_to_close.info #=> Float
|
932
|
-
# resp.findings_metrics[0].mean_time_to_close.low #=> Float
|
933
|
-
# resp.findings_metrics[0].mean_time_to_close.medium #=> Float
|
934
|
-
# resp.findings_metrics[0].new_findings.critical #=> Float
|
935
|
-
# resp.findings_metrics[0].new_findings.high #=> Float
|
936
924
|
# resp.findings_metrics[0].new_findings.info #=> Float
|
937
925
|
# resp.findings_metrics[0].new_findings.low #=> Float
|
938
926
|
# resp.findings_metrics[0].new_findings.medium #=> Float
|
939
|
-
# resp.findings_metrics[0].
|
940
|
-
# resp.findings_metrics[0].
|
927
|
+
# resp.findings_metrics[0].new_findings.high #=> Float
|
928
|
+
# resp.findings_metrics[0].new_findings.critical #=> Float
|
929
|
+
# resp.findings_metrics[0].closed_findings.info #=> Float
|
930
|
+
# resp.findings_metrics[0].closed_findings.low #=> Float
|
931
|
+
# resp.findings_metrics[0].closed_findings.medium #=> Float
|
932
|
+
# resp.findings_metrics[0].closed_findings.high #=> Float
|
933
|
+
# resp.findings_metrics[0].closed_findings.critical #=> Float
|
941
934
|
# resp.findings_metrics[0].open_findings.info #=> Float
|
942
935
|
# resp.findings_metrics[0].open_findings.low #=> Float
|
943
936
|
# resp.findings_metrics[0].open_findings.medium #=> Float
|
937
|
+
# resp.findings_metrics[0].open_findings.high #=> Float
|
938
|
+
# resp.findings_metrics[0].open_findings.critical #=> Float
|
939
|
+
# resp.findings_metrics[0].mean_time_to_close.info #=> Float
|
940
|
+
# resp.findings_metrics[0].mean_time_to_close.low #=> Float
|
941
|
+
# resp.findings_metrics[0].mean_time_to_close.medium #=> Float
|
942
|
+
# resp.findings_metrics[0].mean_time_to_close.high #=> Float
|
943
|
+
# resp.findings_metrics[0].mean_time_to_close.critical #=> Float
|
944
944
|
# resp.next_token #=> String
|
945
945
|
#
|
946
946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListFindingsMetrics AWS API Documentation
|
@@ -955,6 +955,12 @@ module Aws::CodeGuruSecurity
|
|
955
955
|
# Returns a list of all scans in an account. Does not return `EXPRESS`
|
956
956
|
# scans.
|
957
957
|
#
|
958
|
+
# @option params [String] :next_token
|
959
|
+
# A token to use for paginating results that are returned in the
|
960
|
+
# response. Set the value of this parameter to null for the first
|
961
|
+
# request. For subsequent calls, use the `nextToken` value returned from
|
962
|
+
# the previous request to continue listing results after the first page.
|
963
|
+
#
|
958
964
|
# @option params [Integer] :max_results
|
959
965
|
# The maximum number of results to return in the response. Use this
|
960
966
|
# parameter when paginating results. If additional results exist beyond
|
@@ -962,36 +968,30 @@ module Aws::CodeGuruSecurity
|
|
962
968
|
# response. Use `nextToken` in a subsequent request to retrieve
|
963
969
|
# additional results. If not specified, returns 100 results.
|
964
970
|
#
|
965
|
-
# @option params [String] :next_token
|
966
|
-
# A token to use for paginating results that are returned in the
|
967
|
-
# response. Set the value of this parameter to null for the first
|
968
|
-
# request. For subsequent calls, use the `nextToken` value returned from
|
969
|
-
# the previous request to continue listing results after the first page.
|
970
|
-
#
|
971
971
|
# @return [Types::ListScansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
972
972
|
#
|
973
|
-
# * {Types::ListScansResponse#next_token #next_token} => String
|
974
973
|
# * {Types::ListScansResponse#summaries #summaries} => Array<Types::ScanSummary>
|
974
|
+
# * {Types::ListScansResponse#next_token #next_token} => String
|
975
975
|
#
|
976
976
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
977
977
|
#
|
978
978
|
# @example Request syntax with placeholder values
|
979
979
|
#
|
980
980
|
# resp = client.list_scans({
|
981
|
-
# max_results: 1,
|
982
981
|
# next_token: "NextToken",
|
982
|
+
# max_results: 1,
|
983
983
|
# })
|
984
984
|
#
|
985
985
|
# @example Response structure
|
986
986
|
#
|
987
|
-
# resp.next_token #=> String
|
988
987
|
# resp.summaries #=> Array
|
988
|
+
# resp.summaries[0].scan_state #=> String, one of "InProgress", "Successful", "Failed"
|
989
989
|
# resp.summaries[0].created_at #=> Time
|
990
|
-
# resp.summaries[0].
|
990
|
+
# resp.summaries[0].updated_at #=> Time
|
991
991
|
# resp.summaries[0].scan_name #=> String
|
992
|
+
# resp.summaries[0].run_id #=> String
|
992
993
|
# resp.summaries[0].scan_name_arn #=> String
|
993
|
-
# resp.
|
994
|
-
# resp.summaries[0].updated_at #=> Time
|
994
|
+
# resp.next_token #=> String
|
995
995
|
#
|
996
996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListScans AWS API Documentation
|
997
997
|
#
|
@@ -1148,7 +1148,7 @@ module Aws::CodeGuruSecurity
|
|
1148
1148
|
tracer: tracer
|
1149
1149
|
)
|
1150
1150
|
context[:gem_name] = 'aws-sdk-codegurusecurity'
|
1151
|
-
context[:gem_version] = '1.
|
1151
|
+
context[:gem_version] = '1.34.0'
|
1152
1152
|
Seahorse::Client::Request.new(handlers, context)
|
1153
1153
|
end
|
1154
1154
|
|