Skip to content

create_readiness_check

create_readiness_check(
    *,
    config_overrides: Optional[Route53RecoveryReadinessClientConfig] = None,
    readiness_check_name: Optional[__string] = None,
    resource_set_name: Optional[__string] = None,
    tags: Optional[Tags] = None,
) -> CreateReadinessCheckResponse

Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.

Parameters:

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

    The name of the readiness check to create.

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

    The name of the resource set to check.

Raises:

Source code in docs_src/capo_route53_recovery_readiness/_services/route53_recovery_readiness.py
def create_readiness_check(
    self,
    *,
    config_overrides: Optional[Route53RecoveryReadinessClientConfig] = None,
    readiness_check_name: Optional[
        "capo_route53_recovery_readiness.types.__string.__string"
    ] = None,
    resource_set_name: Optional[
        "capo_route53_recovery_readiness.types.__string.__string"
    ] = None,
    tags: Optional["capo_route53_recovery_readiness.types.tags.Tags"] = None,
) -> "capo_route53_recovery_readiness.types.create_readiness_check_response.CreateReadinessCheckResponse":
    """<p>Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.</p>

    Args:
        readiness_check_name: <p>The name of the readiness check to create.</p>
        resource_set_name: <p>The name of the resource set to check.</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.conflict_exception.ConflictException: Updating or deleting a resource can cause an inconsistent state.
        capo_route53_recovery_readiness.errors.internal_server_exception.InternalServerException: An unexpected error occurred.
        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.
    """

    def _handler(
        req: "OperationRequest[capo_route53_recovery_readiness.types.create_readiness_check_request.CreateReadinessCheckRequest]",
    ) -> OperationResponse[
        "capo_route53_recovery_readiness.types.create_readiness_check_response.CreateReadinessCheckResponse"
    ]:
        import capo_route53_recovery_readiness._operations.route53_recovery_readiness.create_readiness_check

        output, http_response = (
            capo_route53_recovery_readiness._operations.route53_recovery_readiness.create_readiness_check.create_readiness_check(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateReadinessCheck")
    )
    input_: capo_route53_recovery_readiness.types.create_readiness_check_request.CreateReadinessCheckRequest = {}
    if readiness_check_name is not None:
        input_["readiness_check_name"] = readiness_check_name
    if resource_set_name is not None:
        input_["resource_set_name"] = resource_set_name
    if tags is not None:
        input_["tags"] = tags

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