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


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

Response bodies


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


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


{
  "message message": "string"
}


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


{
  "message message": "string"
}


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

message

Describes the error encountered.

Type: string
Required: False

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.

message

Describes the error encountered.

Type: string
Required: False

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

integrationResponseKey

The integration response key.

Type: string
Required: True

responseParameters

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.

Type: IntegrationParameters
Required: False

responseTemplates

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.

Type: TemplateMap
Required: False

templateSelectionExpression

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

Type: string
Required: False

contentHandlingStrategy

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.

Type: ContentHandlingStrategy
Required: False

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.{location}.{name}, where {location} is querystring, path, or header; and {name} 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 Amazon 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

key-value pairs

Type: string

IntegrationResponse

Represents an integration response.

Property	Type	Required	Description
`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.
`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.

integrationResponseId

The integration response ID.

Type: string
Required: False

integrationResponseKey

The integration response key.

Type: string
Required: True

responseParameters

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.

Type: IntegrationParameters
Required: False

responseTemplates

Type: TemplateMap
Required: False

templateSelectionExpression

The template selection expressions for the integration response.

Type: string
Required: False

contentHandlingStrategy

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.

Type: ContentHandlingStrategy
Required: False

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.

items

The elements from this collection.

Type: Array of type IntegrationResponse
Required: False

nextToken

The next page of elements from this collection. Not valid for the last element of the collection.

Type: string
Required: False

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.

message

Describes the error encountered.

Type: string
Required: False

limitType

The limit type.

Type: string
Required: False

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.

message

Describes the error encountered.

Type: string
Required: False

resourceType

The resource type.

Type: string
Required: 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

key-value pairs

Type: string

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

IntegrationResponse

Integrations