Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ApiGatewayV2.Types.IntegrationResponse

Description

Synopsis

data IntegrationResponse = IntegrationResponse' {
- integrationResponseId :: Maybe Text
- templateSelectionExpression :: Maybe Text
- contentHandlingStrategy :: Maybe ContentHandlingStrategy
- responseTemplates :: Maybe (HashMap Text Text)
- responseParameters :: Maybe (HashMap Text Text)
- integrationResponseKey :: Text
}
newIntegrationResponse :: Text -> IntegrationResponse
integrationResponse_integrationResponseId :: Lens' IntegrationResponse (Maybe Text)
integrationResponse_templateSelectionExpression :: Lens' IntegrationResponse (Maybe Text)
integrationResponse_contentHandlingStrategy :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy)
integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
integrationResponse_integrationResponseKey :: Lens' IntegrationResponse Text

Documentation

data IntegrationResponse Source #

Represents an integration response.

See: newIntegrationResponse smart constructor.

Constructors

IntegrationResponse'

Fields

integrationResponseId :: Maybe Text
The integration response ID.
templateSelectionExpression :: Maybe Text
The template selection expressions for the integration response.
contentHandlingStrategy :: Maybe 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.
responseTemplates :: Maybe (HashMap Text Text)
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.
responseParameters :: Maybe (HashMap Text Text)
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.
integrationResponseKey :: Text
The integration response key.

Instances

Instances details

Eq IntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.IntegrationResponse Methods (==) :: IntegrationResponse -> IntegrationResponse -> Bool # (/=) :: IntegrationResponse -> IntegrationResponse -> Bool #
Read IntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.IntegrationResponse Methods readsPrec :: Int -> ReadS IntegrationResponse # readList :: ReadS [IntegrationResponse] # readPrec :: ReadPrec IntegrationResponse # readListPrec :: ReadPrec [IntegrationResponse] #
Show IntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.IntegrationResponse Methods showsPrec :: Int -> IntegrationResponse -> ShowS # show :: IntegrationResponse -> String # showList :: [IntegrationResponse] -> ShowS #
Generic IntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.IntegrationResponse Associated Types type Rep IntegrationResponse :: Type -> Type # Methods from :: IntegrationResponse -> Rep IntegrationResponse x # to :: Rep IntegrationResponse x -> IntegrationResponse #
NFData IntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.IntegrationResponse Methods rnf :: IntegrationResponse -> () #
Hashable IntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.IntegrationResponse Methods hashWithSalt :: Int -> IntegrationResponse -> Int # hash :: IntegrationResponse -> Int #
FromJSON IntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.IntegrationResponse Methods parseJSON :: Value -> Parser IntegrationResponse # parseJSONList :: Value -> Parser [IntegrationResponse] #
type Rep IntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.IntegrationResponse type Rep IntegrationResponse = D1 ('MetaData "IntegrationResponse" "Amazonka.ApiGatewayV2.Types.IntegrationResponse" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "IntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "integrationResponseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "templateSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contentHandlingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "integrationResponseKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newIntegrationResponse Source #

Arguments

:: Text	`$sel:integrationResponseKey:IntegrationResponse'`
-> IntegrationResponse

Create a value of IntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:integrationResponseId:IntegrationResponse', integrationResponse_integrationResponseId - The integration response ID.

$sel:templateSelectionExpression:IntegrationResponse', integrationResponse_templateSelectionExpression - The template selection expressions for the integration response.

$sel:contentHandlingStrategy:IntegrationResponse', integrationResponse_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.

$sel:responseTemplates:IntegrationResponse', integrationResponse_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.

$sel:responseParameters:IntegrationResponse', integrationResponse_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.

$sel:integrationResponseKey:IntegrationResponse', integrationResponse_integrationResponseKey - The integration response key.

integrationResponse_integrationResponseId :: Lens' IntegrationResponse (Maybe Text) Source #

The integration response ID.

integrationResponse_templateSelectionExpression :: Lens' IntegrationResponse (Maybe Text) Source #

The template selection expressions for the integration response.

integrationResponse_contentHandlingStrategy :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #

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.

integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

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.

integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

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.

integrationResponse_integrationResponseKey :: Lens' IntegrationResponse Text Source #

The integration response key.