PutIntegration
Sets up a method's integration.
Request Syntax
PUT /restapis/restapi_id
/resources/resource_id
/methods/http_method
/integration HTTP/1.1
Content-type: application/json
{
"cacheKeyParameters": [ "string
" ],
"cacheNamespace": "string
",
"connectionId": "string
",
"connectionType": "string
",
"contentHandling": "string
",
"credentials": "string
",
"httpMethod": "string
",
"passthroughBehavior": "string
",
"requestParameters": {
"string
" : "string
"
},
"requestTemplates": {
"string
" : "string
"
},
"timeoutInMillis": number
,
"tlsConfig": {
"insecureSkipVerification": boolean
},
"type": "string
",
"uri": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- http_method
-
Specifies the HTTP method for the integration.
Required: Yes
- resource_id
-
Specifies a put integration request's resource ID.
Required: Yes
- restapi_id
-
The string identifier of the associated RestApi.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- cacheKeyParameters
-
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.Type: Array of strings
Required: No
- cacheNamespace
-
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.Type: String
Required: No
- connectionId
-
The ID of the VpcLink used for the integration. Specify this value only if you specify
VPC_LINK
as the connection type.Type: String
Required: No
- connectionType
-
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.Type: String
Valid Values:
INTERNET | VPC_LINK
Required: No
- contentHandling
-
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors: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.Type: String
Valid Values:
CONVERT_TO_BINARY | CONVERT_TO_TEXT
Required: No
- credentials
-
Specifies whether credentials are required for a put integration.
Type: String
Required: No
- httpMethod
-
The HTTP method for the integration.
Type: String
Required: No
- 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
, andNEVER
.Type: String
Required: No
- 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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.Type: String to string map
Required: No
- 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.
Type: String to string map
Required: No
- timeoutInMillis
-
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
Type: Integer
Required: No
- tlsConfig
-
Specifies the TLS configuration for an integration.
Type: TlsConfig object
Required: No
- type
-
Specifies a put integration input's type.
Type: String
Valid Values:
HTTP | AWS | MOCK | HTTP_PROXY | AWS_PROXY
Required: Yes
- uri
-
Specifies the Uniform Resource Identifier (URI) of the integration endpoint. For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, and use a valid top-level domain. For a private HTTP integration with aconnectionType
ofVPC_LINK
, the URI is not used for routing. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn: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 ofGetObject
, theuri
can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
.Type: String
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"cacheKeyParameters": [ "string" ],
"cacheNamespace": "string",
"connectionId": "string",
"connectionType": "string",
"contentHandling": "string",
"credentials": "string",
"httpMethod": "string",
"integrationResponses": {
"string" : {
"contentHandling": "string",
"responseParameters": {
"string" : "string"
},
"responseTemplates": {
"string" : "string"
},
"selectionPattern": "string",
"statusCode": "string"
}
},
"passthroughBehavior": "string",
"requestParameters": {
"string" : "string"
},
"requestTemplates": {
"string" : "string"
},
"timeoutInMillis": number,
"tlsConfig": {
"insecureSkipVerification": boolean
},
"type": "string",
"uri": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- cacheKeyParameters
-
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.Type: Array of strings
- cacheNamespace
-
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.Type: String
- connectionId
-
The ID of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise.Type: String
- connectionType
-
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.Type: String
Valid Values:
INTERNET | VPC_LINK
- contentHandling
-
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors: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.Type: String
Valid Values:
CONVERT_TO_BINARY | CONVERT_TO_TEXT
- credentials
-
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*
. To use resource-based permissions on supported AWS services, specify null.Type: String
- httpMethod
-
Specifies the integration's HTTP method type. For the Type property, if you specify
MOCK
, this property is optional. For Lambda integrations, you must set the integration method toPOST
. For all other types, you must specify this property.Type: String
- integrationResponses
-
Specifies the integration's responses.
Type: String to IntegrationResponse object map
- passthroughBehavior
-
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in
requestTemplates
. The valid value is one of the following:WHEN_NO_MATCH
: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.WHEN_NO_TEMPLATES
: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.NEVER
: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.Type: String
- 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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.Type: String to string map
- 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.
Type: String to string map
- timeoutInMillis
-
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
Type: Integer
- tlsConfig
-
Specifies the TLS configuration for an integration.
Type: TlsConfig object
- type
-
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (
http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.Type: String
Valid Values:
HTTP | AWS | MOCK | HTTP_PROXY | AWS_PROXY
- uri
-
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn: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 eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
- ConflictException
-
The request configuration has conflicts. For details, see the accompanying error message.
HTTP Status Code: 409
- LimitExceededException
-
The request exceeded the rate limit. Retry after the specified time period.
HTTP Status Code: 429
- NotFoundException
-
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
- TooManyRequestsException
-
The request has reached its throttling limit. Retry after the specified time period.
HTTP Status Code: 429
- UnauthorizedException
-
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
Examples
Integrate an HTTP GET method with the ListStreams action in Amazon Kinesis
This example illustrates one usage of PutIntegration.
Sample 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"
}
Sample 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"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: