List the available reports for a given profiling group and time range.
Request Syntax
GET /internal/profilingGroups/profilingGroupName/findingsReports?dailyReportsOnly=dailyReportsOnly&endTime=endTime&maxResults=maxResults&nextToken=nextToken&startTime=startTime HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- dailyReportsOnly
-
A
Booleanvalue indicating whether to only return reports from daily profiles. If set toTrue, only analysis data from daily profiles is returned. If set toFalse, analysis data is returned from smaller time windows (for example, one hour). - endTime
-
The end time of the profile to get analysis data about. You must specify
startTimeandendTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.Required: Yes
- maxResults
-
The maximum number of report results returned by
ListFindingsReportsin paginated output. When this parameter is used,ListFindingsReportsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListFindingsReportsrequest with the returnednextTokenvalue.Valid Range: Minimum value of 1. Maximum value of 1000.
- nextToken
-
The
nextTokenvalue returned from a previous paginatedListFindingsReportsRequestrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue.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-]+$ - profilingGroupName
-
The name of the profiling group from which to search for analysis data.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[\w-]+$Required: Yes
- startTime
-
The start time of the profile to get analysis data about. You must specify
startTimeandendTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"findingsReportSummaries": [
{
"id": "string",
"profileEndTime": "string",
"profileStartTime": "string",
"profilingGroupName": "string",
"totalNumberOfFindings": number
}
],
"nextToken": "string"
}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.
- findingsReportSummaries
-
The list of analysis results summaries.
Type: Array of FindingsReportSummary objects
- nextToken
-
The
nextTokenvalue to include in a futureListFindingsReportsrequest. When the results of aListFindingsReportsrequest exceedmaxResults, this value can be used to retrieve the next page of results. This value isnullwhen there are no more results to return.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[\w-]+$
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
- ResourceNotFoundException
-
The resource specified in the request does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
