EC2 / Client / get_image_findings

get_image_findings

EC2.Client.get_image_findings(**kwargs)

Describes the Amazon Inspector vulnerability findings for the specified AMI.

You can get findings for AMIs that you own, AMIs that are shared with you, and public AMIs. Amazon Inspector returns findings only for AMIs that it has scanned.

See also: AWS API Documentation

Request Syntax

response = client.get_image_findings(
    ImageId='string',
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
Parameters:

  • ImageId (string) –

    [REQUIRED]

    The ID of the AMI.

  • MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

  • NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'ImageFindings': [
        {
            'FixAvailable': True|False,
            'Score': 123.0,
            'FirstObservedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'Title': 'string',
            'Paths': [
                'string',
            ],
            'SeverityLabel': 'informational'|'low'|'medium'|'high'|'critical',
            'SnapshotId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ImageFindings (list) –

      The Amazon Inspector findings for the AMI.

      • (dict) –

        Describes an Amazon Inspector vulnerability finding for an AMI.

        • FixAvailable (boolean) –

          Specifies whether a fix is available for the finding. This value is true when Amazon Inspector reports a full or partial fix for the finding.

        • Score (float) –

          The Amazon Inspector score for the finding.

        • FirstObservedAt (datetime) –

          The date and time, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), when Amazon Inspector first observed the finding.

        • UpdatedAt (datetime) –

          The date and time, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), when Amazon Inspector last updated the finding.

        • Title (string) –

          The title of the finding.

        • Paths (list) –

          The file paths in the AMI that are affected by the finding. Amazon EC2 returns up to 10 file paths for each finding.

          • (string) –

        • SeverityLabel (string) –

          The severity of the finding.

          The valid values are the following Amazon Inspector severity levels, which correspond to CVSS score ranges:

          • informational - CVSS score of 0.

          • low - CVSS score of 0.1 to 3.9.

          • medium - CVSS score of 4.0 to 6.9.

          • high - CVSS score of 7.0 to 8.9.

          • critical - CVSS score of 9.0 to 10.0.

          For more information, see Software package vulnerability severity in the Amazon Inspector User Guide.

        • SnapshotId (string) –

          The ID of the Amazon EBS snapshot of the AMI in which the finding was detected.

    • NextToken (string) –

      The token to include in another request to get the next page of items. This value is null when there are no more items to return.