Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. getIntegrationResponse

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.getIntegrationResponse

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API. For more information, see Set up WebSocket API Integration Responses in API Gateway in the API Gateway Developer Guide.

Using getIntegrationResponse

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIntegrationResponse(args: GetIntegrationResponseArgs, opts?: InvokeOptions): Promise<GetIntegrationResponseResult>
function getIntegrationResponseOutput(args: GetIntegrationResponseOutputArgs, opts?: InvokeOptions): Output<GetIntegrationResponseResult>
Copy
def get_integration_response(api_id: Optional[str] = None,
                             integration_id: Optional[str] = None,
                             integration_response_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetIntegrationResponseResult
def get_integration_response_output(api_id: Optional[pulumi.Input[str]] = None,
                             integration_id: Optional[pulumi.Input[str]] = None,
                             integration_response_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetIntegrationResponseResult]
Copy
func LookupIntegrationResponse(ctx *Context, args *LookupIntegrationResponseArgs, opts ...InvokeOption) (*LookupIntegrationResponseResult, error)
func LookupIntegrationResponseOutput(ctx *Context, args *LookupIntegrationResponseOutputArgs, opts ...InvokeOption) LookupIntegrationResponseResultOutput
Copy

> Note: This function is named LookupIntegrationResponse in the Go SDK.

public static class GetIntegrationResponse 
{
    public static Task<GetIntegrationResponseResult> InvokeAsync(GetIntegrationResponseArgs args, InvokeOptions? opts = null)
    public static Output<GetIntegrationResponseResult> Invoke(GetIntegrationResponseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIntegrationResponseResult> getIntegrationResponse(GetIntegrationResponseArgs args, InvokeOptions options)
public static Output<GetIntegrationResponseResult> getIntegrationResponse(GetIntegrationResponseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:apigatewayv2:getIntegrationResponse
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId This property is required. string
The API identifier.
IntegrationId This property is required. string
The integration ID.
IntegrationResponseId This property is required. string
The integration response ID.
ApiId This property is required. string
The API identifier.
IntegrationId This property is required. string
The integration ID.
IntegrationResponseId This property is required. string
The integration response ID.
apiId This property is required. String
The API identifier.
integrationId This property is required. String
The integration ID.
integrationResponseId This property is required. String
The integration response ID.
apiId This property is required. string
The API identifier.
integrationId This property is required. string
The integration ID.
integrationResponseId This property is required. string
The integration response ID.
api_id This property is required. str
The API identifier.
integration_id This property is required. str
The integration ID.
integration_response_id This property is required. str
The integration response ID.
apiId This property is required. String
The API identifier.
integrationId This property is required. String
The integration ID.
integrationResponseId This property is required. String
The integration response ID.

getIntegrationResponse Result

The following output properties are available:

ContentHandlingStrategy string
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
The integration response ID.
IntegrationResponseKey string
The integration response key.
ResponseParameters object

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

ResponseTemplates object

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

TemplateSelectionExpression string
The template selection expression for the integration response. Supported only for WebSocket APIs.
ContentHandlingStrategy string
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
The integration response ID.
IntegrationResponseKey string
The integration response key.
ResponseParameters interface{}

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

ResponseTemplates interface{}

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

TemplateSelectionExpression string
The template selection expression for the integration response. Supported only for WebSocket APIs.
contentHandlingStrategy String
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
The integration response ID.
integrationResponseKey String
The integration response key.
responseParameters Object

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

responseTemplates Object

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

templateSelectionExpression String
The template selection expression for the integration response. Supported only for WebSocket APIs.
contentHandlingStrategy string
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
The integration response ID.
integrationResponseKey string
The integration response key.
responseParameters any

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

responseTemplates any

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

templateSelectionExpression string
The template selection expression for the integration response. Supported only for WebSocket APIs.
content_handling_strategy str
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.
integration_response_id str
The integration response ID.
integration_response_key str
The integration response key.
response_parameters Any

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

response_templates Any

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

template_selection_expression str
The template selection expression for the integration response. Supported only for WebSocket APIs.
contentHandlingStrategy String
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
The integration response ID.
integrationResponseKey String
The integration response key.
responseParameters Any

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

responseTemplates Any

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.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

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

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native