Types de réponses de passerelle

API Gateway expose les réponses de passerelle suivantes pour personnalisation par les développeurs d'API.

Type de réponse de passerelle	Code de statut par défaut	Description
ACCESS_DENIED	403	Réponse de passerelle pour un échec d'autorisation, par exemple, lorsque l'accès est refusé par un mécanisme d'autorisation personnalisée ou Amazon Cognito. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
API_CONFIGURATION_ERROR	500	Réponse de passerelle pour une configuration d'API non valide, y compris une adresse de point de terminaison non valide soumise, l'échec du décodage base64 sur des données binaires lorsque la prise en charge binaire est activée, ou un mappage de réponse d'intégration qui ne peut correspondre à aucun modèle alors qu'aucun modèle par défaut n'est configuré. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_5XX.
AUTHORIZER_CONFIGURATION_ERROR	500	Réponse de passerelle pour un échec de connexion à un mécanisme d'autorisation personnalisée ou Amazon Cognito. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_5XX.
AUTHORIZER_FAILURE	500	Réponse de passerelle quand un mécanisme d'autorisation personnalisée ou Amazon Cognito n'a pas pu authentifier l'appelant. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_5XX.
BAD_REQUEST_PARAMETERS	400	Réponse de passerelle quand le paramètre de demande ne peut pas être validé selon un valideur de demande activé. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
BAD_REQUEST_BODY	400	Réponse de passerelle quand le corps de demande ne peut pas être validé selon un valideur de demande activé. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
DEFAULT_4XX	Null	Réponse de passerelle par défaut pour un type de réponse non spécifié avec le code de statut 4XX. La modification du code de statut de cette réponse de passerelle de rechange modifie les codes de statut de toutes les autres réponses 4XX sur une nouvelle valeur. La réinitialisation de ce code de statut à null rétablit les valeurs d'origine des codes de statut de toutes les autres réponses 4XX. Note Les réponses personnalisées AWS WAF ont la priorité sur les réponses de passerelle personnalisées.
DEFAULT_5XX	Null	Réponse de passerelle par défaut pour un type de réponse non spécifié avec un code de statut 5XX. La modification du code de statut de cette réponse de passerelle de rechange modifie les codes de statut de toutes les autres réponses 5XX sur une nouvelle valeur. La réinitialisation de ce code de statut à null rétablit les valeurs d'origine des codes de statut de toutes les autres réponses 5XX.
EXPIRED_TOKEN	403	La réponse de passerelle pour une erreur d'expiration de jeton d'authentification AWS. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
INTEGRATION_FAILURE	504	Réponse de passerelle pour une erreur d'échec d'intégration. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_5XX.
INTEGRATION_TIMEOUT	504	Réponse de passerelle pour une erreur d'intégration expirée. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_5XX.
INVALID_API_KEY	403	Réponse de passerelle pour une clé d'API non valide soumise pour une méthode nécessitant une clé API. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
INVALID_SIGNATURE	403	La réponse de passerelle pour une erreur de signature AWS non valide. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
MISSING_AUTHENTICATION_TOKEN	403	Réponse de passerelle pour une erreur de jeton d'authentification manquant, y compris les cas où le client tente d'appeler une méthode ou une ressource d'API non prise en charge. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
QUOTA_EXCEEDED	429	Réponse de passerelle pour une erreur de dépassement de quota de plan d'utilisation. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
REQUEST_TOO_LARGE	413	Réponse de passerelle pour une erreur de demande trop volumineuse. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
RESOURCE_NOT_FOUND	404	Réponse de passerelle quand API Gateway ne peut pas trouver la ressource spécifiée après qu'une demande d'API a transmis une authentification et une autorisation, sauf pour une authentification et une autorisation de clé API. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
THROTTLED	429	Réponse de passerelle quand des limitations d'un plan d'utilisation sont dépassées au niveau de la méthode, de l'étape ou du compte. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
UNAUTHORIZED	401	Réponse de passerelle quand le mécanisme d'autorisation personnalisée ou Amazon Cognito n'a pas pu authentifier l'appelant.
UNSUPPORTED_MEDIA_TYPE	415	Réponse de passerelle quand une charge utile est d'un type de média non pris en charge, si le comportement de transmission strict est activé. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX.
WAF_FILTERED	403	La réponse de passerelle quand une demande est bloquée par AWS WAF. Si le type de réponse n'est pas spécifié, cette réponse est définie par défaut sur le type DEFAULT_4XX. Note Les réponses personnalisées AWS WAF ont la priorité sur les réponses de passerelle personnalisées.