Model - Amazon API Gateway
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Model

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

Contents

contentType

The content-type for the model.

Type: String

Required: No

description

The description of the model.

Type: String

Required: No

id

The identifier for the model resource.

Type: String

Required: No

name

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

Type: String

Required: No

schema

The schema for the model. For application/json models, this should be JSON schema draft 4 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.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: