Amazon API Gateway REST API Reference

integration:put

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",
  "credentials" : "String",
  "requestParameters" : {
    "String" : "String"
  },
  "requestTemplates" : {
    "String" : "String"
  },
  "passthroughBehavior" : "String",
  "cacheNamespace" : "String",
  "cacheKeyParameters" : [ "String" ],
  "contentHandling" : "String"
}

Request Body Fields

The request accepts the following fields in JSON format.

  • type
  • 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 the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.

  • 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 put integration input's cache namespace.

  • cacheKeyParameters
  • Specifies a put integration input's cache key parameters.

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

Response

Integration

Remarks

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

Request

PUT /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
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"
}
Response

{
  "_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