Amazon API Gateway の Amazon 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 ステータスコードで送信されたレスポンスを最大 24 時間、エクスポネンシャルバックオフとジッター で EventBridge 再試行します。その後、 は Amazon . CloudWatch EventBridge doesn't retry other 4xx HTTP errors のFailedInvocationsメトリクスを EventBridge 公開します。

タイムアウト

EventBridge ルール API Gateway リクエストの最大クライアント実行タイムアウトは 5 秒である必要があります。API Gateway の応答に 5 秒以上かかる場合、 はリクエストを EventBridge タイムアウトしてから再試行します。

EventBridge Pipes API Gateway リクエストの最大タイムアウトは 29 秒で、API Gateway の最大タイムアウトです。