AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Inheritance Hierarchy

System.Object
  Amazon.APIGateway.Model.Model

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class Model

The Model type exposes the following members

Constructors

NameDescription
Public Method Model()

Properties

NameTypeDescription
Public Property ContentType System.String

Gets and sets the property ContentType.

The content-type for the model.

Public Property Description System.String

Gets and sets the property Description.

The description of the model.

Public Property Id System.String

Gets and sets the property Id.

The identifier for the model resource.

Public Property Name System.String

Gets and sets the property Name.

The name of the model. Must be an alphanumeric string.

Public Property Schema System.String

Gets and sets the property Schema.

The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms