Get Coverage Statistics

guardduty_get_coverage_statistics

R Documentation

Retrieves aggregated statistics for your account¶

Description¶

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.

Usage¶

guardduty_get_coverage_statistics(DetectorId, FilterCriteria,
  StatisticsType)

Arguments¶

DetectorId

[required] The unique ID of the GuardDuty detector.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the list_detectors API.

FilterCriteria

Represents the criteria used to filter the coverage statistics.

StatisticsType

[required] Represents the statistics type used to aggregate the coverage details.

Value¶

A list with the following syntax:

list(
  CoverageStatistics = list(
    CountByResourceType = list(
      123
    ),
    CountByCoverageStatus = list(
      123
    )
  )
)

Request syntax¶

svc$get_coverage_statistics(
  DetectorId = "string",
  FilterCriteria = list(
    FilterCriterion = list(
      list(
        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 = list(
          Equals = list(
            "string"
          ),
          NotEquals = list(
            "string"
          )
        )
      )
    )
  ),
  StatisticsType = list(
    "COUNT_BY_RESOURCE_TYPE"|"COUNT_BY_COVERAGE_STATUS"
  )
)