create_model ¶

create_model(
    rest_api_id: String,
    name: String,
    content_type: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    description: Optional[String] = None,
    schema: Optional[String] = None,
) -> Model

Adds a new Model resource to an existing RestApi resource.

Parameters:

rest_api_id (String) –

The RestApi identifier under which the Model will be created.
name (String) –

The name of the model. Must be alphanumeric.
description (Optional[String], default: None ) –

The description of the model.
schema (Optional[String], default: None ) –

The schema for the model. For application/json models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.
content_type (String) –

The content-type for the model.

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_model(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    name: "capo_api_gateway.types.string.String",
    content_type: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    description: Optional["capo_api_gateway.types.string.String"] = None,
    schema: Optional["capo_api_gateway.types.string.String"] = None,
) -> "capo_api_gateway.types.model.Model":
    """<p>Adds a new Model resource to an existing RestApi resource.</p>

    Args:
        rest_api_id: <p>The RestApi identifier under which the Model will be created.</p>
        name: <p>The name of the model. Must be alphanumeric.</p>
        description: <p>The description of the model.</p>
        schema: <p>The schema for the model. For <code>application/json</code> models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.</p>
        content_type: <p>The content-type for the model.</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_model_request.CreateModelRequest]",
    ) -> OperationResponse["capo_api_gateway.types.model.Model"]:
        import capo_api_gateway._operations.backplane_control_service.create_model

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateModel")
    )
    input_: capo_api_gateway.types.create_model_request.CreateModelRequest = {
        "rest_api_id": rest_api_id,
        "name": name,
        "content_type": content_type,
    }
    if description is not None:
        input_["description"] = description
    if schema is not None:
        input_["schema"] = schema

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