Objeto x-amazon-apigateway-integration.response - Amazon API Gateway
x-amazon-apigateway-integration.responseEjemplo de

Objeto x-amazon-apigateway-integration.response

Define una respuesta y especifica asignaciones de parámetros o asignaciones de carga desde la respuesta de integración a la respuesta del método.

Nombre de la propiedad Tipo Descripción
statusCode string

Código de estado HTTP para la respuesta de método (por ejemplo,, "200". Se debe corresponder con una respuesta coincidente en el campo OpenAPI Operation responses.
responseTemplates Objeto x-amazon-apigateway-integration.responseTemplates

Especifica las plantillas de mapeo específicas del tipo MIME para la carga de la respuesta.
responseParameters Objeto x-amazon-apigateway-integration.responseParameters

Especifica las asignaciones de parámetros para la respuesta. Solo los parámetros header y body de la respuesta de integración se pueden asignar a los parámetros header del método.

contentHandling string Tipos de conversión de codificación de la carga de la respuesta. Los valores válidos son 1) CONVERT_TO_TEXT, para convertir una carga binaria en una cadena codificada en base64 o para convertir una carga de texto en una cadena codificada en utf-8 o para transferir la carga de texto de forma nativa sin modificaciones, y 2) CONVERT_TO_BINARY, para convertir una carga de texto en un blob descodificado en base64 o para transferir una carga binaria de forma nativa sin modificaciones.

x-amazon-apigateway-integration.responseEjemplo de

El siguiente ejemplo define una respuesta 302 para el método que obtiene una carga del tipo MIME application/json o application/xml del backend. La respuesta utiliza las plantillas de mapeo proporcionadas y devuelve la URL de redireccionamiento de la respuesta de integración en el encabezado Location del método. 


{
    "statusCode" : "302",
    "responseTemplates" : {
         "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }",
         "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> "
    },
    "responseParameters" : {
        "method.response.header.Location": "integration.response.body.redirect.url"
    }
}