Skip to content

list_findings_reports async

list_findings_reports(
    profiling_group_name: ProfilingGroupName,
    start_time: Timestamp,
    end_time: Timestamp,
    *,
    config_overrides: Optional[AsyncCodeGuruProfilerClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
    daily_reports_only: Optional[bool] = None,
) -> ListFindingsReportsResponse

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

Parameters:

  • profiling_group_name (ProfilingGroupName) –

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

  • start_time (Timestamp) –

    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.

  • end_time (Timestamp) –

    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.

  • next_token (Optional[PaginationToken], default: None ) –

    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.

  • max_results (Optional[MaxResults], default: None ) –

    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.

  • daily_reports_only (Optional[bool], default: None ) –

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

Raises:

Source code in docs_src/capo_codeguruprofiler/_services/async_code_guru_profiler.py
async def list_findings_reports(
    self,
    profiling_group_name: "capo_codeguruprofiler.types.profiling_group_name.ProfilingGroupName",
    start_time: "capo_codeguruprofiler.types.timestamp.Timestamp",
    end_time: "capo_codeguruprofiler.types.timestamp.Timestamp",
    *,
    config_overrides: Optional[AsyncCodeGuruProfilerClientConfig] = None,
    next_token: Optional[
        "capo_codeguruprofiler.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_codeguruprofiler.types.max_results.MaxResults"
    ] = None,
    daily_reports_only: Optional[bool] = None,
) -> "capo_codeguruprofiler.types.list_findings_reports_response.ListFindingsReportsResponse":
    """<p>List the available reports for a given profiling group and time range.</p>

    Args:
        profiling_group_name: <p>The name of the profiling group from which to search for analysis data.</p>
        start_time: <p> The start time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>. 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. </p>
        end_time: <p> The end time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>. 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. </p>
        next_token: <p>The <code>nextToken</code> value returned from a previous paginated <code>ListFindingsReportsRequest</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>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.</p> </note>
        max_results: <p>The maximum number of report results returned by <code>ListFindingsReports</code> in paginated output. When this parameter is used, <code>ListFindingsReports</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListFindingsReports</code> request with the returned <code>nextToken</code> value.</p>
        daily_reports_only: <p>A <code>Boolean</code> value indicating whether to only return reports from daily profiles. If set to <code>True</code>, only analysis data from daily profiles is returned. If set to <code>False</code>, analysis data is returned from smaller time windows (for example, one hour).</p>

    Raises:
        capo_codeguruprofiler.errors.internal_server_exception.InternalServerException: <p>The server encountered an internal error and is unable to complete the request.</p>
        capo_codeguruprofiler.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request does not exist.</p>
        capo_codeguruprofiler.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_codeguruprofiler.errors.validation_exception.ValidationException: <p>The parameter is not valid.</p>
        capo_codeguruprofiler.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codeguruprofiler.types.list_findings_reports_request.ListFindingsReportsRequest]",
    ) -> AsyncOperationResponse[
        "capo_codeguruprofiler.types.list_findings_reports_response.ListFindingsReportsResponse"
    ]:
        import capo_codeguruprofiler._operations.code_guru_profiler.list_findings_reports

        (
            output,
            http_response,
        ) = await capo_codeguruprofiler._operations.code_guru_profiler.list_findings_reports.async_list_findings_reports(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFindingsReports")
    )
    input_: capo_codeguruprofiler.types.list_findings_reports_request.ListFindingsReportsRequest = {
        "profiling_group_name": profiling_group_name,
        "start_time": start_time,
        "end_time": end_time,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if daily_reports_only is not None:
        input_["daily_reports_only"] = daily_reports_only

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output