get_model ¶

get_model(
    rest_api_id: String,
    model_name: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    flatten: Optional[Boolean] = None,
) -> Model

Describes an existing model defined for a RestApi resource.

Parameters:

rest_api_id (String) –

The RestApi identifier under which the Model exists.
model_name (String) –

The name of the model as an identifier.
flatten (Optional[Boolean], default: None ) –

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

Raises:

BadRequestException –

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
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 get_model(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    model_name: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    flatten: Optional["capo_api_gateway.types.boolean.Boolean"] = None,
) -> "capo_api_gateway.types.model.Model":
    """<p>Describes an existing model defined for a RestApi resource.</p>

    Args:
        rest_api_id: <p>The RestApi identifier under which the Model exists.</p>
        model_name: <p>The name of the model as an identifier.</p>
        flatten: <p>A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and returns a flattened model schema or not (<code>false</code>) The default is <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.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.get_model_request.GetModelRequest]",
    ) -> OperationResponse["capo_api_gateway.types.model.Model"]:
        import capo_api_gateway._operations.backplane_control_service.get_model

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetModel")
    )
    input_: capo_api_gateway.types.get_model_request.GetModelRequest = {
        "rest_api_id": rest_api_id,
        "model_name": model_name,
    }
    if flatten is not None:
        input_["flatten"] = flatten

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