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

Class: Aws::APIGateway::Types::PutIntegrationResponseRequest

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

{
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
  selection_pattern: "String",
  response_parameters: {
    "String" => "String",
  },
  response_templates: {
    "String" => "String",
  },
  content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
}

Represents a put integration response request.

Instance Attribute Summary collapse

Instance Attribute Details

#content_handlingString

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Returns:

  • (String)


4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4869

class PutIntegrationResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  include Aws::Structure
end

#http_methodString

Specifies a put integration response request's HTTP method.

Returns:

  • (String)


4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4869

class PutIntegrationResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  include Aws::Structure
end

#resource_idString

Specifies a put integration response request's resource identifier.

Returns:

  • (String)


4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4869

class PutIntegrationResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  include Aws::Structure
end

#response_parametersHash<String,String>

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.\{name\}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.\{name\} or integration.response.body.\{JSON-expression\}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Returns:

  • (Hash<String,String>)


4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4869

class PutIntegrationResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  include Aws::Structure
end

#response_templatesHash<String,String>

Specifies a put integration response's templates.

Returns:

  • (Hash<String,String>)


4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4869

class PutIntegrationResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4869

class PutIntegrationResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  include Aws::Structure
end

#selection_patternString

Specifies the selection pattern of a put integration response.

Returns:

  • (String)


4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4869

class PutIntegrationResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  include Aws::Structure
end

#status_codeString

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Returns:

  • (String)


4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4869

class PutIntegrationResponseRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :http_method,
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  include Aws::Structure
end