Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Diffusez la réponse d'intégration pour vos intégrations de proxy dans API Gateway
Vous pouvez configurer l’intégration de votre proxy pour contrôler comment API Gateway renvoie votre réponse d’intégration. Par défaut, API Gateway attend de recevoir la réponse complète avant de commencer la transmission. Toutefois, si vous définissez le mode de transfert des réponses de votre intégration surSTREAM, API Gateway n'attend pas qu'une réponse soit complètement calculée avant de l'envoyer au client. Le streaming des réponses fonctionne pour tous les types de points de terminaison de l’API REST.
Utilisez le streaming de réponses dans les cas d'utilisation suivants :
-
Réduisez le time-to-first-byte (TTFB) pour les applications d'IA génératives telles que les chatbots.
-
Diffusez de gros fichiers d'image, de vidéo ou de musique sans utiliser d'URL pré-signée S3.
-
Réalisez des opérations de longue durée tout en signalant les progrès progressifs, tels que les événements envoyés par le serveur (SSE).
-
Dépassez la limite de charge utile de réponse de 10 Mo d'API Gateway.
Dépassez le délai d'expiration de 29 secondes d'API Gateway sans demander d'augmentation du délai d'intégration.
Recevez une charge utile binaire sans configurer les types de supports binaires.
Considérations relatives au streaming de la charge utile de réponse
Les considérations suivantes peuvent avoir un impact sur votre utilisation du streaming de la charge utile de réponse :
-
Vous ne pouvez utiliser le streaming de charge utile de réponse que pour les types d'
AWS_PROXYintégrationHTTP_PROXYou d'intégration. Cela inclut les intégrations de proxy Lambda et les intégrations privées qui utilisent des intégrations.HTTP_PROXY Le paramètre du mode de transfert par défaut est
BUFFERED. Pour utiliser le streaming de réponses, vous devez changer le mode de transfert de réponse surSTREAM.-
Le streaming des réponses n'est pris en charge que pour REST APIs.
-
Les demandes de streaming ne sont pas prises en charge.
-
Vous pouvez diffuser votre réponse pendant 15 minutes maximum.
Vos streams sont sujets à des délais d'inactivité. Pour les points de terminaison régionaux ou privés, le délai d'expiration est de 5 minutes. Pour les points de terminaison optimisés pour les bords, le délai d'expiration est de 30 secondes.
-
Si vous utilisez le streaming de réponses pour une API REST régionale avec votre propre CloudFront distribution, vous pouvez atteindre un temps d'inactivité supérieur à 30 secondes en augmentant le délai de réponse de votre CloudFront distribution. Pour plus d'informations, consultez la section Délai de réponse.
-
Lorsque le mode de transfert des réponses est défini sur
STREAM, API Gateway ne peut pas prendre en charge les fonctionnalités qui nécessitent de mettre en mémoire tampon l'intégralité de la réponse d'intégration. Pour cette raison, les fonctionnalités suivantes ne sont pas prises en charge par le streaming de réponses :Mise en cache des terminaux
-
Codage du contenu. Si vous souhaitez compresser votre réponse d'intégration, faites-le dans votre intégration.
Transformation des réponses avec VTL
-
Dans chaque réponse de streaming, les 10 premiers Mo de charge utile de réponse ne sont soumis à aucune restriction de bande passante. Les données de charge utile de réponse supérieures à 10 Mo sont limitées à 2 Mo/s.
-
Lorsque la connexion entre le client et API Gateway ou entre API Gateway et Lambda est fermée en raison d'un délai d'attente, la fonction Lambda peut continuer à s'exécuter. Pour plus d'informations, voir Configurer le délai d'expiration de la fonction Lambda.
-
Le streaming des réponses entraîne un coût. Pour plus d’informations, consultez API Gateway Pricing
(Tarification d’API Gateway).
