/v2/apis/{apiId}/integrations

POST

Creates an Integration.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/apis//integrations' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

201 - Example 1

{
  "ApiGatewayManaged": true,
  "ConnectionId": "string",
  "ConnectionType": "INTERNET",
  "ContentHandlingStrategy": "CONVERT_TO_BINARY",
  "CredentialsArn": "string",
  "Description": "string",
  "IntegrationId": "string",
  "IntegrationMethod": "string",
  "IntegrationResponseSelectionExpression": "string",
  "IntegrationSubtype": "string",
  "IntegrationType": "AWS",
  "IntegrationUri": "string",
  "PassthroughBehavior": "WHEN_NO_MATCH",
  "PayloadFormatVersion": "string",
  "RequestParameters": {},
  "RequestTemplates": {
    "property1": "string",
    "property2": "string"
  },
  "ResponseParameters": {
    "property1": {},
    "property2": {}
  },
  "TemplateSelectionExpression": "string",
  "TimeoutInMillis": 0,
  "TlsConfig": {
    "ServerNameToVerify": "string"
  }
}

Request

Path Params

apiId

string

required

The API identifier.

Body Params application/json

connectionId

string

optional

A string with a length between [1-1024].

connectionType

enum<string>

optional

Represents a connection type.

Allowed values:

INTERNETVPC_LINK

contentHandlingStrategy

enum<string>

optional

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

Allowed values:

CONVERT_TO_BINARYCONVERT_TO_TEXT

credentialsArn

string

optional

Represents an Amazon Resource Name (ARN).

description

string

optional

A string with a length between [0-1024].

integrationMethod

string

optional

A string with a length between [1-64].

integrationSubtype

string

optional

A string with a length between [1-128].

integrationType

enum<string>

required

Represents an API method integration type.

Allowed values:

AWSHTTPMOCKHTTP_PROXYAWS_PROXY

integrationUri

string

optional

A string representation of a URI with a length between [1-2048].

passthroughBehavior

enum<string>

optional

Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.

Allowed values:

WHEN_NO_MATCHNEVERWHEN_NO_TEMPLATES

payloadFormatVersion

string

optional

A string with a length between [1-64].

requestParameters

object

optional

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

is querystring, path, or header; and

must be a valid and unique method request parameter 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.

Additional properties

string

optional

A string with a length between [1-512].

requestTemplates

object

optional

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.

Additional properties

string

optional

A string with a length between [0-32768].

responseParameters

object

optional

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.

Additional properties

object

optional

templateSelectionExpression

string

optional

An expression used to extract information at runtime. See Selection Expressions for more information.

timeoutInMillis

integer

optional

An integer with a value between [50-30000].

>= 50<= 30000

tlsConfig

object

optional

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.

ServerNameToVerify

string

optional

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.

Examples

Responses

🟢201Success

application/json

Body

ApiGatewayManaged

boolean

optional

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

optional

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

ConnectionType

enum<string>

optional

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

Allowed values:

INTERNETVPC_LINK

ContentHandlingStrategy

enum<string>

optional

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

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

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.

Allowed values:

CONVERT_TO_BINARYCONVERT_TO_TEXT

CredentialsArn

string

optional

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.

Description

string

optional

Represents the description of an integration.

IntegrationId

string

optional

Represents the identifier of an integration.

IntegrationMethod

string

optional

Specifies the integration's HTTP method type.

IntegrationResponseSelectionExpression

string

optional

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

IntegrationSubtype

string

optional

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

IntegrationType

enum<string>

optional

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Allowed values:

AWSHTTPMOCKHTTP_PROXYAWS_PROXY

IntegrationUri

string

optional

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 DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

PassthroughBehavior

enum<string>

optional

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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.

Allowed values:

WHEN_NO_MATCHNEVERWHEN_NO_TEMPLATES

PayloadFormatVersion

string

optional

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

RequestParameters

object

optional

For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The 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.

RequestTemplates

object

optional

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

object

optional

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 pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

TemplateSelectionExpression

string

optional

The template selection expression for the integration. Supported only for WebSocket APIs.

TimeoutInMillis

integer

optional

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.

>= 50<= 30000

TlsConfig

object

optional

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.

ServerNameToVerify

string

optional

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException

🟠483ConflictException

Modified at 2023-08-15 05:49:07

/v2/domainnames

/v2/apis/{apiId}/integrations