Skip to content

list_reports

list_reports(
    *,
    config_overrides: Optional[resiliencehubv2ClientConfig] = None,
    service_arn: Optional[Arn] = None,
    report_type: Optional[ReportType] = None,
    test_run_id: Optional[TestRunId] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListReportsResponse

List reports for a service, or all reports owned by the account if serviceArn is not provided.

Parameters:

  • service_arn (Optional[Arn], default: None ) –

    Optional. If not provided, lists all reports owned by the account.

  • report_type (Optional[ReportType], default: None ) –

    Filter reports by type.

Raises:

Source code in docs_src/capo_resiliencehubv2/_services/resiliencehubv2.py
def list_reports(
    self,
    *,
    config_overrides: Optional[resiliencehubv2ClientConfig] = None,
    service_arn: Optional["capo_resiliencehubv2.types.arn.Arn"] = None,
    report_type: Optional[
        "capo_resiliencehubv2.types.report_type.ReportType"
    ] = None,
    test_run_id: Optional[
        "capo_resiliencehubv2.types.test_run_id.TestRunId"
    ] = None,
    max_results: Optional[
        "capo_resiliencehubv2.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_resiliencehubv2.types.next_token.NextToken"] = None,
) -> "capo_resiliencehubv2.types.list_reports_response.ListReportsResponse":
    """<p>List reports for a service, or all reports owned by the account if serviceArn is not provided.</p>

    Args:
        service_arn: <p>Optional. If not provided, lists all reports owned by the account.</p>
        report_type: <p>Filter reports by type.</p>

    Raises:
        capo_resiliencehubv2.errors.access_denied_exception.AccessDeniedException: <p>Access denied — caller lacks required permissions.</p>
        capo_resiliencehubv2.errors.internal_server_exception.InternalServerException: <p>Internal service error.</p>
        capo_resiliencehubv2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found.</p>
        capo_resiliencehubv2.errors.throttling_exception.ThrottlingException: <p>Too many requests — rate limit exceeded.</p>
        capo_resiliencehubv2.errors.validation_exception.ValidationException: <p>Validation error — invalid input parameters.</p>
        capo_resiliencehubv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_resiliencehubv2.types.list_reports_request.ListReportsRequest]",
    ) -> OperationResponse[
        "capo_resiliencehubv2.types.list_reports_response.ListReportsResponse"
    ]:
        import capo_resiliencehubv2._operations.ngrh_service_core.list_reports

        output, http_response = (
            capo_resiliencehubv2._operations.ngrh_service_core.list_reports.list_reports(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReports")
    )
    input_: capo_resiliencehubv2.types.list_reports_request.ListReportsRequest = {}
    if service_arn is not None:
        input_["service_arn"] = service_arn
    if report_type is not None:
        input_["report_type"] = report_type
    if test_run_id is not None:
        input_["test_run_id"] = test_run_id
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output