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.

PutIntegrationInput

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

type PutIntegrationInput struct { CacheKeyParameters []*string `locationName:"cacheKeyParameters" type:"list"` CacheNamespace *string `locationName:"cacheNamespace" type:"string"` ConnectionId *string `locationName:"connectionId" type:"string"` ConnectionType *string `locationName:"connectionType" type:"string" enum:"ConnectionType"` ContentHandling *string `locationName:"contentHandling" type:"string" enum:"ContentHandlingStrategy"` Credentials *string `locationName:"credentials" type:"string"` HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` IntegrationHttpMethod *string `locationName:"httpMethod" type:"string"` PassthroughBehavior *string `locationName:"passthroughBehavior" type:"string"` RequestParameters map[string]*string `locationName:"requestParameters" type:"map"` RequestTemplates map[string]*string `locationName:"requestTemplates" type:"map"` ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` TimeoutInMillis *int64 `locationName:"timeoutInMillis" type:"integer"` Type *string `locationName:"type" type:"string" required:"true" enum:"IntegrationType"` Uri *string `locationName:"uri" type:"string"` }

Sets up a method's integration.

CacheKeyParameters

Type: []*string

Specifies a put integration input's cache key parameters.

CacheNamespace

Type: *string

Specifies a put integration input's cache namespace.

ConnectionId

Type: *string

The (id (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

ConnectionType

Type: *string

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

ContentHandling

Type: *string

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

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

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

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

Credentials

Type: *string

Specifies whether credentials are required for a put integration.

HttpMethod

Type: *string

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

HttpMethod is a required field

IntegrationHttpMethod

Type: *string

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

PassthroughBehavior

Type: *string

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

RequestParameters

Type: map[string]*string

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

RequestTemplates

Type: map[string]*string

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

ResourceId

Type: *string

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

ResourceId is a required field

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

TimeoutInMillis

Type: *int64

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Type

Type: *string

[Required] Specifies a put integration input's type.

Type is a required field

Uri

Type: *string

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification (_blank), for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html), the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Method

GoString

func (s PutIntegrationInput) GoString() string

GoString returns the string representation

SetCacheKeyParameters

func (s *PutIntegrationInput) SetCacheKeyParameters(v []*string) *PutIntegrationInput

SetCacheKeyParameters sets the CacheKeyParameters field's value.

SetCacheNamespace

func (s *PutIntegrationInput) SetCacheNamespace(v string) *PutIntegrationInput

SetCacheNamespace sets the CacheNamespace field's value.

SetConnectionId

func (s *PutIntegrationInput) SetConnectionId(v string) *PutIntegrationInput

SetConnectionId sets the ConnectionId field's value.

SetConnectionType

func (s *PutIntegrationInput) SetConnectionType(v string) *PutIntegrationInput

SetConnectionType sets the ConnectionType field's value.

SetContentHandling

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

SetContentHandling sets the ContentHandling field's value.

SetCredentials

func (s *PutIntegrationInput) SetCredentials(v string) *PutIntegrationInput

SetCredentials sets the Credentials field's value.

SetHttpMethod

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

SetHttpMethod sets the HttpMethod field's value.

SetIntegrationHttpMethod

func (s *PutIntegrationInput) SetIntegrationHttpMethod(v string) *PutIntegrationInput

SetIntegrationHttpMethod sets the IntegrationHttpMethod field's value.

SetPassthroughBehavior

func (s *PutIntegrationInput) SetPassthroughBehavior(v string) *PutIntegrationInput

SetPassthroughBehavior sets the PassthroughBehavior field's value.

SetRequestParameters

func (s *PutIntegrationInput) SetRequestParameters(v map[string]*string) *PutIntegrationInput

SetRequestParameters sets the RequestParameters field's value.

SetRequestTemplates

func (s *PutIntegrationInput) SetRequestTemplates(v map[string]*string) *PutIntegrationInput

SetRequestTemplates sets the RequestTemplates field's value.

SetResourceId

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

SetResourceId sets the ResourceId field's value.

SetRestApiId

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

SetRestApiId sets the RestApiId field's value.

SetTimeoutInMillis

func (s *PutIntegrationInput) SetTimeoutInMillis(v int64) *PutIntegrationInput

SetTimeoutInMillis sets the TimeoutInMillis field's value.

SetType

func (s *PutIntegrationInput) SetType(v string) *PutIntegrationInput

SetType sets the Type field's value.

SetUri

func (s *PutIntegrationInput) SetUri(v string) *PutIntegrationInput

SetUri sets the Uri field's value.

String

func (s PutIntegrationInput) String() string

String returns the string representation

Validate

func (s *PutIntegrationInput) Validate() error

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

On this page: