ListCoverage - Amazon GuardDuty


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.

Request Syntax

POST /detector/detectorId/coverage HTTP/1.1 Content-type: application/json { "filterCriteria": { "filterCriterion": [ { "criterionKey": "string", "filterCondition": { "equals": [ "string" ], "notEquals": [ "string" ] } } ] }, "maxResults": number, "nextToken": "string", "sortCriteria": { "attributeName": "string", "orderBy": "string" } }

URI Request Parameters

The request uses the following URI parameters.


The unique ID of the detector whose coverage details you want to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: Yes

Request Body

The request accepts the following data in JSON format.


Represents the criteria used to filter the coverage details.

Type: CoverageFilterCriteria object

Required: No


The maximum number of results to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No


A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Type: String

Required: No


Represents the criteria used to sort the coverage details.

Type: CoverageSortCriteria object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "resources": [ { "accountId": "string", "coverageStatus": "string", "detectorId": "string", "issue": "string", "resourceDetails": { "ec2InstanceDetails": { "agentDetails": { "version": "string" }, "clusterArn": "string", "instanceId": "string", "instanceType": "string", "managementType": "string" }, "ecsClusterDetails": { "clusterName": "string", "containerInstanceDetails": { "compatibleContainerInstances": number, "coveredContainerInstances": number }, "fargateDetails": { "issues": [ "string" ], "managementType": "string" } }, "eksClusterDetails": { "addonDetails": { "addonStatus": "string", "addonVersion": "string" }, "clusterName": "string", "compatibleNodes": number, "coveredNodes": number, "managementType": "string" }, "resourceType": "string" }, "resourceId": "string", "updatedAt": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The pagination parameter to be used on the next list operation to retrieve more items.

Type: String


A list of resources and their attributes providing cluster details.

Type: Array of CoverageResource objects


For information about the errors that are common to all actions, see Common Errors.


A bad request exception object.

HTTP Status Code: 400


An internal server error exception object.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: