Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCoverageStatistics

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.

Request Syntax


POST /detector/detectorId/coverage/statistics HTTP/1.1
Content-type: application/json

{
   "filterCriteria": { 
      "filterCriterion": [ 
         { 
            "criterionKey": "string",
            "filterCondition": { 
               "equals": [ "string" ],
               "notEquals": [ "string" ]
            }
         }
      ]
   },
   "statisticsType": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

detectorId

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 ListDetectors API.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

filterCriteria

Represents the criteria used to filter the coverage statistics.

Type: CoverageFilterCriteria object

Required: No

statisticsType

Represents the statistics type used to aggregate the coverage details.

Type: Array of strings

Valid Values: COUNT_BY_RESOURCE_TYPE | COUNT_BY_COVERAGE_STATUS

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "coverageStatistics": { 
      "countByCoverageStatus": { 
         "string" : number 
      },
      "countByResourceType": { 
         "string" : 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.

coverageStatistics

Represents the count aggregated by the statusCode and resourceType.

Type: CoverageStatistics object

Errors

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

BadRequestException

A bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

HTTP Status Code: 500