Transmisión de la respuesta de integración para las integraciones de proxy en API Gateway

Puede configurar la integración de proxy para controlar cómo API Gateway devuelve la respuesta de integración. De forma predeterminada, API Gateway espera a recibir la respuesta completa antes de iniciar la transmisión. Sin embargo, si configura el modo de transferencia de respuestas de la integración en STREAM, API Gateway no espera a que se calcule completamente la respuesta para enviarla al cliente. La transmisión de respuestas funciona para todos los tipos de puntos de conexión de la API de REST.

Utilice la transmisión de respuestas para los siguientes casos de uso:

• Reduzca el tiempo para el primer byte (TTFB) para aplicaciones de IA generativa como los chatbots.

• Transmita archivos de imágenes, vídeos o música de gran tamaño sin utilizar una URL prefirmada de S3.

• Realice operaciones de larga duración y, al mismo tiempo, informe sobre el progreso incremental, como los eventos enviados por el servidor (SSE).

• Supere el límite de carga útil de respuesta de 10 MB de API Gateway.

• Supera el límite de 29 segundos de API Gateway sin solicitar un aumento del tiempo de espera de la integración.

• Reciba una carga útil binaria sin configurar los tipos de medios binarios.

Consideraciones sobre la transmisión de la carga útil de respuesta

Es posible que las siguientes consideraciones afecten al uso de la transmisión de la carga útil de respuesta:

• Solo puede utilizar la transmisión de carga útil de respuesta para tipos de integración HTTP_PROXY o AWS_PROXY. Esto incluye las integraciones de proxy de Lambda y las integraciones privadas que utilizan integraciones de HTTP_PROXY.

• La configuración predeterminada del modo de transferencia es BUFFERED. Para utilizar la transmisión de respuestas, debe cambiar el modo de transferencia de respuesta a STREAM.

• La transmisión de respuestas solo es compatible con las API de REST.

• La transmisión de solicitudes es incompatible.

• Puede transmitir su respuesta durante 15 minutos como máximo.

• Las transmisiones están sujetas a tiempos de espera por inactividad. Para puntos de conexión regionales o privados, el tiempo de espera es de 5 minutos. Para puntos de conexión optimizados para bordes, el tiempo de espera es de 30 segundos.

• Si utiliza la transmisión de respuesta para una API de REST regional con su propia distribución de CloudFront, puede lograr un tiempo de espera por inactividad de más de 30 segundos lo que aumenta el tiempo de espera de respuesta de la distribución de CloudFront. Para obtener más información, consulte Tiempo de espera de respuesta.

• Cuando el modo de transferencia de respuestas está configurado en STREAM, API Gateway no admite características que requieran almacenar en búfer toda la respuesta de integración. Por este motivo, las siguientes características no son compatibles con la transmisión de respuestas:

  • Almacenamiento en caché de puntos de conexión

  • Codificación de contenido. Si desea comprimir su respuesta de integración, hágalo en su integración.

  • Transformación de la respuesta con VTL

• Dentro de cada respuesta de transmisión, los primeros 10 MB de carga útil de respuesta no están sujetos a ninguna restricción de ancho de banda. Los datos de carga útil de respuesta que superen los 10 MB están restringidos a 2 MB/s.

• Cuando la conexión entre el cliente y API Gateway o entre API Gateway y Lambda se cierra debido al tiempo de espera, es posible que la función de Lambda continúe ejecutándose. Para obtener más información, consulte Configuración del tiempo de espera de la función de Lambda.

• La transmisión de respuestas tiene un costo. Para obtener más información, consulte Precio de API Gateway.