API Gateway Model

An API Gateway Model in AWS defines the data structure for request and response payloads in an API. It uses JSON schema to specify the format, validation rules, and data types, helping ensure that client requests and backend responses follow a consistent contract. Models improve API reliability by validating input before it reaches backend services.

aws.apigateway_model

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
content_typecorestringThe content-type for the model.
descriptioncorestringThe description of the model.
idcorestringThe identifier for the model resource.
namecorestringThe name of the model. Must be an alphanumeric string.
schemacorestringThe 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.
tagscorehstore