Amazon API Gateway REST API Reference


Set up the method's integration request.

HTTP Request

PUT /restapis/<restapi_id>/resources/<resource_id>/methods/<http_method>/integration

Request Body

  "type" : "String",
  "httpMethod" : "String",
  "uri" : "String",
  "connectionType" : "String",
  "connectionId" : "String",
  "credentials" : "String",
  "requestParameters" : {
    "String" : "String"
  "requestTemplates" : {
    "String" : "String"
  "passthroughBehavior" : "String",
  "cacheNamespace" : "String",
  "cacheKeyParameters" : [ "String" ],
  "contentHandling" : "String",
  "timeoutInMillis" : "Integer",
  "tlsConfig" : {
    "insecureSkipVerification" : "Boolean"

Request Body Fields

The request accepts the following fields in JSON format.

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

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

  • uri
  • 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, 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, 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}

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

  • connectionId
  • The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

  • credentials
  • Specifies whether credentials are required for a put integration.

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

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

  • cacheNamespace
  • Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

  • cacheKeyParameters
  • A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

  • contentHandling
  • 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 passthroughBehavior is configured to support payload pass-through.

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

  • tlsConfig
    • insecureSkipVerification
    • Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations.




Example: Integrate an HTTP GET method with the ListStreams action in Amazon Kinesis.


PUT /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration HTTP/1.1
Content-Type: application/json
X-Amz-Date: 20160602T194050Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160602/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

  "type" : "AWS",
  "httpMethod" : "POST",
  "uri" : "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams",
  "credentials" : "arn:aws:iam::123456789012:role/apigAwsProxyRole",
  "requestParameters" : {
    "integration.request.header.Content-Type": "'application/x-amz-json-1.1'"
  "requestTemplates" : {
    "application/json": "{\n}"
  "passthroughBehavior" : "WHEN_NO_MATCH"

  "_links": {
    "curies": [
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
    "integration:delete": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
    "integration:update": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
    "integrationresponse:put": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}",
      "templated": true
  "cacheKeyParameters": [],
  "cacheNamespace": "3kzxbg5sa2",
  "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole",
  "httpMethod": "POST",
  "passthroughBehavior": "WHEN_NO_MATCH",
  "requestParameters": {
    "integration.request.header.Content-Type": "'application/x-amz-json-1.1'"
  "requestTemplates": {
    "application/json": "{\n}"
  "type": "AWS",
  "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams"

After setting up the integration, you should set up the integration response to ensure the results from the back end are returned to the client. This is done by calling integrationResponse:put.

See Also

IntegrationResponse, AWS CLI