RequestModel - AWS Serverless Application Model

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

RequestModel

Configura un modelo de solicitud para una API concreta+ruta+método.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

Model: String Required: Boolean ValidateBody: Boolean ValidateParameters: Boolean

Properties

Model

Nombre de un modelo definido en la propiedad Models delAWS::Serverless::Api.

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Este establecimiento es específico deAWS SAMy no tieneAWS CloudFormationequivalente.

Required

Adición de unrequireden la sección de parámetros de la definición de OpenAPI para el punto final de la API dado.

Type: Booleano

Obligatorio: No

AWS CloudFormationcompatibilidad: Este establecimiento es específico deAWS SAMy no tieneAWS CloudFormationequivalente.

ValidateBody

Especifica si API Gateway utiliza elModelpara validar el cuerpo de la solicitud. Para obtener más información, consulteHabilitar la validación de solicitudes en API Gatewayen laGuía para desarrolladores API Gateway.

Type: Booleano

Obligatorio: No

AWS CloudFormationcompatibilidad: Este establecimiento es específico deAWS SAMy no tieneAWS CloudFormationequivalente.

ValidateParameters

Especifica si API Gateway utiliza elModelpara validar los parámetros de ruta de solicitud, cadenas de consulta y encabezados. Para obtener más información, consulteHabilitar la validación de solicitudes en API Gatewayen laGuía para desarrolladores API Gateway.

Type: Booleano

Obligatorio: No

AWS CloudFormationcompatibilidad: Este establecimiento es específico deAWS SAMy no tieneAWS CloudFormationequivalente.

Ejemplos

Modelo de solicitud

Ejemplo de modelo de solicitud

YAML

RequestModel: Model: User Required: true ValidateBody: true ValidateParameters: true