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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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_methodString

The HTTP verb of the Method resource.

Returns:

  • (String)


5037
5038
5039
5040
5041
5042
5043
5044
5045
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5037

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

#resource_idString

The Resource identifier for the Method resource.

Returns:

  • (String)


5037
5038
5039
5040
5041
5042
5043
5044
5045
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5037

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

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


5037
5038
5039
5040
5041
5042
5043
5044
5045
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5037

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

#response_parametersHash<String,Boolean>

A key-value map specifying required or optional response parameters that Amazon 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>)


5037
5038
5039
5040
5041
5042
5043
5044
5045
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5037

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


5037
5038
5039
5040
5041
5042
5043
5044
5045
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5037

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

#status_codeString

The method response's status code.

Returns:

  • (String)


5037
5038
5039
5040
5041
5042
5043
5044
5045
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5037

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