class Aws::APIGateway::Types::PutMethodResponseRequest
Request to add a MethodResponse
to an existing Method
resource.
@note When making an API call, you may pass PutMethodResponseRequest
data as a hash: { rest_api_id: "String", # required resource_id: "String", # required http_method: "String", # required status_code: "StatusCode", # required response_parameters: { "String" => false, }, response_models: { "String" => "String", }, }
@!attribute [rw] rest_api_id
\[Required\] The string identifier of the associated RestApi. @return [String]
@!attribute [rw] resource_id
\[Required\] The Resource identifier for the Method resource. @return [String]
@!attribute [rw] http_method
\[Required\] The HTTP verb of the Method resource. @return [String]
@!attribute [rw] status_code
\[Required\] The method response's status code. @return [String]
@!attribute [rw] response_parameters
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.) @return [Hash<String,Boolean>]
@!attribute [rw] response_models
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. @return [Hash<String,String>]
Constants
- SENSITIVE