CodeGuruProfiler / Client / list_findings_reports

list_findings_reports#

CodeGuruProfiler.Client.list_findings_reports(**kwargs)#

List the available reports for a given profiling group and time range.

See also: AWS API Documentation

Request Syntax

response = client.list_findings_reports(
    dailyReportsOnly=True|False,
    endTime=datetime(2015, 1, 1),
    maxResults=123,
    nextToken='string',
    profilingGroupName='string',
    startTime=datetime(2015, 1, 1)
)
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).

  • endTime (datetime) –

    [REQUIRED]

    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.

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

    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.

  • profilingGroupName (string) –

    [REQUIRED]

    The name of the profiling group from which to search for analysis data.

  • startTime (datetime) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    The structure representing the ListFindingsReportsResponse.

    • findingsReportSummaries (list) –

      The list of analysis results summaries.

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

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

Exceptions