You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::PutMethodResponseRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutMethodResponseRequest as input to an Aws::Client method, you can use a vanilla 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",
  },
}

Request to add a MethodResponse to an existing Method resource.

Instance Attribute Summary collapse

Instance Attribute Details

#http_method ⇒ String

[Required] The HTTP verb of the Method resource.

Returns:

  • (String) —

    [Required] The HTTP verb of the Method resource.

#resource_id ⇒ String

[Required] The Resource identifier for the Method resource.

Returns:

  • (String) —

    [Required] The Resource identifier for the Method resource.

#response_models ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    Specifies the Model resources used for the response\'s content type.

#response_parameters ⇒ Hash<String,Boolean>

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

Returns:

  • (Hash<String,Boolean>) —

    A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) —

    [Required] The string identifier of the associated RestApi.

#status_code ⇒ String

[Required] The method response\'s status code.

Returns:

  • (String) —

    [Required] The method response\'s status code.