Class: Aws::APIGateway::Types::PutGatewayResponseRequest

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 PutGatewayResponseRequest data as a hash:

{
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED, WAF_FILTERED
  status_code: "StatusCode",
  response_parameters: {
    "String" => "String",
  },
  response_templates: {
    "String" => "String",
  },
}

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


5597
5598
5599
5600
5601
5602
5603
5604
5605
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5597

class PutGatewayResponseRequest < Struct.new(
  :rest_api_id,
  :response_type,
  :status_code,
  :response_parameters,
  :response_templates)
  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>)


5597
5598
5599
5600
5601
5602
5603
5604
5605
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5597

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

#response_typeString

[Required] The response type of the associated GatewayResponse.

Returns:

  • (String)


5597
5598
5599
5600
5601
5602
5603
5604
5605
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5597

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

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)


5597
5598
5599
5600
5601
5602
5603
5604
5605
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5597

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

#status_codeString

The HTTP status code of the GatewayResponse.

Returns:

  • (String)


5597
5598
5599
5600
5601
5602
5603
5604
5605
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5597

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