CodeGuruProfiler / Client / get_findings_report_account_summary

get_findings_report_account_summary#

CodeGuruProfiler.Client.get_findings_report_account_summary(**kwargs)#

Returns a list of `FindingsReportSummary <https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html>`__objects that contain analysis results for all profiling groups in your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.get_findings_report_account_summary(
    dailyReportsOnly=True|False,
    maxResults=123,
    nextToken='string'
)
Parameters:

  • 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.

    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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'reportSummaries': [
        {
            'id': 'string',
            'profileEndTime': datetime(2015, 1, 1),
            'profileStartTime': datetime(2015, 1, 1),
            'profilingGroupName': 'string',
            'totalNumberOfFindings': 123
        },
    ]
}

Response Structure

  • (dict) –

    The structure representing the GetFindingsReportAccountSummaryResponse.

    • nextToken (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.

    • reportSummaries (list) –

      The return list of `FindingsReportSummary <https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html>`__objects taht contain summaries of analysis results for all profiling groups in your AWS account.

      • (dict) –

        Information about potential recommendations that might be created from the analysis of profiling data.

        • id (string) –

          The universally unique identifier (UUID) of the recommendation report.

        • profileEndTime (datetime) –

          The end time of the period during which the metric is flagged as anomalous. 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.

        • profileStartTime (datetime) –

          The start time of the profile the analysis data is about. 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.

        • profilingGroupName (string) –

          The name of the profiling group that is associated with the analysis data.

        • totalNumberOfFindings (integer) –

          The total number of different recommendations that were found by the analysis.

Exceptions

  • CodeGuruProfiler.Client.exceptions.InternalServerException

  • CodeGuruProfiler.Client.exceptions.ValidationException

  • CodeGuruProfiler.Client.exceptions.ThrottlingException