Amazon API Gateway
API Reference

HTTP APIs are in beta for Amazon API Gateway and are subject to change.

IntegrationResponses

Represents the collection of responses for an integration. Supported only for WebSocket APIs.

URI

/v2/apis/apiId/integrations/integrationId/integrationresponses

HTTP Methods

GET

Operation ID: GetIntegrationResponses

Gets the IntegrationResponses for an Integration.

Path Parameters

Name Type Required Description
integrationId String True

The integration ID.

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 IntegrationResponses

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: CreateIntegrationResponse

Creates an IntegrationResponses.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

integrationId String True

The integration ID.

Responses

Status Code Response Model Description
201 IntegrationResponse

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

Example POST

{ "integrationResponseKey": "string", "responseParameters": { }, "responseTemplates": { }, "templateSelectionExpression": "string", "contentHandlingStrategy": enum }

Response Bodies

Example IntegrationResponses

{ "items": [ { "integrationResponseId": "string", "integrationResponseKey": "string", "responseParameters": { }, "responseTemplates": { }, "templateSelectionExpression": "string", "contentHandlingStrategy": enum } ], "nextToken": "string" }

Example IntegrationResponse

{ "integrationResponseId": "string", "integrationResponseKey": "string", "responseParameters": { }, "responseTemplates": { }, "templateSelectionExpression": "string", "contentHandlingStrategy": enum }

Example BadRequestException

{ "message": "string" }

Example NotFoundException

{ "message": "string", "resourceType": "string" }

Example ConflictException

{ "message": "string" }

Example LimitExceededException

{ "message": "string", "limitType": "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.

ContentHandlingStrategy

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

  • CONVERT_TO_BINARY

  • CONVERT_TO_TEXT

CreateIntegrationResponseInput

Represents the input parameters for a CreateIntegrationResponse request.

Property Type Required Description
integrationResponseKey

string

True

The integration response key.

responseParameters

IntegrationParameters

False

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

TemplateMap

False

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

False

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

contentHandlingStrategy

ContentHandlingStrategy

False

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.

IntegrationParameters

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.

Property Type Required Description

*

string

False

IntegrationResponse

Represents an integration response.

Property Type Required Description
integrationResponseId

string

False

The integration response ID.

integrationResponseKey

string

True

The integration response key.

responseParameters

IntegrationParameters

False

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

TemplateMap

False

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

False

The template selection expressions for the integration response.

contentHandlingStrategy

ContentHandlingStrategy

False

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.

IntegrationResponses

Represents a collection of integration responses.

Property Type Required Description
items

Array of type IntegrationResponse

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
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

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.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetIntegrationResponses

CreateIntegrationResponse