Tipos de respuestas de gateway - Amazon API Gateway

Tipos de respuestas de gateway

API Gateway expone las siguientes respuestas de gateway para su personalización por desarrolladores de la API.

Tipo de respuesta de gateway Código de estado predeterminado Descripción
ACCESS_DENIED 403

La respuesta de gateway para un error de autorización (por ejemplo, cuando un autorizador de Amazon Cognito o personalizado deniega el acceso). Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

API_CONFIGURATION_ERROR 500

La respuesta de gateway para una configuración de API no válida, incluida cuando una dirección de punto de enlace no válida enviada, cuando falla la descodificación base64 en datos binarios, cuando no se ha habilitado la compatibilidad con los datos binarios o cuando un mapeo de respuesta de integración que no coincide con ninguna plantilla y no se ha configurado ninguna plantilla predeterminada. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_5XX.

AUTHORIZER_CONFIGURATION_ERROR 500

La respuesta de gateway por no poder conectarse a un autorizador de Amazon Cognito o personalizado. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_5XX.

AUTHORIZER_FAILURE 500

La respuesta de gateway cuando un autorizador de Amazon Cognito o personalizado no puede autenticar al intermediario. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_5XX.

BAD_REQUEST_PARAMETERS 400

La respuesta de gateway cuando el parámetro de la solicitud no se puede validar de acuerdo con un validador de solicitudes habilitado. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

BAD_REQUEST_BODY 400

La respuesta de gateway cuando el cuerpo de la solicitud no se puede validar de acuerdo con un validador de solicitudes habilitado. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

DEFAULT_4XX Null

La respuesta de gateway predeterminada para un tipo de respuesta sin especificar con el código de estado 4XX. Si se cambia el código de estado de esta respuesta de gateway, se cambian los códigos de estado de todas las demás respuestas 4XX al nuevo valor. Si se restablece este código de estado a null, se revierten los códigos de estado de todas las demás respuestas 4XX a sus valores originales.

nota

Las respuestas personalizadas de AWS WAF tienen prioridad sobre las respuestas de gateway personalizadas.

DEFAULT_5XX Null

La respuesta de gateway predeterminada para un tipo de respuesta sin especificar con un código de estado 5XX. Si se cambia el código de estado de esta respuesta de gateway, se cambian los códigos de estado de todas las demás respuestas 5XX al nuevo valor. Si se restablece este código de estado a null, se revierten los códigos de estado de todas las demás respuestas 5XX a sus valores originales.

EXPIRED_TOKEN 403

La respuesta de gateway para un error de token de autenticación de AWS caducado. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

INTEGRATION_FAILURE 504

La respuesta de gateway para un error de integración. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_5XX.

INTEGRATION_TIMEOUT 504

La respuesta de gateway para un error de tiempo de espera de la integración agotado. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_5XX.

INVALID_API_KEY 403

La respuesta de gateway para una clave de API no válida enviada para un método que requiere una clave de API. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

INVALID_SIGNATURE 403

La respuesta de gateway para un error de firma de AWS no válida. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

MISSING_AUTHENTICATION_TOKEN 403

La respuesta de gateway para un error de token de autenticación que falta, incluidos los casos en los que el cliente intenta invocar un método o recurso de API no admitido. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

QUOTA_EXCEEDED 429

La respuesta de gateway para el error de cuota del plan de uso superada. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

REQUEST_TOO_LARGE 413

La respuesta de gateway para el error de solicitud demasiado grande. Si no se especifica el tipo de respuesta, se asigna a: HTTP content length exceeded 10485760 bytes.

RESOURCE_NOT_FOUND 404

La respuesta de gateway cuando API Gateway no puede encontrar el recurso especificado después de que la solicitud de API supera la autenticación y autorización, excepto para la autenticación y autorización de la clave de API. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

THROTTLED 429

La respuesta de gateway cuando se exceden los límites de solicitudes de nivel de plan, método, etapa o cuenta. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

UNAUTHORIZED 401

La respuesta de gateway cuando el autorizador de Amazon Cognito o personalizado no puede autenticar al intermediario.

UNSUPPORTED_MEDIA_TYPE 415

La respuesta de gateway cuando una carga es de un tipo de medio no admitido, si se ha habilitado el comportamiento de paso a través estricto. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

WAF_FILTERED 403

La respuesta de gateway cuando AWS WAF bloquea una solicitud. Si no se especifica el tipo de respuesta, se asigna el tipo DEFAULT_4XX.

nota

Las respuestas personalizadas de AWS WAF tienen prioridad sobre las respuestas de gateway personalizadas.