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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GatewayResponse

Includes:

Structure

Defined in:

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

SENSITIVE =

[]

Instance Attribute Summary

• #default_response ⇒ Boolean

  A Boolean flag to indicate whether this GatewayResponse is the default gateway response (‘true`) or not (`false`).

• #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.

• #response_templates ⇒ Hash<String,String>

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

• #response_type ⇒ String

  The response type of the associated GatewayResponse.

• #status_code ⇒ String

  The HTTP status code for this GatewayResponse.

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 2080

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

# File 'lib/aws-sdk-apigateway/types.rb', line 2080

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

# File 'lib/aws-sdk-apigateway/types.rb', line 2080

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 2080

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 2080

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