Class ErrorModel
(deprecated) Represents a reference to a REST API's Error model, which is available as part of the model collection by default.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class ErrorModel : DeputyBase, IModel
Syntax (vb)
Public Class ErrorModel
Inherits DeputyBase
Implements IModel
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
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();
Synopsis
Constructors
ErrorModel() | |
ErrorModel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
ErrorModel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ModelId | (deprecated) Returns the model name, such as 'myModel'. |
Constructors
ErrorModel()
public ErrorModel()
ErrorModel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected ErrorModel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
ErrorModel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected ErrorModel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ModelId
(deprecated) Returns the model name, such as 'myModel'.
public virtual string ModelId { get; }
Property Value
System.String
Remarks
Stability: Deprecated