Skip to content

describe_routing_control async

describe_routing_control(
    routing_control_arn: __string,
    *,
    config_overrides: Optional[AsyncRoute53RecoveryControlConfigClientConfig] = None,
) -> DescribeRoutingControlResponse

Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Parameters:

  • routing_control_arn (__string) –

    The Amazon Resource Name (ARN) of the routing control.

Raises:

  • AccessDeniedException –

    403 response - You do not have sufficient access to perform this action.

  • ConflictException –

    409 response - ConflictException. You might be using a predefined variable.

  • InternalServerException –

    500 response - InternalServiceError. Temporary service error. Retry the request.

  • ResourceNotFoundException –

    404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

  • ThrottlingException –

    429 response - LimitExceededException or TooManyRequestsException.

  • ValidationException –

    400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_route53_recovery_control_config/_services/async_route53_recovery_control_config.py
async def describe_routing_control(
    self,
    routing_control_arn: "capo_route53_recovery_control_config.types.__string.__string",
    *,
    config_overrides: Optional[
        AsyncRoute53RecoveryControlConfigClientConfig
    ] = None,
) -> "capo_route53_recovery_control_config.types.describe_routing_control_response.DescribeRoutingControlResponse":
    """<p>Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.</p> <p>To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.</p>

    Args:
        routing_control_arn: <p>The Amazon Resource Name (ARN) of the routing control.</p>

    Raises:
        capo_route53_recovery_control_config.errors.access_denied_exception.AccessDeniedException: <p>403 response - You do not have sufficient access to perform this action.</p>
        capo_route53_recovery_control_config.errors.conflict_exception.ConflictException: <p>409 response - ConflictException. You might be using a predefined variable.</p>
        capo_route53_recovery_control_config.errors.internal_server_exception.InternalServerException: <p>500 response - InternalServiceError. Temporary service error. Retry the request.</p>
        capo_route53_recovery_control_config.errors.resource_not_found_exception.ResourceNotFoundException: <p>404 response - MalformedQueryString. The query string contains a syntax error or resource not found.</p>
        capo_route53_recovery_control_config.errors.throttling_exception.ThrottlingException: <p>429 response - LimitExceededException or TooManyRequestsException.</p>
        capo_route53_recovery_control_config.errors.validation_exception.ValidationException: <p>400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.</p>
        capo_route53_recovery_control_config.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_route53_recovery_control_config.types.describe_routing_control_request.DescribeRoutingControlRequest]",
    ) -> AsyncOperationResponse[
        "capo_route53_recovery_control_config.types.describe_routing_control_response.DescribeRoutingControlResponse"
    ]:
        import capo_route53_recovery_control_config._operations.route53_recovery_control_config.describe_routing_control

        (
            output,
            http_response,
        ) = await capo_route53_recovery_control_config._operations.route53_recovery_control_config.describe_routing_control.async_describe_routing_control(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRoutingControl")
    )
    input_: capo_route53_recovery_control_config.types.describe_routing_control_request.DescribeRoutingControlRequest = {
        "routing_control_arn": routing_control_arn
    }

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