GuardDuty / Client / get_findings_statistics

get_findings_statistics#

GuardDuty.Client.get_findings_statistics(**kwargs)#

Lists Amazon GuardDuty findings statistics for the specified detector ID.

There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.

See also: AWS API Documentation

Request Syntax

response = client.get_findings_statistics(
    DetectorId='string',
    FindingStatisticTypes=[
        'COUNT_BY_SEVERITY',
    ],
    FindingCriteria={
        'Criterion': {
            'string': {
                'Eq': [
                    'string',
                ],
                'Neq': [
                    'string',
                ],
                'Gt': 123,
                'Gte': 123,
                'Lt': 123,
                'Lte': 123,
                'Equals': [
                    'string',
                ],
                'NotEquals': [
                    'string',
                ],
                'GreaterThan': 123,
                'GreaterThanOrEqual': 123,
                'LessThan': 123,
                'LessThanOrEqual': 123
            }
        }
    }
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

    The ID of the detector that specifies the GuardDuty service whose findings’ statistics you want to retrieve.

  • FindingStatisticTypes (list) –

    [REQUIRED]

    The types of finding statistics to retrieve.

    • (string) –

  • FindingCriteria (dict) –

    Represents the criteria that is used for querying findings.

    • Criterion (dict) –

      Represents a map of finding properties that match specified conditions and values when querying findings.

      • (string) –

        • (dict) –

          Contains information about the condition.

          • Eq (list) –

            Represents the equal condition to be applied to a single field when querying for findings.

            • (string) –

          • Neq (list) –

            Represents the not equal condition to be applied to a single field when querying for findings.

            • (string) –

          • Gt (integer) –

            Represents a greater than condition to be applied to a single field when querying for findings.

          • Gte (integer) –

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • Lt (integer) –

            Represents a less than condition to be applied to a single field when querying for findings.

          • Lte (integer) –

            Represents a less than or equal condition to be applied to a single field when querying for findings.

          • Equals (list) –

            Represents an equal condition to be applied to a single field when querying for findings.

            • (string) –

          • NotEquals (list) –

            Represents a not equal condition to be applied to a single field when querying for findings.

            • (string) –

          • GreaterThan (integer) –

            Represents a greater than condition to be applied to a single field when querying for findings.

          • GreaterThanOrEqual (integer) –

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • LessThan (integer) –

            Represents a less than condition to be applied to a single field when querying for findings.

          • LessThanOrEqual (integer) –

            Represents a less than or equal condition to be applied to a single field when querying for findings.

Return type:

dict

Returns:

Response Syntax

{
    'FindingStatistics': {
        'CountBySeverity': {
            'string': 123
        }
    }
}

Response Structure

  • (dict) –

    • FindingStatistics (dict) –

      The finding statistics object.

      • CountBySeverity (dict) –

        Represents a map of severity to count statistics for a set of findings.

        • (string) –

          • (integer) –

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException