x-amazon-apigateway-integration.requestParameters オブジェクト - Amazon API Gateway
x-amazon-apigateway-integration.requestParameters の例

x-amazon-apigateway-integration.requestParameters オブジェクト

REST API では、名前付きメソッドリクエストパラメータから統合リクエストパラメータへのマッピングを指定します。メソッドリクエストパラメーターは、参照される前に定義済みである必要があります。

REST API では、指定した AWS_PROXY を使用して、integrationSubtype 統合に渡すパラメータを指定します。

プロパティ名 タイプ 説明
integration.request.<param-type>.<param-name> string

REST API では、値は通常、事前に定義されたmethod.request.<param-type>.<param-name> 形式のメソッドリクエストパラメータです (ここで、<param-type> は querystring、path、header、または body です)。ただし、$context.VARIABLE_NAME、$stageVariables.VARIABLE_NAME、および STATIC_VALUE も有効です。body パラメーターの場合、<param-name> は $. プレフィックスなしの JSON パス式です。
parameter string

HTTP API の場合、リクエストパラメータは、指定した AWS_PROXY と integrationSubtype の統合に渡すパラメータを指定するキーと値のマップです。静的値、マップリクエストデータ、ランタイムに評価されるステージ変数やコンテキスト変数のいずれかを指定できます。詳細については、「API Gateway で HTTP API の AWS のサービス統合を作成する」を参照してください。

x-amazon-apigateway-integration.requestParameters の例

次のリクエストパラメータのマッピングの例では、メソッドリクエストのクエリ (version)、ヘッダー (x-user-id)、パス (service) の各パラメータが、統合リクエストのクエリ (stage)、ヘッダー (x-userid)、パス (op) の各パラメータにそれぞれ変換されています。

注記

OpenAPI または AWS CloudFormation を介してリソースを作成している場合は、静的な値は一重引用符で囲む必要があります。

コンソールからこの値を追加するには、引用符なしでボックスに application/json と入力します。


"requestParameters" : {
    "integration.request.querystring.stage" : "method.request.querystring.version",
    "integration.request.header.x-userid" : "method.request.header.x-user-id",
    "integration.request.path.op" : "method.request.path.service"
},