imagebuilder / Client / list_image_scan_findings

list_image_scan_findings

imagebuilder.Client.list_image_scan_findings(**kwargs)

Returns a list of image scan findings for your account.

See also: AWS API Documentation

Request Syntax

response = client.list_image_scan_findings(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

• filters (list) –

  An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:

  • imageBuildVersionArn

  • imagePipelineArn

  • vulnerabilityId

  • severity

  If you don’t request a filter, then all findings in your account are listed.

  • (dict) –

    A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.

    • name (string) –

      The name of the image scan finding filter. Filter names are case-sensitive.

    • values (list) –

      The filter values. Filter values are case-sensitive.

      • (string) –

• maxResults (integer) – The maximum items to return in a request.

• nextToken (string) – A token to specify where to start paginating. This is the NextToken from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'findings': [
        {
            'awsAccountId': 'string',
            'imageBuildVersionArn': 'string',
            'imagePipelineArn': 'string',
            'type': 'string',
            'description': 'string',
            'title': 'string',
            'remediation': {
                'recommendation': {
                    'text': 'string',
                    'url': 'string'
                }
            },
            'severity': 'string',
            'firstObservedAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'inspectorScore': 123.0,
            'inspectorScoreDetails': {
                'adjustedCvss': {
                    'scoreSource': 'string',
                    'cvssSource': 'string',
                    'version': 'string',
                    'score': 123.0,
                    'scoringVector': 'string',
                    'adjustments': [
                        {
                            'metric': 'string',
                            'reason': 'string'
                        },
                    ]
                }
            },
            'packageVulnerabilityDetails': {
                'vulnerabilityId': 'string',
                'vulnerablePackages': [
                    {
                        'name': 'string',
                        'version': 'string',
                        'sourceLayerHash': 'string',
                        'epoch': 123,
                        'release': 'string',
                        'arch': 'string',
                        'packageManager': 'string',
                        'filePath': 'string',
                        'fixedInVersion': 'string',
                        'remediation': 'string'
                    },
                ],
                'source': 'string',
                'cvss': [
                    {
                        'baseScore': 123.0,
                        'scoringVector': 'string',
                        'version': 'string',
                        'source': 'string'
                    },
                ],
                'relatedVulnerabilities': [
                    'string',
                ],
                'sourceUrl': 'string',
                'vendorSeverity': 'string',
                'vendorCreatedAt': datetime(2015, 1, 1),
                'vendorUpdatedAt': datetime(2015, 1, 1),
                'referenceUrls': [
                    'string',
                ]
            },
            'fixAvailable': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • requestId (string) –

    The request ID that uniquely identifies this request.

  • findings (list) –

    The image scan findings for your account that meet your request filter criteria.

    • (dict) –

      Contains details about a vulnerability scan finding.

      • awsAccountId (string) –

        The Amazon Web Services account ID that’s associated with the finding.

      • imageBuildVersionArn (string) –

        The Amazon Resource Name (ARN) of the image build version that’s associated with the finding.

      • imagePipelineArn (string) –

        The Amazon Resource Name (ARN) of the image pipeline that’s associated with the finding.

      • type (string) –

        The type of the finding. Image Builder looks for findings of the type PACKAGE_VULNERABILITY that apply to output images, and excludes other types.

      • description (string) –

        The description of the finding.

      • title (string) –

        The title of the finding.

      • remediation (dict) –

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

        • recommendation (dict) –

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

          • text (string) –

            The recommended course of action to remediate the finding.

          • url (string) –

            A link to more information about the recommended remediation for this vulnerability.

      • severity (string) –

        The severity of the finding.

      • firstObservedAt (datetime) –

        The date and time when the finding was first observed.

      • updatedAt (datetime) –

        The timestamp when the finding was last updated.

      • inspectorScore (float) –

        The score that Amazon Inspector assigned for the finding.

      • inspectorScoreDetails (dict) –

        An object that contains details of the Amazon Inspector score.

        • adjustedCvss (dict) –

          An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.

          • scoreSource (string) –

            The source for the CVSS score.

          • cvssSource (string) –

            The source of the finding.

          • version (string) –

            The CVSS version that generated the score.

          • score (float) –

            The CVSS score.

          • scoringVector (string) –

            A vector that measures the severity of the vulnerability.

          • adjustments (list) –

            An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.

            • (dict) –

              Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.

              • metric (string) –

                The metric that Amazon Inspector used to adjust the CVSS score.

              • reason (string) –

                The reason for the CVSS score adjustment.

      • packageVulnerabilityDetails (dict) –

        An object that contains the details of a package vulnerability finding.

        • vulnerabilityId (string) –

          A unique identifier for this vulnerability.

        • vulnerablePackages (list) –

          The packages that this vulnerability impacts.

          • (dict) –

            Information about a vulnerable package that Amazon Inspector identifies in a finding.

            • name (string) –

              The name of the vulnerable package.

            • version (string) –

              The version of the vulnerable package.

            • sourceLayerHash (string) –

              The source layer hash of the vulnerable package.

            • epoch (integer) –

              The epoch of the vulnerable package.

            • release (string) –

              The release of the vulnerable package.

            • arch (string) –

              The architecture of the vulnerable package.

            • packageManager (string) –

              The package manager of the vulnerable package.

            • filePath (string) –

              The file path of the vulnerable package.

            • fixedInVersion (string) –

              The version of the package that contains the vulnerability fix.

            • remediation (string) –

              The code to run in your environment to update packages with a fix available.

        • source (string) –

          The source of the vulnerability information.

        • cvss (list) –

          CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package.

          • (dict) –

            Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide.

            • baseScore (float) –

              The CVSS base score.

            • scoringVector (string) –

              The vector string of the CVSS score.

            • version (string) –

              The CVSS version that generated the score.

            • source (string) –

              The source of the CVSS score.

        • relatedVulnerabilities (list) –

          Vulnerabilities that are often related to the findings for the package.

          • (string) –

        • sourceUrl (string) –

          A link to the source of the vulnerability information.

        • vendorSeverity (string) –

          The severity that the vendor assigned to this vulnerability type.

        • vendorCreatedAt (datetime) –

          The date and time when this vulnerability was first added to the vendor’s database.

        • vendorUpdatedAt (datetime) –

          The date and time when the vendor last updated this vulnerability in their database.

        • referenceUrls (list) –

          Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package.

          • (string) –

      • fixAvailable (string) –

        Details about whether a fix is available for any of the packages that are identified in the finding through a version update.

  • nextToken (string) –

    The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service has’ot included in this request. Use this token with the next request to retrieve additional objects.

Exceptions

• imagebuilder.Client.exceptions.ServiceException

• imagebuilder.Client.exceptions.ClientException

• imagebuilder.Client.exceptions.ServiceUnavailableException

• imagebuilder.Client.exceptions.InvalidRequestException

• imagebuilder.Client.exceptions.InvalidPaginationTokenException

• imagebuilder.Client.exceptions.ForbiddenException

• imagebuilder.Client.exceptions.CallRateLimitExceededException