Amazon API Gateway
開発者ガイド

ゲートウェイレスポンスのタイプ

API Gateway では、API 開発者がカスタマイズできる以下のゲートウェイレスポンスを公開しています。

ゲートウェイレスポンスのタイプ デフォルトのステータスコード 説明
ACCESS_DENIED 403

認証が失敗した場合のゲートウェイレスポンス。たとえば、カスタムまたは Amazon Cognito オーソライザーによってアクセスが拒否された場合などが該当します。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

API_CONFIGURATION_ERROR 500

API 設定が無効な場合のゲートウェイレスポンス。たとえば、無効なエンドポイントアドレスが送信された場合、バイナリサポートが有効になっているときにバイナリデータに対する Base64 デコーディングが失敗した場合、統合レスポンスマッピングがいずれのテンプレートとも一致せず、デフォルトテンプレートも設定されていない場合などが該当します。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_5XX タイプになります。

AUTHORIZER_CONFIGURATION_ERROR 500

カスタムまたは Amazon Cognito オーソライザーへの接続が失敗した場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_5XX タイプになります。

AUTHORIZER_FAILURE 500

カスタムまたは Amazon Cognito オーソライザーが発信者の認証に失敗した場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_5XX タイプになります。

BAD_REQUEST_PARAMETERS 400

有効になっているリクエストの検証に基づいてリクエストパラメータを検証できない場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

BAD_REQUEST_BODY 400

有効になっているリクエストの検証に基づいてリクエストボディを検証できない場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

DEFAULT_4XX Null

レスポンスタイプが未指定で、ステータスコードが 4XX のデフォルトのゲートウェイレスポンス。このフォールバックゲートウェイレスポンスのステータスコードを変更すると、他のすべての 4XX レスポンスのステータスコードが新しい値に変更されます。このステータスコードを null にリセットすると、他のすべての 4XX レスポンスのステータスコードが元の値に戻ります。

DEFAULT_5XX Null

レスポンスタイプが未指定で、ステータスコードが 5XX のデフォルトのゲートウェイレスポンス。このフォールバックゲートウェイレスポンスのステータスコードを変更すると、他のすべての 5XX レスポンスのステータスコードが新しい値に変更されます。このステータスコードを null にリセットすると、他のすべての 5XX レスポンスのステータスコードが元の値に戻ります。

EXPIRED_TOKEN 403

AWS 認証トークンの有効期限が切れた場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

INTEGRATION_FAILURE 504

統合が失敗した場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_5XX タイプになります。

INTEGRATION_TIMEOUT 504

統合がタイムアウトした場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_5XX タイプになります。

INVALID_API_KEY 403

API キーを必要としているメソッドに対して無効な API キーが送信された場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

INVALID_SIGNATURE 403

AWS 署名が無効な場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

MISSING_AUTHENTICATION_TOKEN 403

認証トークンが見つからない場合のゲートウェイレスポンス。サポートされていない API メソッドやリソースをクライアントが呼び出そうとした場合などが該当します。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

QUOTA_EXCEEDED 429

使用量プランのクォータが超過した場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

REQUEST_TOO_LARGE 413

リクエストが大きすぎる場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

RESOURCE_NOT_FOUND 404

API リクエストが認証および認可 (API キー認証および認可を除く) に合格した後で、指定されたリソースを API Gateway で見つけることができない場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

THROTTLED 429

使用量プランレベル、メソッドレベル、ステージレベル、またはアカウントレベルのスロットリング制限を超えた場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

UNAUTHORIZED 401

カスタムまたは Amazon Cognito オーソライザーが発信者の認証に失敗した場合のゲートウェイレスポンス。

UNSUPPORTED_MEDIA_TYPE 415

厳格なパススルー動作が有効になっているときに、ペイロードがサポートされていないメディアタイプである場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。

WAF_FILTERED 403

リクエストが AWS WAF によってブロックされた場合のゲートウェイレスポンス。レスポンスタイプが未指定の場合、このレスポンスはデフォルトで DEFAULT_4XX タイプになります。