findings_report_account_summaries
Creates, updates, deletes, gets or lists a findings_report_account_summaries resource.
Overview
| Name | findings_report_account_summaries |
| Type | Resource |
| Id | aws.codeguruprofiler.findings_report_account_summaries |
Fields
The following fields are returned by SELECT queries:
- get_findings_report_account_summary
| Name | Datatype | Description |
|---|---|---|
next_token | string | 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. (pattern: <code>^[\w-]+$</code>) |
report_summaries | array | The return list of FindingsReportSummary objects taht contain summaries of analysis results for all profiling groups in your AWS account. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_findings_report_account_summary | select | region | dailyReportsOnly, maxResults, nextToken | Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
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 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. |
nextToken | string | 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. 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
- get_findings_report_account_summary
Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.
SELECT
next_token,
report_summaries
FROM aws.codeguruprofiler.findings_report_account_summaries
WHERE region = '{{ region }}' -- required
AND dailyReportsOnly = '{{ dailyReportsOnly }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;