Skip to content

list_failure_mode_assessments async

list_failure_mode_assessments(
    service_arn: Arn,
    *,
    config_overrides: Optional[Asyncresiliencehubv2ClientConfig] = None,
    assessment_statuses: Optional[AssessmentStatusList] = None,
    started_after: Optional[datetime] = None,
    ended_before: Optional[datetime] = None,
    sort_by: Optional[AssessmentSortField] = None,
    sort_order: Optional[SortOrder] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListFailureModeAssessmentsResponse

Lists failure mode assessments.

Parameters:

  • assessment_statuses (Optional[AssessmentStatusList], default: None ) –

    Specifies the assessment statuses to include in the results.

  • started_after (Optional[datetime], default: None ) –

    Specifies that only assessments that started at or after this timestamp appear in the results.

  • ended_before (Optional[datetime], default: None ) –

    Specifies that only assessments that ended at or before this timestamp appear in the results.

  • sort_by (Optional[AssessmentSortField], default: None ) –

    The field to use for sorting failure mode assessments.

  • sort_order (Optional[SortOrder], default: None ) –

    The sort order for results.

Raises:

Source code in docs_src/capo_resiliencehubv2/_services/async_resiliencehubv2.py
async def list_failure_mode_assessments(
    self,
    service_arn: "capo_resiliencehubv2.types.arn.Arn",
    *,
    config_overrides: Optional[Asyncresiliencehubv2ClientConfig] = None,
    assessment_statuses: Optional[
        "capo_resiliencehubv2.types.assessment_status_list.AssessmentStatusList"
    ] = None,
    started_after: Optional[datetime.datetime] = None,
    ended_before: Optional[datetime.datetime] = None,
    sort_by: Optional[
        "capo_resiliencehubv2.types.assessment_sort_field.AssessmentSortField"
    ] = None,
    sort_order: Optional["capo_resiliencehubv2.types.sort_order.SortOrder"] = 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_failure_mode_assessments_response.ListFailureModeAssessmentsResponse":
    """<p>Lists failure mode assessments.</p>

    Args:
        assessment_statuses: <p>Specifies the assessment statuses to include in the results.</p>
        started_after: <p>Specifies that only assessments that started at or after this timestamp appear in the results.</p>
        ended_before: <p>Specifies that only assessments that ended at or before this timestamp appear in the results.</p>
        sort_by: <p>The field to use for sorting failure mode assessments.</p>
        sort_order: <p>The sort order for results.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_resiliencehubv2.types.list_failure_mode_assessments_request.ListFailureModeAssessmentsRequest]",
    ) -> AsyncOperationResponse[
        "capo_resiliencehubv2.types.list_failure_mode_assessments_response.ListFailureModeAssessmentsResponse"
    ]:
        import capo_resiliencehubv2._operations.ngrh_service_core.list_failure_mode_assessments

        (
            output,
            http_response,
        ) = await capo_resiliencehubv2._operations.ngrh_service_core.list_failure_mode_assessments.async_list_failure_mode_assessments(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFailureModeAssessments")
    )
    input_: capo_resiliencehubv2.types.list_failure_mode_assessments_request.ListFailureModeAssessmentsRequest = {
        "service_arn": service_arn
    }
    if assessment_statuses is not None:
        input_["assessment_statuses"] = assessment_statuses
    if started_after is not None:
        input_["started_after"] = started_after
    if ended_before is not None:
        input_["ended_before"] = ended_before
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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