GuardDuty / Client / get_coverage_statistics

get_coverage_statistics#

GuardDuty.Client.get_coverage_statistics(**kwargs)#

Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with the active member accounts in your organization who have enabled Runtime Monitoring and have the GuardDuty security agent running on their resources.

See also: AWS API Documentation

Request Syntax

response = client.get_coverage_statistics(
    DetectorId='string',
    FilterCriteria={
        'FilterCriterion': [
            {
                'CriterionKey': 'ACCOUNT_ID'|'CLUSTER_NAME'|'RESOURCE_TYPE'|'COVERAGE_STATUS'|'ADDON_VERSION'|'MANAGEMENT_TYPE'|'EKS_CLUSTER_NAME'|'ECS_CLUSTER_NAME'|'AGENT_VERSION'|'INSTANCE_ID'|'CLUSTER_ARN',
                'FilterCondition': {
                    'Equals': [
                        'string',
                    ],
                    'NotEquals': [
                        'string',
                    ]
                }
            },
        ]
    },
    StatisticsType=[
        'COUNT_BY_RESOURCE_TYPE'|'COUNT_BY_COVERAGE_STATUS',
    ]
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

    The unique ID of the GuardDuty detector associated to the coverage statistics.

  • FilterCriteria (dict) –

    Represents the criteria used to filter the coverage statistics

    • FilterCriterion (list) –

      Represents a condition that when matched will be added to the response of the operation.

      • (dict) –

        Represents a condition that when matched will be added to the response of the operation.

        • CriterionKey (string) –

          An enum value representing possible filter fields.

          Note

          Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME. CLUSTER_NAME has been deprecated.

        • FilterCondition (dict) –

          Contains information about the condition.

          • Equals (list) –

            Represents an equal condition that is applied to a single field while retrieving the coverage details.

            • (string) –

          • NotEquals (list) –

            Represents a not equal condition that is applied to a single field while retrieving the coverage details.

            • (string) –

  • StatisticsType (list) –

    [REQUIRED]

    Represents the statistics type used to aggregate the coverage details.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CoverageStatistics': {
        'CountByResourceType': {
            'string': 123
        },
        'CountByCoverageStatus': {
            'string': 123
        }
    }
}

Response Structure

  • (dict) –

    • CoverageStatistics (dict) –

      Represents the count aggregated by the statusCode and resourceType.

      • CountByResourceType (dict) –

        Represents coverage statistics for EKS clusters aggregated by resource type.

        • (string) –

          • (integer) –

      • CountByCoverageStatus (dict) –

        Represents coverage statistics for EKS clusters aggregated by coverage status.

        • (string) –

          • (integer) –

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException

  • GuardDuty.Client.exceptions.InternalServerErrorException