class Aws::APIGateway::Types::Model

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

<div class=“remarks” markdown=“1”> 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.

</div>

<div class=“seeAlso” markdown=“1”> Method, MethodResponse, [Models and Mappings] </div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html

@!attribute [rw] id

The identifier for the model resource.
@return [String]

@!attribute [rw] name

The name of the model. Must be an alphanumeric string.
@return [String]

@!attribute [rw] description

The description of the model.
@return [String]

@!attribute [rw] schema

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

[1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
@return [String]

@!attribute [rw] content_type

The content-type for the model.
@return [String]

Constants

SENSITIVE