Skip to content

put_routing_rule

put_routing_rule(
    domain_name: __string,
    routing_rule_id: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    actions: Optional[__listOfRoutingRuleAction] = None,
    conditions: Optional[__listOfRoutingRuleCondition] = None,
    domain_name_id: Optional[__string] = None,
    priority: Optional[RoutingRulePriority] = None,
) -> PutRoutingRuleResponse

Updates a routing rule.

Parameters:

Raises:

  • BadRequestException –

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

  • ConflictException –

    The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. 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/api_gateway_v2.py
def put_routing_rule(
    self,
    domain_name: "capo_apigatewayv2.types.__string.__string",
    routing_rule_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    actions: Optional[
        "capo_apigatewayv2.types.__list_of_routing_rule_action.__listOfRoutingRuleAction"
    ] = None,
    conditions: Optional[
        "capo_apigatewayv2.types.__list_of_routing_rule_condition.__listOfRoutingRuleCondition"
    ] = None,
    domain_name_id: Optional["capo_apigatewayv2.types.__string.__string"] = None,
    priority: Optional[
        "capo_apigatewayv2.types.routing_rule_priority.RoutingRulePriority"
    ] = None,
) -> "capo_apigatewayv2.types.put_routing_rule_response.PutRoutingRuleResponse":
    """<p>Updates a routing rule.</p>

    Args:
        actions: <p>The routing rule action.</p>
        conditions: <p>The routing rule condition.</p>
        domain_name: <p>The domain name.</p>
        domain_name_id: <p>The domain name ID.</p>
        priority: <p>The routing rule priority.</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.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. 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.
    """

    def _handler(
        req: "OperationRequest[capo_apigatewayv2.types.put_routing_rule_request.PutRoutingRuleRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.put_routing_rule_response.PutRoutingRuleResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.put_routing_rule

        output, http_response = (
            capo_apigatewayv2._operations.api_gateway_v2.put_routing_rule.put_routing_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutRoutingRule")
    )
    input_: capo_apigatewayv2.types.put_routing_rule_request.PutRoutingRuleRequest = {
        "domain_name": domain_name,
        "routing_rule_id": routing_rule_id,
    }
    if actions is not None:
        input_["actions"] = actions
    if conditions is not None:
        input_["conditions"] = conditions
    if domain_name_id is not None:
        input_["domain_name_id"] = domain_name_id
    if priority is not None:
        input_["priority"] = priority

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