Integrations
Represents the collection of integrations for an API.
URI
/v2/apis/
apiId
/integrations
HTTP methods
GET
Operation ID: GetIntegrations
Gets the Integrations
for an API.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apiId | String | True | The API identifier. |
Query parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextToken | String | False | The next page of elements from this collection. Not valid for the last element of the collection. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxResults | String | False | The maximum number of elements to be returned for this resource. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Integrations | Success | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestException | One of the parameters in the request is invalid. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundException | The resource specified in the request was not found. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceededException | The client is sending more than the allowed number of requests per unit of time. |
POST
Operation ID: CreateIntegration
Creates an Integration
.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apiId | String | True | The API identifier. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Integration | The request has succeeded and has resulted in the creation of a resource. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestException | One of the parameters in the request is invalid. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundException | The resource specified in the request was not found. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ConflictException | The resource already exists. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceededException | The client is sending more than the allowed number of requests per unit of time. |
Schemas
Request bodies
{ "description": "string", "integrationType": enum, "integrationSubtype": "string", "integrationMethod": "string", "integrationUri": "string", "tlsConfig": { "serverNameToVerify": "string" }, "credentialsArn": "string", "connectionType": enum, "connectionId": "string", "requestParameters": { }, "responseParameters": { }, "requestTemplates": { }, "templateSelectionExpression": "string", "passthroughBehavior": enum, "contentHandlingStrategy": enum, "timeoutInMillis": integer, "payloadFormatVersion": "string" }
Response bodies
{ "items": [ { "integrationId": "string", "description": "string", "integrationType": enum, "integrationSubtype": "string", "integrationMethod": "string", "integrationUri": "string", "tlsConfig": { "serverNameToVerify": "string" }, "credentialsArn": "string", "connectionType": enum, "connectionId": "string", "requestParameters": { }, "responseParameters": { }, "requestTemplates": { }, "templateSelectionExpression": "string", "passthroughBehavior": enum, "contentHandlingStrategy": enum, "timeoutInMillis": integer, "integrationResponseSelectionExpression": "string", "payloadFormatVersion": "string", "apiGatewayManaged": boolean } ], "nextToken": "string" }
{ "integrationId": "string", "description": "string", "integrationType": enum, "integrationSubtype": "string", "integrationMethod": "string", "integrationUri": "string", "tlsConfig": { "serverNameToVerify": "string" }, "credentialsArn": "string", "connectionType": enum, "connectionId": "string", "requestParameters": { }, "responseParameters": { }, "requestTemplates": { }, "templateSelectionExpression": "string", "passthroughBehavior": enum, "contentHandlingStrategy": enum, "timeoutInMillis": integer, "integrationResponseSelectionExpression": "string", "payloadFormatVersion": "string", "apiGatewayManaged": boolean }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string" }
Properties
BadRequestException
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Describes the error encountered. |
ConflictException
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Describes the error encountered. |
ConnectionType
Represents a connection type.
INTERNET
VPC_LINK
ContentHandlingStrategy
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
CONVERT_TO_BINARY
CONVERT_TO_TEXT
CreateIntegrationInput
Represents the input parameters for a CreateIntegration
request.
Property | Type | Required | Description |
---|---|---|---|
connectionId | string | False | The ID of the VPC link for a private integration. Supported only for HTTP APIs. |
connectionType | False | The type of the network connection to the integration endpoint. Specify | |
contentHandlingStrategy | False | Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. | |
credentialsArn | string | False | 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 |
description | string | False | The description of the integration. |
integrationMethod | string | False | Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to |
integrationSubtype | string | False | Supported only for HTTP API |
integrationType | True | The integration type of an integration. One of the following:
| |
integrationUri | string | False | For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load
Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If
you specify the ARN of an AWS Cloud Map service, API Gateway uses
|
passthroughBehavior | False | Specifies the pass-through behavior for incoming requests based on the
| |
payloadFormatVersion | string | False | Specifies the format of the payload sent to an integration. Required for HTTP
APIs. For HTTP APIs, supported values for Lambda proxy integrations are
|
requestParameters | False | For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of For HTTP API integrations with a specified For HTTP API integrations without a specified | |
requestTemplates | False | 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. Supported only for WebSocket APIs. | |
responseParameters | False | Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
integration before returning the response to clients. Specify a key-value map from a selection key to response
parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key
must match the pattern | |
templateSelectionExpression | string | False | The template selection expression for the integration. |
timeoutInMillis | integer | False | Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. |
tlsConfig | False | The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs. |
Integration
Represents an integration.
Property | Type | Required | Description |
---|---|---|---|
apiGatewayManaged | boolean | False | Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it. |
connectionId | string | False | The ID of the VPC link for a private integration. Supported only for HTTP APIs. |
connectionType | False | The type of the network connection to the integration endpoint. Specify | |
contentHandlingStrategy | False | Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. | |
credentialsArn | string | False | 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 |
description | string | False | Represents the description of an integration. |
integrationId | string | False | Represents the identifier of an integration. |
integrationMethod | string | False | Specifies the integration's HTTP method type. |
integrationResponseSelectionExpression | string | False | The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions. |
integrationSubtype | string | False | Supported only for HTTP API |
integrationType | False | The integration type of an integration. One of the following:
| |
integrationUri | string | False | For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load
Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If
you specify the ARN of an AWS Cloud Map service, API Gateway uses
|
passthroughBehavior | False | Specifies the pass-through behavior for incoming requests based on the
| |
payloadFormatVersion | string | False | Specifies the format of the payload sent to an integration. Required for HTTP
APIs. For HTTP APIs, supported values for Lambda proxy integrations are
|
requestParameters | False | For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of For HTTP API integrations with a specified For HTTP API integrations without a specified | |
requestTemplates | False | 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. Supported only for WebSocket APIs. | |
responseParameters | False | Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
integration before returning the response to clients. Specify a key-value map from a selection key to response
parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key
must match the pattern | |
templateSelectionExpression | string | False | The template selection expression for the integration. Supported only for WebSocket APIs. |
timeoutInMillis | integer | False | Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs. |
tlsConfig | False | The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs. |
IntegrationParameters
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.
, where {location}
.{name}
is {location}
querystring
, path
, or header
; and
must be a valid and unique method request parameter name.{name}
For HTTP API integrations with a specified integrationSubtype
, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY
integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations without a specified integrationSubtype
request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append
, overwrite
or remove
. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
Property | Type | Required | Description |
---|---|---|---|
| string | False |
IntegrationType
Represents an API method integration type.
AWS
HTTP
MOCK
HTTP_PROXY
AWS_PROXY
Integrations
Represents a collection of integrations.
Property | Type | Required | Description |
---|---|---|---|
items | Array of type Integration | False | The elements from this collection. |
nextToken | string | False | The next page of elements from this collection. Not valid for the last element of the collection. |
LimitExceededException
A limit has been exceeded. See the accompanying error message for details.
Property | Type | Required | Description |
---|---|---|---|
limitType | string | False | The limit type. |
message | string | False | Describes the error encountered. |
NotFoundException
The resource specified in the request was not found. See the message
field for more information.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Describes the error encountered. |
resourceType | string | False | The resource type. |
PassthroughBehavior
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
WHEN_NO_MATCH
NEVER
WHEN_NO_TEMPLATES
ResponseParameters
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
Property | Type | Required | Description |
---|---|---|---|
| object | False |
TemplateMap
A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey
which is chosen based on evaluating a selection expression.
Property | Type | Required | Description |
---|---|---|---|
| string | False |
TlsConfig
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
Property | Type | Required | Description |
---|---|---|---|
serverNameToVerify | string | False | If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting. |
TlsConfigInput
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
Property | Type | Required | Description |
---|---|---|---|
serverNameToVerify | string | False | If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: