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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

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",
  },
}

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) 


5879
5880
5881
5882
5883
5884
5885
5886
5887
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5879

class PutMethodResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end

#resource_id ⇒ String

[Required] The Resource identifier for the Method resource.

Returns:

  • (String) 


5879
5880
5881
5882
5883
5884
5885
5886
5887
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5879

class PutMethodResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end

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


5879
5880
5881
5882
5883
5884
5885
5886
5887
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5879

class PutMethodResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end

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


5879
5880
5881
5882
5883
5884
5885
5886
5887
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5879

class PutMethodResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) 


5879
5880
5881
5882
5883
5884
5885
5886
5887
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5879

class PutMethodResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end

#status_code ⇒ String

[Required] The method response’s status code.

Returns:

  • (String) 


5879
5880
5881
5882
5883
5884
5885
5886
5887
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5879

class PutMethodResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end