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_responseBoolean

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)


2562
2563
2564
2565
2566
2567
2568
2569
2570
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2562

class GatewayResponse < Struct.new(
  :response_type,
  :status_code,
  :response_parameters,
  :response_templates,
  :default_response)
  SENSITIVE = []
  include Aws::Structure
end

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


2562
2563
2564
2565
2566
2567
2568
2569
2570
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2562

class GatewayResponse < Struct.new(
  :response_type,
  :status_code,
  :response_parameters,
  :response_templates,
  :default_response)
  SENSITIVE = []
  include Aws::Structure
end

#response_templatesHash<String,String>

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

Returns:

  • (Hash<String,String>)


2562
2563
2564
2565
2566
2567
2568
2569
2570
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2562

class GatewayResponse < Struct.new(
  :response_type,
  :status_code,
  :response_parameters,
  :response_templates,
  :default_response)
  SENSITIVE = []
  include Aws::Structure
end

#response_typeString

The response type of the associated GatewayResponse.

Returns:

  • (String)


2562
2563
2564
2565
2566
2567
2568
2569
2570
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2562

class GatewayResponse < Struct.new(
  :response_type,
  :status_code,
  :response_parameters,
  :response_templates,
  :default_response)
  SENSITIVE = []
  include Aws::Structure
end

#status_codeString

The HTTP status code for this GatewayResponse.

Returns:

  • (String)


2562
2563
2564
2565
2566
2567
2568
2569
2570
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2562

class GatewayResponse < Struct.new(
  :response_type,
  :status_code,
  :response_parameters,
  :response_templates,
  :default_response)
  SENSITIVE = []
  include Aws::Structure
end