Skip to content

create_request_validator

create_request_validator(
    rest_api_id: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    name: Optional[String] = None,
    validate_request_body: Optional[Boolean] = None,
    validate_request_parameters: Optional[Boolean] = None,
) -> RequestValidator

Creates a RequestValidator of a given RestApi.

Parameters:

  • rest_api_id (String) –

    The string identifier of the associated RestApi.

  • name (Optional[String], default: None ) –

    The name of the to-be-created RequestValidator.

  • validate_request_body (Optional[Boolean], default: None ) –

    A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

  • validate_request_parameters (Optional[Boolean], default: None ) –

    A Boolean flag to indicate whether to validate request parameters, true, or not false.

Raises:

  • BadRequestException –

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

  • ConflictException –

    The request configuration has conflicts. For details, see the accompanying error message.

  • LimitExceededException –

    The request exceeded the rate limit. Retry after the specified time period.

  • NotFoundException –

    The requested resource is not found. Make sure that the request URI is correct.

  • TooManyRequestsException –

    The request has reached its throttling limit. Retry after the specified time period.

  • UnauthorizedException –

    The request is denied because the caller has insufficient permissions.

  • UnknownServiceError –

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

Source code in docs_src/capo_api_gateway/_services/api_gateway.py
def create_request_validator(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    name: Optional["capo_api_gateway.types.string.String"] = None,
    validate_request_body: Optional[
        "capo_api_gateway.types.boolean.Boolean"
    ] = None,
    validate_request_parameters: Optional[
        "capo_api_gateway.types.boolean.Boolean"
    ] = None,
) -> "capo_api_gateway.types.request_validator.RequestValidator":
    """<p>Creates a RequestValidator of a given RestApi.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</p>
        name: <p>The name of the to-be-created RequestValidator.</p>
        validate_request_body: <p>A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (<code>true</code>) or not (<code>false</code>).</p>
        validate_request_parameters: <p>A Boolean flag to indicate whether to validate request parameters, <code>true</code>, or not <code>false</code>.</p>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_api_gateway.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded the rate limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_api_gateway.types.create_request_validator_request.CreateRequestValidatorRequest]",
    ) -> OperationResponse[
        "capo_api_gateway.types.request_validator.RequestValidator"
    ]:
        import capo_api_gateway._operations.backplane_control_service.create_request_validator

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.create_request_validator.create_request_validator(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRequestValidator")
    )
    input_: capo_api_gateway.types.create_request_validator_request.CreateRequestValidatorRequest = {
        "rest_api_id": rest_api_id
    }
    if name is not None:
        input_["name"] = name
    if validate_request_body is not None:
        input_["validate_request_body"] = validate_request_body
    if validate_request_parameters is not None:
        input_["validate_request_parameters"] = validate_request_parameters

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