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.

PutIntegrationResponseInput

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

type PutIntegrationResponseInput struct { ContentHandling *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` ResponseParameters map[string]*string `locationName:"responseParameters" type:"map"` ResponseTemplates map[string]*string `locationName:"responseTemplates" type:"map"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` SelectionPattern *string `locationName:"selectionPattern" type:"string"` StatusCode *string `location:"uri" locationName:"status_code" type:"string" required:"true"` }

Represents a put integration response request.

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.

HttpMethod

Type: *string

[Required] Specifies a put integration response request's HTTP method.

HttpMethod is a required field

ResourceId

Type: *string

[Required] Specifies a put integration response request's resource identifier.

ResourceId is a required field

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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

ResponseTemplates

Type: map[string]*string

Specifies a put integration response's templates.

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

SelectionPattern

Type: *string

Specifies the selection pattern of a put integration response.

StatusCode

Type: *string

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

StatusCode is a required field

Method

GoString

func (s PutIntegrationResponseInput) GoString() string

GoString returns the string representation

SetContentHandling

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

SetContentHandling sets the ContentHandling field's value.

SetHttpMethod

func (s *PutIntegrationResponseInput) SetHttpMethod(v string) *PutIntegrationResponseInput

SetHttpMethod sets the HttpMethod field's value.

SetResourceId

func (s *PutIntegrationResponseInput) SetResourceId(v string) *PutIntegrationResponseInput

SetResourceId sets the ResourceId field's value.

SetResponseParameters

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

SetResponseParameters sets the ResponseParameters field's value.

SetResponseTemplates

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

SetResponseTemplates sets the ResponseTemplates field's value.

SetRestApiId

func (s *PutIntegrationResponseInput) SetRestApiId(v string) *PutIntegrationResponseInput

SetRestApiId sets the RestApiId field's value.

SetSelectionPattern

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

SetSelectionPattern sets the SelectionPattern field's value.

SetStatusCode

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

SetStatusCode sets the StatusCode field's value.

String

func (s PutIntegrationResponseInput) String() string

String returns the string representation

Validate

func (s *PutIntegrationResponseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: