findings_reports
Creates, updates, deletes, gets or lists a findings_reports resource.
Overview
| Name | findings_reports |
| Type | Resource |
| Id | aws.codeguruprofiler.findings_reports |
Fields
The following fields are returned by SELECT queries:
- list_findings_reports
| Name | Datatype | Description |
|---|---|---|
findings_report_summaries | array | The list of analysis results summaries. |
next_token | string | The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports 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. (pattern: <code>^[\w-]+$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_findings_reports | select | endTime, profiling_group_name, startTime, region | dailyReportsOnly, maxResults, nextToken | List the available reports for a given profiling group and time range. |
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 |
|---|---|---|
endTime | string (date-time) | The end time of the profile to get analysis data about. You must specify startTime and endTime. 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. |
profiling_group_name | string | The name of the profiling group from which to search for analysis data. |
region | string | AWS region (default: us-east-1) |
startTime | string (date-time) | The start time of the profile to get analysis data about. You must specify startTime and endTime. 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. |
dailyReportsOnly | boolean | 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 | integer | The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports 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 ListFindingsReports request with the returned nextToken value. |
nextToken | string | The nextToken value returned from a previous paginated ListFindingsReportsRequest 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. 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. |
SELECT examples
- list_findings_reports
List the available reports for a given profiling group and time range.
SELECT
findings_report_summaries,
next_token
FROM aws.codeguruprofiler.findings_reports
WHERE endTime = '{{ endTime }}' -- required
AND profiling_group_name = '{{ profiling_group_name }}' -- required
AND startTime = '{{ startTime }}' -- required
AND region = '{{ region }}' -- required
AND dailyReportsOnly = '{{ dailyReportsOnly }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;