Network.AWS.APIGateway.UpdateIntegrationResponse

Represents an update integration response.

Creating a Request

updateIntegrationResponse

Arguments

:: Text

uiRestAPIId

-> Text

uiResourceId

-> Text

uiHttpMethod

-> Text

uiStatusCode

-> UpdateIntegrationResponse

Creates a value of UpdateIntegrationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uiPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• uiRestAPIId - [Required] The string identifier of the associated RestApi .
• uiResourceId - [Required] Specifies an update integration response request's resource identifier.
• uiHttpMethod - [Required] Specifies an update integration response request's HTTP method.
• uiStatusCode - [Required] Specifies an update integration response request's status code.

data UpdateIntegrationResponse

Represents an update integration response request.

See: updateIntegrationResponse smart constructor.

Instances

Eq UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

(==) :: UpdateIntegrationResponse -> UpdateIntegrationResponse -> Bool

(/=) :: UpdateIntegrationResponse -> UpdateIntegrationResponse -> Bool

Data UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateIntegrationResponse -> c UpdateIntegrationResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateIntegrationResponse

toConstr :: UpdateIntegrationResponse -> Constr

dataTypeOf :: UpdateIntegrationResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateIntegrationResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateIntegrationResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateIntegrationResponse -> UpdateIntegrationResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateIntegrationResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateIntegrationResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateIntegrationResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateIntegrationResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateIntegrationResponse -> m UpdateIntegrationResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateIntegrationResponse -> m UpdateIntegrationResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateIntegrationResponse -> m UpdateIntegrationResponse

Read UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

readsPrec :: Int -> ReadS UpdateIntegrationResponse

readList :: ReadS [UpdateIntegrationResponse]

readPrec :: ReadPrec UpdateIntegrationResponse

readListPrec :: ReadPrec [UpdateIntegrationResponse]

Show UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

showsPrec :: Int -> UpdateIntegrationResponse -> ShowS

show :: UpdateIntegrationResponse -> String

showList :: [UpdateIntegrationResponse] -> ShowS

Generic UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Associated Types

type Rep UpdateIntegrationResponse :: Type -> Type

Methods

from :: UpdateIntegrationResponse -> Rep UpdateIntegrationResponse x

to :: Rep UpdateIntegrationResponse x -> UpdateIntegrationResponse

Hashable UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

hashWithSalt :: Int -> UpdateIntegrationResponse -> Int

hash :: UpdateIntegrationResponse -> Int

ToJSON UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

toJSON :: UpdateIntegrationResponse -> Value

toEncoding :: UpdateIntegrationResponse -> Encoding

toJSONList :: [UpdateIntegrationResponse] -> Value

toEncodingList :: [UpdateIntegrationResponse] -> Encoding

AWSRequest UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Associated Types

type Rs UpdateIntegrationResponse :: Type

Methods

request :: UpdateIntegrationResponse -> Request UpdateIntegrationResponse

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateIntegrationResponse -> ClientResponse -> m (Response UpdateIntegrationResponse)

ToHeaders UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

toHeaders :: UpdateIntegrationResponse -> [Header]

ToPath UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

toPath :: UpdateIntegrationResponse -> ByteString

ToQuery UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

toQuery :: UpdateIntegrationResponse -> QueryString

NFData UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

Methods

rnf :: UpdateIntegrationResponse -> ()

type Rep UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

type Rep UpdateIntegrationResponse = D1 (MetaData "UpdateIntegrationResponse" "Network.AWS.APIGateway.UpdateIntegrationResponse" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "UpdateIntegrationResponse'" PrefixI True) ((S1 (MetaSel (Just "_uiPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 (MetaSel (Just "_uiRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_uiResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_uiHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_uiStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdateIntegrationResponse

Defined in Network.AWS.APIGateway.UpdateIntegrationResponse

type Rs UpdateIntegrationResponse = IntegrationResponse

Request Lenses

uiPatchOperations :: Lens' UpdateIntegrationResponse [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

uiRestAPIId :: Lens' UpdateIntegrationResponse Text

Required

The string identifier of the associated RestApi .

uiResourceId :: Lens' UpdateIntegrationResponse Text

Required

Specifies an update integration response request's resource identifier.

uiHttpMethod :: Lens' UpdateIntegrationResponse Text

Required

Specifies an update integration response request's HTTP method.

uiStatusCode :: Lens' UpdateIntegrationResponse Text

Required

Specifies an update integration response request's status code.

Destructuring the Response

integrationResponse :: IntegrationResponse

Creates a value of IntegrationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• intContentHandling - 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 method response without modification.
• intResponseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
• intSelectionPattern - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
• intStatusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse .
• intResponseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. 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.

data IntegrationResponse

Represents an integration response. The status code must map to an existing MethodResponse , and parameters and templates can be used to transform the back-end response.

Creating an API

See: integrationResponse smart constructor.

Instances

Eq IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

Methods

(==) :: IntegrationResponse -> IntegrationResponse -> Bool

(/=) :: IntegrationResponse -> IntegrationResponse -> Bool

Data IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IntegrationResponse -> c IntegrationResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IntegrationResponse

toConstr :: IntegrationResponse -> Constr

dataTypeOf :: IntegrationResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IntegrationResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IntegrationResponse)

gmapT :: (forall b. Data b => b -> b) -> IntegrationResponse -> IntegrationResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IntegrationResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IntegrationResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> IntegrationResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IntegrationResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IntegrationResponse -> m IntegrationResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IntegrationResponse -> m IntegrationResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IntegrationResponse -> m IntegrationResponse

Read IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

Methods

readsPrec :: Int -> ReadS IntegrationResponse

readList :: ReadS [IntegrationResponse]

readPrec :: ReadPrec IntegrationResponse

readListPrec :: ReadPrec [IntegrationResponse]

Show IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

Methods

showsPrec :: Int -> IntegrationResponse -> ShowS

show :: IntegrationResponse -> String

showList :: [IntegrationResponse] -> ShowS

Generic IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep IntegrationResponse :: Type -> Type

Methods

from :: IntegrationResponse -> Rep IntegrationResponse x

to :: Rep IntegrationResponse x -> IntegrationResponse

Hashable IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> IntegrationResponse -> Int

hash :: IntegrationResponse -> Int

FromJSON IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

Methods

parseJSON :: Value -> Parser IntegrationResponse

parseJSONList :: Value -> Parser [IntegrationResponse]

NFData IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: IntegrationResponse -> ()

type Rep IntegrationResponse

Defined in Network.AWS.APIGateway.Types.Product

type Rep IntegrationResponse = D1 (MetaData "IntegrationResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "IntegrationResponse'" PrefixI True) ((S1 (MetaSel (Just "_intContentHandling") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :*: S1 (MetaSel (Just "_intResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) :*: (S1 (MetaSel (Just "_intSelectionPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_intStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_intResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))))))

Response Lenses

intContentHandling :: Lens' IntegrationResponse (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 method response without modification.

intResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text)

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

intSelectionPattern :: Lens' IntegrationResponse (Maybe Text)

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

intStatusCode :: Lens' IntegrationResponse (Maybe Text)

Specifies the status code that is used to map the integration response to an existing MethodResponse .

intResponseParameters :: Lens' IntegrationResponse (HashMap Text Text)

A key-value map specifying response parameters that are passed to the method response from the back end. 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.