Skip to content

delete_route_request_parameter

delete_route_request_parameter(
    api_id: __string,
    request_parameter_key: __string,
    route_id: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
) -> None

Deletes a route request parameter. Supported only for WebSocket APIs.

Parameters:

  • api_id (__string) –

    The API identifier.

  • request_parameter_key (__string) –

    The route request parameter key.

  • route_id (__string) –

    The route ID.

Raises:

  • 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 delete_route_request_parameter(
    self,
    api_id: "capo_apigatewayv2.types.__string.__string",
    request_parameter_key: "capo_apigatewayv2.types.__string.__string",
    route_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
) -> None:
    """<p>Deletes a route request parameter. Supported only for WebSocket APIs.</p>

    Args:
        api_id: <p>The API identifier.</p>
        request_parameter_key: <p>The route request parameter key.</p>
        route_id: <p>The route ID.</p>

    Raises:
        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.delete_route_request_parameter_request.DeleteRouteRequestParameterRequest]",
    ) -> OperationResponse[None]:
        import capo_apigatewayv2._operations.api_gateway_v2.delete_route_request_parameter

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRouteRequestParameter")
    )
    input_: capo_apigatewayv2.types.delete_route_request_parameter_request.DeleteRouteRequestParameterRequest = {
        "api_id": api_id,
        "request_parameter_key": request_parameter_key,
        "route_id": route_id,
    }

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