CodeGuruSecurity / Paginator / ListFindingsMetrics

ListFindingsMetrics#

class CodeGuruSecurity.Paginator.ListFindingsMetrics#
paginator = client.get_paginator('list_findings_metrics')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from CodeGuruSecurity.Client.list_findings_metrics().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    endDate=datetime(2015, 1, 1),
    startDate=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • endDate (datetime) –

    [REQUIRED]

    The end date of the interval which you want to retrieve metrics from. Round to the nearest day.

  • startDate (datetime) –

    [REQUIRED]

    The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'findingsMetrics': [
        {
            'closedFindings': {
                'critical': 123.0,
                'high': 123.0,
                'info': 123.0,
                'low': 123.0,
                'medium': 123.0
            },
            'date': datetime(2015, 1, 1),
            'meanTimeToClose': {
                'critical': 123.0,
                'high': 123.0,
                'info': 123.0,
                'low': 123.0,
                'medium': 123.0
            },
            'newFindings': {
                'critical': 123.0,
                'high': 123.0,
                'info': 123.0,
                'low': 123.0,
                'medium': 123.0
            },
            'openFindings': {
                'critical': 123.0,
                'high': 123.0,
                'info': 123.0,
                'low': 123.0,
                'medium': 123.0
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • findingsMetrics (list) –

      A list of AccountFindingsMetric objects retrieved from the specified time interval.

      • (dict) –

        A summary of findings metrics for an account on a specified date.

        • closedFindings (dict) –

          The number of closed findings of each severity on the specified date.

          • critical (float) –

            A numeric value corresponding to a critical finding.

          • high (float) –

            A numeric value corresponding to a high severity finding.

          • info (float) –

            A numeric value corresponding to an informational finding.

          • low (float) –

            A numeric value corresponding to a low severity finding.

          • medium (float) –

            A numeric value corresponding to a medium severity finding.

        • date (datetime) –

          The date from which the findings metrics were retrieved.

        • meanTimeToClose (dict) –

          The average time in days it takes to close findings of each severity as of a specified date.

          • critical (float) –

            A numeric value corresponding to a critical finding.

          • high (float) –

            A numeric value corresponding to a high severity finding.

          • info (float) –

            A numeric value corresponding to an informational finding.

          • low (float) –

            A numeric value corresponding to a low severity finding.

          • medium (float) –

            A numeric value corresponding to a medium severity finding.

        • newFindings (dict) –

          The number of new findings of each severity on the specified date.

          • critical (float) –

            A numeric value corresponding to a critical finding.

          • high (float) –

            A numeric value corresponding to a high severity finding.

          • info (float) –

            A numeric value corresponding to an informational finding.

          • low (float) –

            A numeric value corresponding to a low severity finding.

          • medium (float) –

            A numeric value corresponding to a medium severity finding.

        • openFindings (dict) –

          The number of open findings of each severity as of the specified date.

          • critical (float) –

            A numeric value corresponding to a critical finding.

          • high (float) –

            A numeric value corresponding to a high severity finding.

          • info (float) –

            A numeric value corresponding to an informational finding.

          • low (float) –

            A numeric value corresponding to a low severity finding.

          • medium (float) –

            A numeric value corresponding to a medium severity finding.

    • NextToken (string) –

      A token to resume pagination.