Skip to content

get_recovery_group_readiness_summary async

get_recovery_group_readiness_summary(
    recovery_group_name: __string,
    *,
    config_overrides: Optional[AsyncRoute53RecoveryReadinessClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[__string] = None,
) -> GetRecoveryGroupReadinessSummaryResponse

Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.

Parameters:

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

    The number of objects that you want to return with this call.

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

    The token that identifies which batch of results you want to see.

  • recovery_group_name (__string) –

    The name of a recovery group.

Raises:

Source code in docs_src/capo_route53_recovery_readiness/_services/async_route53_recovery_readiness.py
async def get_recovery_group_readiness_summary(
    self,
    recovery_group_name: "capo_route53_recovery_readiness.types.__string.__string",
    *,
    config_overrides: Optional[AsyncRoute53RecoveryReadinessClientConfig] = None,
    max_results: Optional[
        "capo_route53_recovery_readiness.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_route53_recovery_readiness.types.__string.__string"
    ] = None,
) -> "capo_route53_recovery_readiness.types.get_recovery_group_readiness_summary_response.GetRecoveryGroupReadinessSummaryResponse":
    """<p>Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.</p>

    Args:
        max_results: <p>The number of objects that you want to return with this call.</p>
        next_token: <p>The token that identifies which batch of results you want to see.</p>
        recovery_group_name: <p>The name of a recovery group.</p>

    Raises:
        capo_route53_recovery_readiness.errors.access_denied_exception.AccessDeniedException: User does not have sufficient access to perform this action.
        capo_route53_recovery_readiness.errors.internal_server_exception.InternalServerException: An unexpected error occurred.
        capo_route53_recovery_readiness.errors.resource_not_found_exception.ResourceNotFoundException: The requested resource does not exist.
        capo_route53_recovery_readiness.errors.throttling_exception.ThrottlingException: Request was denied due to request throttling.
        capo_route53_recovery_readiness.errors.validation_exception.ValidationException: The input fails to satisfy the constraints specified by an AWS service.
        capo_route53_recovery_readiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_route53_recovery_readiness.types.get_recovery_group_readiness_summary_request.GetRecoveryGroupReadinessSummaryRequest]",
    ) -> AsyncOperationResponse[
        "capo_route53_recovery_readiness.types.get_recovery_group_readiness_summary_response.GetRecoveryGroupReadinessSummaryResponse"
    ]:
        import capo_route53_recovery_readiness._operations.route53_recovery_readiness.get_recovery_group_readiness_summary

        (
            output,
            http_response,
        ) = await capo_route53_recovery_readiness._operations.route53_recovery_readiness.get_recovery_group_readiness_summary.async_get_recovery_group_readiness_summary(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRecoveryGroupReadinessSummary")
    )
    input_: capo_route53_recovery_readiness.types.get_recovery_group_readiness_summary_request.GetRecoveryGroupReadinessSummaryRequest = {
        "recovery_group_name": recovery_group_name
    }
    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