AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

IntegrationResponse

import "github.com/aws/aws-sdk-go/service/apigateway"

type IntegrationResponse struct { ContentHandling *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` ResponseParameters map[string]*string `locationName:"responseParameters" type:"map"` ResponseTemplates map[string]*string `locationName:"responseTemplates" type:"map"` SelectionPattern *string `locationName:"selectionPattern" type:"string"` StatusCode *string `locationName:"statusCode" type:"string"` }

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

Creating an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html)

ContentHandling

Type: *string

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.

ResponseParameters

Type: map[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 is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

ResponseTemplates

Type: map[string]*string

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

SelectionPattern

Type: *string

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

StatusCode

Type: *string

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

Method

GoString

func (s IntegrationResponse) GoString() string

GoString returns the string representation

SetContentHandling

func (s *IntegrationResponse) SetContentHandling(v string) *IntegrationResponse

SetContentHandling sets the ContentHandling field's value.

SetResponseParameters

func (s *IntegrationResponse) SetResponseParameters(v map[string]*string) *IntegrationResponse

SetResponseParameters sets the ResponseParameters field's value.

SetResponseTemplates

func (s *IntegrationResponse) SetResponseTemplates(v map[string]*string) *IntegrationResponse

SetResponseTemplates sets the ResponseTemplates field's value.

SetSelectionPattern

func (s *IntegrationResponse) SetSelectionPattern(v string) *IntegrationResponse

SetSelectionPattern sets the SelectionPattern field's value.

SetStatusCode

func (s *IntegrationResponse) SetStatusCode(v string) *IntegrationResponse

SetStatusCode sets the StatusCode field's value.

String

func (s IntegrationResponse) String() string

String returns the string representation

On this page: