API Gateway Model

An API Gateway Model in AWS defines the data structure for request and response payloads in API Gateway. It uses JSON schema to validate and transform data exchanged between clients and backend services. Models help ensure that incoming requests meet expected formats and that responses are consistent, improving reliability and reducing errors in API communication.

aws.apigatewayv2_model

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
content_typecorestringThe content-type for the model, for example, "application/json".
descriptioncorestringThe description of the model.
model_idcorestringThe model identifier.
namecorestringThe name of the model. Must be alphanumeric.
schemacorestringThe schema for the model. For application/json models, this should be JSON schema draft 4 model.
tagscorehstore