Skip to content

get_routing_rule async

get_routing_rule(
    domain_name: __string,
    routing_rule_id: __string,
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    domain_name_id: Optional[__string] = None,
) -> GetRoutingRuleResponse

Gets a routing rule.

Parameters:

  • domain_name (__string) –

    The domain name.

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

    The domain name ID.

  • routing_rule_id (__string) –

    The routing rule ID.

Raises:

  • BadRequestException –

    The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • NotFoundException –

    The resource specified in the request was not found. See the message field for more information.

  • TooManyRequestsException –

    A limit has been exceeded. See the accompanying error message for details.

  • UnknownServiceError –

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

Source code in docs_src/capo_apigatewayv2/_services/async_api_gateway_v2.py
async def get_routing_rule(
    self,
    domain_name: "capo_apigatewayv2.types.__string.__string",
    routing_rule_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    domain_name_id: Optional["capo_apigatewayv2.types.__string.__string"] = None,
) -> "capo_apigatewayv2.types.get_routing_rule_response.GetRoutingRuleResponse":
    """<p>Gets a routing rule.</p>

    Args:
        domain_name: <p>The domain name.</p>
        domain_name_id: <p>The domain name ID.</p>
        routing_rule_id: <p>The routing rule ID.</p>

    Raises:
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_apigatewayv2.types.get_routing_rule_request.GetRoutingRuleRequest]",
    ) -> AsyncOperationResponse[
        "capo_apigatewayv2.types.get_routing_rule_response.GetRoutingRuleResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.get_routing_rule

        (
            output,
            http_response,
        ) = await capo_apigatewayv2._operations.api_gateway_v2.get_routing_rule.async_get_routing_rule(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRoutingRule")
    )
    input_: capo_apigatewayv2.types.get_routing_rule_request.GetRoutingRuleRequest = {
        "domain_name": domain_name,
        "routing_rule_id": routing_rule_id,
    }
    if domain_name_id is not None:
        input_["domain_name_id"] = domain_name_id

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