PutIntegrationResponseRequest

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

Represents a put integration response request.

interface PutIntegrationResponseRequest {

contentHandling?: ContentHandlingStrategy | null;

httpMethod: string;

resourceId: string;

responseParameters?: {

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

} | null;

responseTemplates?: {

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

} | null;

restApiId: string;

selectionPattern?: string | null;

statusCode: string;

}

§Properties

contentHandling?: ContentHandlingStrategy | null

[src]

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

httpMethod: string

[src]

[Required] Specifies a put integration response request's HTTP method.

resourceId: string

[src]

[Required] Specifies a put integration response request's resource identifier.

responseParameters?: {

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

} | null

[src]

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

responseTemplates?: {

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

} | null

[src]

Specifies a put integration response's templates.

restApiId: string

[src]

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

selectionPattern?: string | null

[src]

Specifies the selection pattern of a put integration response.

statusCode: string

[src]

[Required] Specifies the status code that is used to map the integration response to an existing "MethodResponse".