AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Represents an integration response.

Inheritance Hierarchy

System.Object
  Amazon.ApiGatewayV2.Model.IntegrationResponse

Namespace: Amazon.ApiGatewayV2.Model
Assembly: AWSSDK.ApiGatewayV2.dll
Version: 3.x.y.z

Syntax

C#
public class IntegrationResponse

The IntegrationResponse type exposes the following members

Constructors

NameDescription
Public Method IntegrationResponse()

Properties

NameTypeDescription
Public Property ContentHandlingStrategy Amazon.ApiGatewayV2.ContentHandlingStrategy

Gets and sets the property 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.

Public Property IntegrationResponseId System.String

Gets and sets the property IntegrationResponseId.

The integration response ID.

Public Property IntegrationResponseKey System.String

Gets and sets the property IntegrationResponseKey.

The integration response key.

Public Property ResponseParameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property 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.

Public Property ResponseTemplates System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property 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.

Public Property TemplateSelectionExpression System.String

Gets and sets the property TemplateSelectionExpression.

The template selection expressions for the integration response.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms