API Gateway REST API を使用してゲートウェイレスポンスを設定する
API Gateway REST API を使用してゲートウェイレスポンスをカスタマイズする前に、API が作成済みで、その識別子を取得済みであることが必要です。API 識別子を取得するには、restapi:gateway-responses リンクリレーションに従い、その結果を確認します。
API Gateway REST API を使用してゲートウェイレスポンスをカスタマイズするには
-
ゲートウェイレスポンスインスタンス全体を上書きするには、gatewayresponse:put アクションを呼び出します。URL パスパラメータで目的の responseType を指定し、リクエストペイロードに statusCode、responseParameters、および responseTemplates マッピングを指定します。
-
GatewayResponse
インスタンスの一部を更新するには、gatewayresponse:update アクションを呼び出します。URL パラメータにresponseType
を指定し、リクエストペイロードに、たとえばGatewayResponse
やresponseParameters
マッピングなど、必要な個々のresponseTemplates
プロパティを指定します。