Table of Contents

Class ErrorModel

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

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

[Obsolete("You should use Model.ERROR_MODEL")]
public class ErrorModel : DeputyBase, IModel
Inheritance
ErrorModel
Implements

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var errorModel = new ErrorModel();

Remarks

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" } } }

Stability: Deprecated

ExampleMetadata: fixture=_generated

Constructors

ErrorModel() 

public ErrorModel()

Properties

ModelId

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

[Obsolete]
public virtual string ModelId { get; }

Property Value

string

Remarks

Stability: Deprecated