Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ApiGatewayV2.CreateIntegrationResponse

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an IntegrationResponses.

Synopsis

Creating a Request

data CreateIntegrationResponse Source #

Creates a new IntegrationResponse resource to represent an integration response.

See: newCreateIntegrationResponse smart constructor.

Constructors

CreateIntegrationResponse'

Fields

contentHandlingStrategy :: Maybe 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.
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.
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.
templateSelectionExpression :: Maybe Text
The template selection expression for the integration response. Supported only for WebSocket APIs.
apiId :: Text
The API identifier.
integrationId :: Text
The integration ID.
integrationResponseKey :: Text
The integration response key.

Instances

Instances details

ToJSON CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods toJSON :: CreateIntegrationResponse -> Value # toEncoding :: CreateIntegrationResponse -> Encoding # toJSONList :: [CreateIntegrationResponse] -> Value # toEncodingList :: [CreateIntegrationResponse] -> Encoding #
ToHeaders CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods toHeaders :: CreateIntegrationResponse -> [Header] #
ToPath CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods toPath :: CreateIntegrationResponse -> ByteString #
ToQuery CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods toQuery :: CreateIntegrationResponse -> QueryString #
AWSRequest CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Associated Types type AWSResponse CreateIntegrationResponse # Methods request :: (Service -> Service) -> CreateIntegrationResponse -> Request CreateIntegrationResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateIntegrationResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateIntegrationResponse))) #
Generic CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Associated Types type Rep CreateIntegrationResponse :: Type -> Type # Methods from :: CreateIntegrationResponse -> Rep CreateIntegrationResponse x # to :: Rep CreateIntegrationResponse x -> CreateIntegrationResponse #
Read CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods readsPrec :: Int -> ReadS CreateIntegrationResponse # readList :: ReadS [CreateIntegrationResponse] # readPrec :: ReadPrec CreateIntegrationResponse # readListPrec :: ReadPrec [CreateIntegrationResponse] #
Show CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods showsPrec :: Int -> CreateIntegrationResponse -> ShowS # show :: CreateIntegrationResponse -> String # showList :: [CreateIntegrationResponse] -> ShowS #
NFData CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods rnf :: CreateIntegrationResponse -> () #
Eq CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods (==) :: CreateIntegrationResponse -> CreateIntegrationResponse -> Bool # (/=) :: CreateIntegrationResponse -> CreateIntegrationResponse -> Bool #
Hashable CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods hashWithSalt :: Int -> CreateIntegrationResponse -> Int # hash :: CreateIntegrationResponse -> Int #
type AWSResponse CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse type AWSResponse CreateIntegrationResponse = CreateIntegrationResponseResponse
type Rep CreateIntegrationResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse type Rep CreateIntegrationResponse = D1 ('MetaData "CreateIntegrationResponse" "Amazonka.ApiGatewayV2.CreateIntegrationResponse" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "CreateIntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentHandlingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "templateSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "integrationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "integrationResponseKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateIntegrationResponse Source #

Arguments

:: Text	`CreateIntegrationResponse`
-> Text	`CreateIntegrationResponse`
-> Text	`CreateIntegrationResponse`
-> CreateIntegrationResponse

Create a value of CreateIntegrationResponse 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:

CreateIntegrationResponse, createIntegrationResponse_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.

CreateIntegrationResponse, createIntegrationResponse_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.

CreateIntegrationResponse, createIntegrationResponse_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.

CreateIntegrationResponse, createIntegrationResponse_templateSelectionExpression - The template selection expression for the integration response. Supported only for WebSocket APIs.

CreateIntegrationResponse, createIntegrationResponse_apiId - The API identifier.

CreateIntegrationResponse, createIntegrationResponse_integrationId - The integration ID.

CreateIntegrationResponse, createIntegrationResponse_integrationResponseKey - The integration response key.

Request Lenses

createIntegrationResponse_contentHandlingStrategy :: Lens' CreateIntegrationResponse (Maybe ContentHandlingStrategy) Source #

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.

createIntegrationResponse_responseParameters :: Lens' CreateIntegrationResponse (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.

createIntegrationResponse_responseTemplates :: Lens' CreateIntegrationResponse (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.

createIntegrationResponse_templateSelectionExpression :: Lens' CreateIntegrationResponse (Maybe Text) Source #

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

createIntegrationResponse_apiId :: Lens' CreateIntegrationResponse Text Source #

The API identifier.

createIntegrationResponse_integrationId :: Lens' CreateIntegrationResponse Text Source #

The integration ID.

createIntegrationResponse_integrationResponseKey :: Lens' CreateIntegrationResponse Text Source #

The integration response key.

Destructuring the Response

data CreateIntegrationResponseResponse Source #

See: newCreateIntegrationResponseResponse smart constructor.

Constructors

CreateIntegrationResponseResponse'

Fields

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.
integrationResponseId :: Maybe Text
The integration response ID.
integrationResponseKey :: Maybe Text
The integration response key.
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.
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.
templateSelectionExpression :: Maybe Text
The template selection expressions for the integration response.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Associated Types type Rep CreateIntegrationResponseResponse :: Type -> Type # Methods from :: CreateIntegrationResponseResponse -> Rep CreateIntegrationResponseResponse x # to :: Rep CreateIntegrationResponseResponse x -> CreateIntegrationResponseResponse #
Read CreateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods readsPrec :: Int -> ReadS CreateIntegrationResponseResponse # readList :: ReadS [CreateIntegrationResponseResponse] # readPrec :: ReadPrec CreateIntegrationResponseResponse # readListPrec :: ReadPrec [CreateIntegrationResponseResponse] #
Show CreateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods showsPrec :: Int -> CreateIntegrationResponseResponse -> ShowS # show :: CreateIntegrationResponseResponse -> String # showList :: [CreateIntegrationResponseResponse] -> ShowS #
NFData CreateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods rnf :: CreateIntegrationResponseResponse -> () #
Eq CreateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse Methods (==) :: CreateIntegrationResponseResponse -> CreateIntegrationResponseResponse -> Bool # (/=) :: CreateIntegrationResponseResponse -> CreateIntegrationResponseResponse -> Bool #
type Rep CreateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateIntegrationResponse type Rep CreateIntegrationResponseResponse = D1 ('MetaData "CreateIntegrationResponseResponse" "Amazonka.ApiGatewayV2.CreateIntegrationResponse" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "CreateIntegrationResponseResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentHandlingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: (S1 ('MetaSel ('Just "integrationResponseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "integrationResponseKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "templateSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateIntegrationResponseResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateIntegrationResponseResponse'`
-> CreateIntegrationResponseResponse

Create a value of CreateIntegrationResponseResponse 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:

CreateIntegrationResponse, createIntegrationResponseResponse_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.

CreateIntegrationResponseResponse, createIntegrationResponseResponse_integrationResponseId - The integration response ID.

CreateIntegrationResponse, createIntegrationResponseResponse_integrationResponseKey - The integration response key.

CreateIntegrationResponse, createIntegrationResponseResponse_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.

CreateIntegrationResponse, createIntegrationResponseResponse_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.

CreateIntegrationResponse, createIntegrationResponseResponse_templateSelectionExpression - The template selection expressions for the integration response.

$sel:httpStatus:CreateIntegrationResponseResponse', createIntegrationResponseResponse_httpStatus - The response's http status code.

Response Lenses

createIntegrationResponseResponse_contentHandlingStrategy :: Lens' CreateIntegrationResponseResponse (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.

createIntegrationResponseResponse_integrationResponseId :: Lens' CreateIntegrationResponseResponse (Maybe Text) Source #

The integration response ID.

createIntegrationResponseResponse_integrationResponseKey :: Lens' CreateIntegrationResponseResponse (Maybe Text) Source #

The integration response key.

createIntegrationResponseResponse_responseParameters :: Lens' CreateIntegrationResponseResponse (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.

createIntegrationResponseResponse_responseTemplates :: Lens' CreateIntegrationResponseResponse (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.

createIntegrationResponseResponse_templateSelectionExpression :: Lens' CreateIntegrationResponseResponse (Maybe Text) Source #

The template selection expressions for the integration response.

createIntegrationResponseResponse_httpStatus :: Lens' CreateIntegrationResponseResponse Int Source #

The response's http status code.