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

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

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


4636
4637
4638
4639
4640
4641
4642
4643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4636

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


4636
4637
4638
4639
4640
4641
4642
4643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4636

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

#response_typeString

The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPES

Returns:

  • (String)


4636
4637
4638
4639
4640
4641
4642
4643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4636

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


4636
4637
4638
4639
4640
4641
4642
4643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4636

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

#status_codeString

The HTTP status code of the GatewayResponse.

Returns:

  • (String)


4636
4637
4638
4639
4640
4641
4642
4643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4636

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