apigateway_put_method_response: Adds a MethodResponse to an existing Method resource

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Adds a MethodResponse to an existing Method resource.

Usage

1
2
apigateway_put_method_response(restApiId, resourceId, httpMethod,
  statusCode, responseParameters, responseModels)

Arguments

restApiId

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

resourceId

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

httpMethod

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

statusCode

[required] [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.

Value

A list with the following syntax:

1
2
3
4
5
6
7
8
9
list(
  statusCode = "string",
  responseParameters = list(
    TRUE|FALSE
  ),
  responseModels = list(
    "string"
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
svc$put_method_response(
  restApiId = "string",
  resourceId = "string",
  httpMethod = "string",
  statusCode = "string",
  responseParameters = list(
    TRUE|FALSE
  ),
  responseModels = list(
    "string"
  )
)

paws.networking documentation built on March 7, 2021, 5:08 p.m.