PutMethodResponseRequest

import type { PutMethodResponseRequest } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";

Request to add a "MethodResponse" to an existing "Method" resource.

interface PutMethodResponseRequest {

httpMethod: string;

resourceId: string;

responseModels?: {

[key: string]: string | null | undefined;

} | null;

responseParameters?: {

[key: string]: boolean | null | undefined;

} | null;

restApiId: string;

statusCode: string;

}

§Properties

httpMethod: string

[src]

[Required] The HTTP verb of the "Method" resource.

resourceId: string

[src]

[Required] The "Resource" identifier for the "Method" resource.

responseModels?: {

[key: string]: string | null | undefined;

} | null

[src]

Specifies the "Model" resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a "Model" name as the value.

responseParameters?: {

[key: string]: boolean | null | undefined;

} | null

[src]

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

restApiId: string

[src]

[Required] The string identifier of the associated "RestApi".

statusCode: string

[src]

[Required] The method response's status code.