翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Amazon API EventBridge ゲートウェイのアマゾンターゲット
Amazon API Gateway を使用すると、API の作成、発行、管理、モニタリング、保護が可能です。Amazon EventBridge は API Gateway エンドポイントへのイベントの送信をサポートしています。ターゲットとして API Gateway エンドポイントを指定すると、ターゲットに送信される各イベントは、エンドポイントに送信されたリクエストにマッピングされます。
重要
EventBridge API Gateway のエッジ最適化エンドポイントとリージョナルエンドポイントをターゲットとして使用することをサポートします。プライベートエンドポイントは現在サポートされていません。エンドポイントの詳細については、「https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-endpoint-types.html」を参照してください。
API Gateway ターゲットは、次のユースケースで使用できます。
-
AWS またはサードパーティのイベントに基づいて、API Gateway でホストされている顧客指定の API を呼び出すこと。
-
スケジュールに基づいて定期的にエンドポイントを呼び出す。
EventBridge JSON イベント情報は HTTP リクエストの本文としてエンドポイントに送信されます。ターゲットの HttpParameters
フィールドでは、次のように他のリクエスト属性を指定できます。
-
PathParameterValues
は、エンドポイント ARN の任意のパス変数に順次対応する値を一覧で示します。例えば、"arn:aws:execute-api:us-east-1:112233445566:myapi/dev/POST/pets/*/*"
などです。 -
QueryStringParameters
EventBridge 呼び出されたエンドポイントに追加されるクエリ文字列パラメータを表します。 -
HeaderParameters
は、リクエストに追加する HTTP ヘッダーを定義します。
注記
セキュリティを考慮して、以下の HTTP ヘッダーキーは許可されていません。
-
X-Amz
またはX-Amzn
のプレフィックスが付いているキー -
Authorization
-
Connection
-
Content-Encoding
-
Content-Length
-
Host
-
Max-Forwards
-
TE
-
Transfer-Encoding
-
Trailer
-
Upgrade
-
Via
-
WWW-Authenticate
-
X-Forwarded-For
動的パラメータ
API Gateway ターゲットを呼び出すとき、ターゲットに送信されるイベントにデータを動的に追加することができます。詳細については、「ターゲットパラメータ」を参照してください。
呼び出しの再試行
すべてのターゲットと同様に、 EventBridge 失敗した呼び出しの一部を再試行します。API Gateway では、5xx または 429 HTTP ステータスコードで送信された応答を、指数関数的なバックオフとジッターを伴って最大FailedInvocations
CloudWatch にメトリクスを公開します。 EventBridge 他の 4xx HTTP エラーは再試行しません。
タイムアウト
EventBridge ルール API Gateway リクエストのクライアント実行タイムアウトの最大値は 5 秒である必要があります。API Gateway の応答に 5 秒以上かかる場合は、 EventBridge リクエストをタイムアウトしてから再試行します。
EventBridge パイプ API Gateway リクエストの最大タイムアウトは 29 秒で、API Gateway の最大タイムアウトです。