AWS API Gatewayでリクエストを受け付けた日時をレスポンスに設定して返却する

初めに

業務でAWS API Gatewayでリクエストを受け付けた際、レスポンスに受け付けた日時を返却する必要があったため、その方法を記載しました。

準備

受け付けた日時を取得したいAPI Gatewayのエンドポイントで統合レスポンスタブを開き、統合レスポンスの編集画面を開きます。(今回のケースでは/requestTimeのGETに設定します)
統合レスポンス編集画面のマッピングテンプレート本文に、以下の内容を設定します。

{
  "requestTime": "$context.requestTime",
  "requestTimeEpoch": "$context.requestTimeEpoch"
}

実行

実行

 curl --request GET  --url https://hoge/requestTime

実行結果

{
  "requestTime": "06/Nov/2024:07:05:47 +0000",
  "requestTimeEpoch": "1730876747759"
}

参考資料

AWS API Gateway mapping template and access logging variable reference

最後に

いかがでしたでしょうか。
今回のケースはリクエストで受け付けた日時の(dd/MMM/yyyy:HH:mm:ss +-hhmm)形式のフォーマット及び、エポックミリ秒を返却する方法を試してみました。
他にも様々な値を設定できるようですので、必要に応じて有効活用したいと思います。