/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses

POST

Creates an IntegrationResponses.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/apis//integrations//integrationresponses' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contentHandlingStrategy": "CONVERT_TO_BINARY",
    "integrationResponseKey": "string",
    "responseParameters": {
        "property1": "string",
        "property2": "string"
    },
    "responseTemplates": {
        "property1": "string",
        "property2": "string"
    },
    "templateSelectionExpression": "string"
}'

Response Example

201 - Example 1

{
  "ContentHandlingStrategy": "CONVERT_TO_BINARY",
  "IntegrationResponseId": "string",
  "IntegrationResponseKey": "string",
  "ResponseParameters": {},
  "ResponseTemplates": {
    "property1": "string",
    "property2": "string"
  },
  "TemplateSelectionExpression": "string"
}

Request

Path Params

apiId

string

required

The API identifier.

integrationId

string

required

The integration ID.

Body Params application/json

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

integrationResponseKey

string

required

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

responseParameters

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].

responseTemplates

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].

templateSelectionExpression

string

optional

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

Examples

Responses

🟢201Success

application/json

Body

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

IntegrationResponseId

string

optional

The integration response ID.

IntegrationResponseKey

string

optional

The integration response key.

ResponseParameters

object

optional

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

ResponseTemplates

object

optional

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

TemplateSelectionExpression

string

optional

The template selection expressions for the integration response.

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException

🟠483ConflictException

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

/v2/apis/{apiId}/integrations

/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses