Class: Aws::APIGateway::Types::GatewayResponse

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

Overview

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_response ⇒ Boolean

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

Returns:

  • (Boolean) 
 2243 2244 2245 2246 2247 2248 2249 2250 2251
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2243 class GatewayResponse < Struct.new( :response_type, :status_code, :response_parameters, :response_templates, :default_response) SENSITIVE = [] include Aws::Structure end

#response_parameters ⇒ Hash<String,String>

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

Returns:

  • (Hash<String,String>) 
 2243 2244 2245 2246 2247 2248 2249 2250 2251
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2243 class GatewayResponse < Struct.new( :response_type, :status_code, :response_parameters, :response_templates, :default_response) SENSITIVE = [] include Aws::Structure end

#response_templates ⇒ Hash<String,String>

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

Returns:

  • (Hash<String,String>) 
 2243 2244 2245 2246 2247 2248 2249 2250 2251
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2243 class GatewayResponse < Struct.new( :response_type, :status_code, :response_parameters, :response_templates, :default_response) SENSITIVE = [] include Aws::Structure end

#response_type ⇒ String

The response type of the associated GatewayResponse.

Returns:

  • (String) 
 2243 2244 2245 2246 2247 2248 2249 2250 2251
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2243 class GatewayResponse < Struct.new( :response_type, :status_code, :response_parameters, :response_templates, :default_response) SENSITIVE = [] include Aws::Structure end

#status_code ⇒ String

The HTTP status code for this GatewayResponse.

Returns:

  • (String) 
 2243 2244 2245 2246 2247 2248 2249 2250 2251
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2243 class GatewayResponse < Struct.new( :response_type, :status_code, :response_parameters, :response_templates, :default_response) SENSITIVE = [] include Aws::Structure end