CodeGuruSecurity / Client / get_findings

get_findings#

CodeGuruSecurity.Client.get_findings(**kwargs)#

Returns a list of all findings generated by a particular scan.

See also: AWS API Documentation

Request Syntax

response = client.get_findings(
    maxResults=123,
    nextToken='string',
    scanName='string',
    status='Closed'|'Open'|'All'
)
Parameters:

  • maxResults (integer) – The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results.

  • nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

  • scanName (string) –

    [REQUIRED]

    The name of the scan you want to retrieve findings from.

  • status (string) – The status of the findings you want to get. Pass either Open, Closed, or All.

Return type:

dict

Returns:

Response Syntax

{
    'findings': [
        {
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'detectorId': 'string',
            'detectorName': 'string',
            'detectorTags': [
                'string',
            ],
            'generatorId': 'string',
            'id': 'string',
            'remediation': {
                'recommendation': {
                    'text': 'string',
                    'url': 'string'
                },
                'suggestedFixes': [
                    {
                        'code': 'string',
                        'description': 'string'
                    },
                ]
            },
            'resource': {
                'id': 'string',
                'subResourceId': 'string'
            },
            'ruleId': 'string',
            'severity': 'Critical'|'High'|'Medium'|'Low'|'Info',
            'status': 'Closed'|'Open'|'All',
            'title': 'string',
            'type': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'vulnerability': {
                'filePath': {
                    'codeSnippet': [
                        {
                            'content': 'string',
                            'number': 123
                        },
                    ],
                    'endLine': 123,
                    'name': 'string',
                    'path': 'string',
                    'startLine': 123
                },
                'id': 'string',
                'itemCount': 123,
                'referenceUrls': [
                    'string',
                ],
                'relatedVulnerabilities': [
                    'string',
                ]
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • findings (list) –

      A list of findings generated by the specified scan.

      • (dict) –

        Information about a finding that was detected in your code.

        • createdAt (datetime) –

          The time when the finding was created.

        • description (string) –

          A description of the finding.

        • detectorId (string) –

          The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.

        • detectorName (string) –

          The name of the detector that identified the security vulnerability in your code.

        • detectorTags (list) –

          One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.

          • (string) –

        • generatorId (string) –

          The identifier for the component that generated a finding such as AWSCodeGuruSecurity or AWSInspector.

        • id (string) –

          The identifier for a finding.

        • remediation (dict) –

          An object that contains the details about how to remediate a finding.

          • recommendation (dict) –

            An object that contains information about the recommended course of action to remediate a finding.

            • text (string) –

              The recommended course of action to remediate the finding.

            • url (string) –

              The URL address to the recommendation for remediating the finding.

          • suggestedFixes (list) –

            A list of SuggestedFix objects. Each object contains information about a suggested code fix to remediate the finding.

            • (dict) –

              Information about the suggested code fix to remediate a finding.

              • code (string) –

                The suggested code to add to your file.

              • description (string) –

                A description of the suggested code fix and why it is being suggested.

        • resource (dict) –

          The resource where Amazon CodeGuru Security detected a finding.

          • id (string) –

            The identifier for the resource.

          • subResourceId (string) –

            The identifier for a section of the resource, such as an AWS Lambda layer.

        • ruleId (string) –

          The identifier for the rule that generated the finding.

        • severity (string) –

          The severity of the finding.

        • status (string) –

          The status of the finding. A finding status can be open or closed.

        • title (string) –

          The title of the finding.

        • type (string) –

          The type of finding.

        • updatedAt (datetime) –

          The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.

        • vulnerability (dict) –

          An object that describes the detected security vulnerability.

          • filePath (dict) –

            An object that describes the location of the detected security vulnerability in your code.

            • codeSnippet (list) –

              A list of CodeLine objects that describe where the security vulnerability appears in your code.

              • (dict) –

                The line of code where a finding was detected.

                • content (string) –

                  The code that contains a vulnerability.

                • number (integer) –

                  The code line number.

            • endLine (integer) –

              The last line number of the code snippet where the security vulnerability appears in your code.

            • name (string) –

              The name of the file.

            • path (string) –

              The path to the resource with the security vulnerability.

            • startLine (integer) –

              The first line number of the code snippet where the security vulnerability appears in your code.

          • id (string) –

            The identifier for the vulnerability.

          • itemCount (integer) –

            The number of times the vulnerability appears in your code.

          • referenceUrls (list) –

            One or more URL addresses that contain details about a vulnerability.

            • (string) –

          • relatedVulnerabilities (list) –

            One or more vulnerabilities that are related to the vulnerability being described.

            • (string) –

    • nextToken (string) –

      A pagination token. You can use this in future calls to GetFindings to continue listing results after the current page.

Exceptions