ErrorModel

class aws_cdk.aws_apigateway.ErrorModel

Bases: object

(deprecated) Represents a reference to a REST API’s Error model, which is available as part of the model collection by default.

This can be used for mapping error JSON responses from an integration to a client, where a simple generic message field is sufficient to map and return an error payload.

Definition { “$schema” : “http://json-schema.org/draft-04/schema#”, “title” : “Error Schema”, “type” : “object”, “properties” : { “message” : { “type” : “string” } } }

Deprecated:

You should use Model.ERROR_MODEL

Stability:

deprecated

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

error_model = apigateway.ErrorModel()

Attributes

model_id

(deprecated) Returns the model name, such as ‘myModel’.

Stability:

deprecated