Skip to content

Put Integration Response

apigateway_put_integration_response R Documentation

Represents a put integration

Description

Represents a put integration.

Usage

apigateway_put_integration_response(restApiId, resourceId, httpMethod,
  statusCode, selectionPattern, responseParameters, responseTemplates,
  contentHandling)

Arguments

restApiId

[required] The string identifier of the associated RestApi.

resourceId

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

httpMethod

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

statusCode

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

selectionPattern

Specifies the selection pattern of a put integration response.

responseParameters

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

Specifies a put integration response's templates.

contentHandling

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

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

Value

A list with the following syntax: 

list(
  statusCode = "string",
  selectionPattern = "string",
  responseParameters = list(
    "string"
  ),
  responseTemplates = list(
    "string"
  ),
  contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"
)

Request syntax

svc$put_integration_response(
  restApiId = "string",
  resourceId = "string",
  httpMethod = "string",
  statusCode = "string",
  selectionPattern = "string",
  responseParameters = list(
    "string"
  ),
  responseTemplates = list(
    "string"
  ),
  contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"
)