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

GetFindingsReportAccountSummary

Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.

Request Syntax


GET /internal/findingsReports?dailyReportsOnly=dailyReportsOnly&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

dailyReportsOnly

A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

maxResults

The maximum number of results returned by GetFindingsReportAccountSummary in paginated output. When this parameter is used, GetFindingsReportAccountSummary only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another GetFindingsReportAccountSummary request with the returned nextToken value.

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

nextToken

The nextToken value returned from a previous paginated GetFindingsReportAccountSummary request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Note

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

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

Pattern: ^[\w-]+$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "reportSummaries": [ 
      { 
         "id": "string",
         "profileEndTime": "string",
         "profileStartTime": "string",
         "profilingGroupName": "string",
         "totalNumberOfFindings": 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.

nextToken

The nextToken value to include in a future GetFindingsReportAccountSummary request. When the results of a GetFindingsReportAccountSummary request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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

Pattern: ^[\w-]+$

reportSummaries

The return list of FindingsReportSummary objects taht contain summaries of analysis results for all profiling groups in your AWS account.

Type: Array of FindingsReportSummary objects

Errors

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

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The parameter is not valid.

HTTP Status Code: 400