coverages

Creates, updates, deletes, gets or lists a coverages resource.

Overview

Name	coverages
Type	Resource
Id	aws.guardduty.coverages

Fields

The following fields are returned by SELECT queries:

list_coverage

Name	Datatype	Description
account_id	string	The unique ID of the Amazon Web Services account.
coverage_status	string	Represents the status of the EKS cluster coverage. (HEALTHY, UNHEALTHY)
detector_id	string	The unique ID of the GuardDuty detector associated with the resource.
issue	string	Represents the reason why a coverage status was UNHEALTHY for the EKS cluster.
resource_details	object	Information about the resource for which the coverage statistics are retrieved.
resource_id	string	The unique ID of the resource.
updated_at	string (date-time)	The timestamp at which the coverage details for the resource were last updated. This is in UTC format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_coverage	select	detector_id, region		Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member accounts in your organization. Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their resources.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
detector_id	string	The unique ID of the detector whose coverage details you want to retrieve. To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
region	string	AWS region (default: us-east-1)

SELECT examples

list_coverage

Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member accounts in your organization. Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their resources.

SELECT
account_id,
coverage_status,
detector_id,
issue,
resource_details,
resource_id,
updated_at
FROM aws.guardduty.coverages
WHERE detector_id = '{{ detector_id }}' -- required
AND region = '{{ region }}' -- required
;