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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an IntegrationResponses.

Synopsis

Creating a Request

data UpdateIntegrationResponse Source #

Updates an IntegrationResponses.

See: newUpdateIntegrationResponse smart constructor.

Constructors

UpdateIntegrationResponse'

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.
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 expression for the integration response. Supported only for WebSocket APIs.
apiId :: Text
The API identifier.
integrationResponseId :: Text
The integration response ID.
integrationId :: Text
The integration ID.

Instances

Instances details

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

newUpdateIntegrationResponse Source #

Arguments

:: Text	`UpdateIntegrationResponse`
-> Text	`UpdateIntegrationResponse`
-> Text	`UpdateIntegrationResponse`
-> UpdateIntegrationResponse

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

UpdateIntegrationResponse, updateIntegrationResponse_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.

UpdateIntegrationResponse, updateIntegrationResponse_integrationResponseKey - The integration response key.

UpdateIntegrationResponse, updateIntegrationResponse_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.

UpdateIntegrationResponse, updateIntegrationResponse_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.

UpdateIntegrationResponse, updateIntegrationResponse_templateSelectionExpression - The template selection expression for the integration response. Supported only for WebSocket APIs.

UpdateIntegrationResponse, updateIntegrationResponse_apiId - The API identifier.

UpdateIntegrationResponse, updateIntegrationResponse_integrationResponseId - The integration response ID.

UpdateIntegrationResponse, updateIntegrationResponse_integrationId - The integration ID.

Request Lenses

updateIntegrationResponse_contentHandlingStrategy :: Lens' UpdateIntegrationResponse (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.

updateIntegrationResponse_integrationResponseKey :: Lens' UpdateIntegrationResponse (Maybe Text) Source #

The integration response key.

updateIntegrationResponse_responseParameters :: Lens' UpdateIntegrationResponse (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.

updateIntegrationResponse_responseTemplates :: Lens' UpdateIntegrationResponse (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.

updateIntegrationResponse_templateSelectionExpression :: Lens' UpdateIntegrationResponse (Maybe Text) Source #

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

updateIntegrationResponse_apiId :: Lens' UpdateIntegrationResponse Text Source #

The API identifier.

updateIntegrationResponse_integrationResponseId :: Lens' UpdateIntegrationResponse Text Source #

The integration response ID.

updateIntegrationResponse_integrationId :: Lens' UpdateIntegrationResponse Text Source #

The integration ID.

Destructuring the Response

data UpdateIntegrationResponseResponse Source #

See: newUpdateIntegrationResponseResponse smart constructor.

Constructors

UpdateIntegrationResponseResponse'

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 UpdateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateIntegrationResponse Associated Types type Rep UpdateIntegrationResponseResponse :: Type -> Type # Methods from :: UpdateIntegrationResponseResponse -> Rep UpdateIntegrationResponseResponse x # to :: Rep UpdateIntegrationResponseResponse x -> UpdateIntegrationResponseResponse #
Read UpdateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateIntegrationResponse Methods readsPrec :: Int -> ReadS UpdateIntegrationResponseResponse # readList :: ReadS [UpdateIntegrationResponseResponse] # readPrec :: ReadPrec UpdateIntegrationResponseResponse # readListPrec :: ReadPrec [UpdateIntegrationResponseResponse] #
Show UpdateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateIntegrationResponse Methods showsPrec :: Int -> UpdateIntegrationResponseResponse -> ShowS # show :: UpdateIntegrationResponseResponse -> String # showList :: [UpdateIntegrationResponseResponse] -> ShowS #
NFData UpdateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateIntegrationResponse Methods rnf :: UpdateIntegrationResponseResponse -> () #
Eq UpdateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateIntegrationResponse Methods (==) :: UpdateIntegrationResponseResponse -> UpdateIntegrationResponseResponse -> Bool # (/=) :: UpdateIntegrationResponseResponse -> UpdateIntegrationResponseResponse -> Bool #
type Rep UpdateIntegrationResponseResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateIntegrationResponse type Rep UpdateIntegrationResponseResponse = D1 ('MetaData "UpdateIntegrationResponseResponse" "Amazonka.ApiGatewayV2.UpdateIntegrationResponse" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "UpdateIntegrationResponseResponse'" '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)))))

newUpdateIntegrationResponseResponse Source #

Arguments

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

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

UpdateIntegrationResponse, updateIntegrationResponseResponse_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.

UpdateIntegrationResponse, updateIntegrationResponseResponse_integrationResponseId - The integration response ID.

UpdateIntegrationResponse, updateIntegrationResponseResponse_integrationResponseKey - The integration response key.

UpdateIntegrationResponse, updateIntegrationResponseResponse_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.

UpdateIntegrationResponse, updateIntegrationResponseResponse_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.

UpdateIntegrationResponse, updateIntegrationResponseResponse_templateSelectionExpression - The template selection expressions for the integration response.

$sel:httpStatus:UpdateIntegrationResponseResponse', updateIntegrationResponseResponse_httpStatus - The response's http status code.

Response Lenses

updateIntegrationResponseResponse_contentHandlingStrategy :: Lens' UpdateIntegrationResponseResponse (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.

updateIntegrationResponseResponse_integrationResponseId :: Lens' UpdateIntegrationResponseResponse (Maybe Text) Source #

The integration response ID.

updateIntegrationResponseResponse_integrationResponseKey :: Lens' UpdateIntegrationResponseResponse (Maybe Text) Source #

The integration response key.

updateIntegrationResponseResponse_responseParameters :: Lens' UpdateIntegrationResponseResponse (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.

updateIntegrationResponseResponse_responseTemplates :: Lens' UpdateIntegrationResponseResponse (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.

updateIntegrationResponseResponse_templateSelectionExpression :: Lens' UpdateIntegrationResponseResponse (Maybe Text) Source #

The template selection expressions for the integration response.

updateIntegrationResponseResponse_httpStatus :: Lens' UpdateIntegrationResponseResponse Int Source #

The response's http status code.