apigateway_put_method_response: Adds a MethodResponse to an existing Method resource

View source: R/apigateway_operations.R

apigateway_put_method_responseR Documentation

Adds a MethodResponse to an existing Method resource

Description

Adds a MethodResponse to an existing Method resource.

See https://www.paws-r-sdk.com/docs/apigateway_put_method_response/ for full documentation.

Usage

apigateway_put_method_response(
  restApiId,
  resourceId,
  httpMethod,
  statusCode,
  responseParameters = NULL,
  responseModels = NULL
)

Arguments

restApiId

[required] The string identifier of the associated RestApi.

resourceId

[required] The Resource identifier for the Method resource.

httpMethod

[required] The HTTP verb of the Method resource.

statusCode

[required] The method response's status code.

responseParameters

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.)

responseModels

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.


paws.networking documentation built on Sept. 12, 2024, 7:32 a.m.