Objeto x-amazon-apigateway-integration.responses - Amazon API Gateway
x-amazon-apigateway-integration.responsesEjemplo de

Objeto x-amazon-apigateway-integration.responses

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

Nombre de la propiedad Tipo Descripción
Patrón de estado de respuesta Objeto x-amazon-apigateway-integration.response

Ya sea una expresión regular utilizada para hacer coincidir la respuesta de integración con la respuesta del método, o default para detectar cualquier respuesta que no haya configurado. Para las integraciones HTTP, la RegEx se aplica al código de estado de la respuesta de integración. Para las invocaciones de Lambda, la expresión regular se aplica al campo errorMessage del objeto de información del error que devuelve AWS Lambda como un cuerpo de respuesta de error cuando la ejecución de la función de Lambda produce una excepción.

nota

El nombre de propiedad Patrón de estado de respuesta hace referencia a un código de estado de respuesta o a una expresión regular que describe un grupo de códigos de estado de respuesta. No se corresponde con ningún identificador de un recurso IntegrationResponse en la API REST de API Gateway.

x-amazon-apigateway-integration.responsesEjemplo de

El siguiente ejemplo muestra una lista de respuestas 2xx y 302. Para la respuesta 2xx, la respuesta del método se asigna desde la carga de la respuesta de integración del tipo MIME application/json o application/xml. Esta respuesta utiliza las plantillas de mapeo proporcionadas. Para la respuesta 302, la respuesta del método devuelve un encabezado Location cuyo valor se obtiene de la propiedad redirect.url de la carga de la respuesta de integración. 


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