delete_route_settings ¶

delete_route_settings(
    api_id: __string,
    route_key: __string,
    stage_name: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
) -> None

Deletes the RouteSettings for a stage.

Parameters:

api_id (__string) –

The API identifier.
route_key (__string) –

The route key.
stage_name (__string) –

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

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_settings(
    self,
    api_id: "capo_apigatewayv2.types.__string.__string",
    route_key: "capo_apigatewayv2.types.__string.__string",
    stage_name: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
) -> None:
    """<p>Deletes the RouteSettings for a stage.</p>

    Args:
        api_id: <p>The API identifier.</p>
        route_key: <p>The route key.</p>
        stage_name: <p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</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_settings_request.DeleteRouteSettingsRequest]",
    ) -> OperationResponse[None]:
        import capo_apigatewayv2._operations.api_gateway_v2.delete_route_settings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRouteSettings")
    )
    input_: capo_apigatewayv2.types.delete_route_settings_request.DeleteRouteSettingsRequest = {
        "api_id": api_id,
        "route_key": route_key,
        "stage_name": stage_name,
    }

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