Network.AWS.APIGateway.PutIntegrationResponse

Represents a put integration.

Creating a Request

putIntegrationResponse

Arguments

:: Text

piRestAPIId

-> Text

piResourceId

-> Text

piHttpMethod

-> Text

piStatusCode

-> PutIntegrationResponse

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

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

• piResponseTemplates
• piSelectionPattern
• piResponseParameters
• piRestAPIId
• piResourceId
• piHttpMethod
• piStatusCode

data PutIntegrationResponse

Represents a put integration response request.

See: putIntegrationResponse smart constructor.

Instances

Eq PutIntegrationResponse

Methods

(==) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool

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

Data PutIntegrationResponse

Methods

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

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

toConstr :: PutIntegrationResponse -> Constr

dataTypeOf :: PutIntegrationResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read PutIntegrationResponse

Methods

readsPrec :: Int -> ReadS PutIntegrationResponse

readList :: ReadS [PutIntegrationResponse]

readPrec :: ReadPrec PutIntegrationResponse

readListPrec :: ReadPrec [PutIntegrationResponse]

Show PutIntegrationResponse

Methods

showsPrec :: Int -> PutIntegrationResponse -> ShowS

show :: PutIntegrationResponse -> String

showList :: [PutIntegrationResponse] -> ShowS

Generic PutIntegrationResponse

Associated Types

type Rep PutIntegrationResponse :: * -> *

Methods

from :: PutIntegrationResponse -> Rep PutIntegrationResponse x

to :: Rep PutIntegrationResponse x -> PutIntegrationResponse

ToJSON PutIntegrationResponse

Methods

toJSON :: PutIntegrationResponse -> Value

toEncoding :: PutIntegrationResponse -> Encoding

Hashable PutIntegrationResponse

Methods

hashWithSalt :: Int -> PutIntegrationResponse -> Int

hash :: PutIntegrationResponse -> Int

NFData PutIntegrationResponse

Methods

rnf :: PutIntegrationResponse -> ()

AWSRequest PutIntegrationResponse

Associated Types

type Rs PutIntegrationResponse :: *

Methods

request :: PutIntegrationResponse -> Request PutIntegrationResponse

response :: MonadResource m => Logger -> Service -> Proxy * PutIntegrationResponse -> ClientResponse -> m (Response PutIntegrationResponse)

ToPath PutIntegrationResponse

Methods

toPath :: PutIntegrationResponse -> ByteString

ToHeaders PutIntegrationResponse

Methods

toHeaders :: PutIntegrationResponse -> [Header]

ToQuery PutIntegrationResponse

Methods

toQuery :: PutIntegrationResponse -> QueryString

type Rep PutIntegrationResponse

type Rep PutIntegrationResponse = D1 (MetaData "PutIntegrationResponse" "Network.AWS.APIGateway.PutIntegrationResponse" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "PutIntegrationResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_piResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_piSelectionPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_piResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_piRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_piResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_piHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_piStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs PutIntegrationResponse

type Rs PutIntegrationResponse = IntegrationResponse

Request Lenses

piResponseTemplates :: Lens' PutIntegrationResponse (HashMap Text Text)

Specifies a put integration response's templates.

piSelectionPattern :: Lens' PutIntegrationResponse (Maybe Text)

Specifies the selection pattern of a put integration response.

piResponseParameters :: Lens' PutIntegrationResponse (HashMap Text Text)

Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern 'integration.response.header.{name}'.

piRestAPIId :: Lens' PutIntegrationResponse Text

Specifies a put integration response request's API identifier.

piResourceId :: Lens' PutIntegrationResponse Text

Specifies a put integration response request's resource identifier.

piHttpMethod :: Lens' PutIntegrationResponse Text

Specifies a put integration response request's HTTP method.

piStatusCode :: Lens' PutIntegrationResponse Text

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

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:

• iResponseTemplates
• iSelectionPattern
• iStatusCode
• iResponseParameters

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 backend response.

See: integrationResponse smart constructor.

Instances

Eq IntegrationResponse

Methods

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

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

Data IntegrationResponse

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

Methods

readsPrec :: Int -> ReadS IntegrationResponse

readList :: ReadS [IntegrationResponse]

readPrec :: ReadPrec IntegrationResponse

readListPrec :: ReadPrec [IntegrationResponse]

Show IntegrationResponse

Methods

showsPrec :: Int -> IntegrationResponse -> ShowS

show :: IntegrationResponse -> String

showList :: [IntegrationResponse] -> ShowS

Generic IntegrationResponse

Associated Types

type Rep IntegrationResponse :: * -> *

Methods

from :: IntegrationResponse -> Rep IntegrationResponse x

to :: Rep IntegrationResponse x -> IntegrationResponse

FromJSON IntegrationResponse

Methods

parseJSON :: Value -> Parser IntegrationResponse

Hashable IntegrationResponse

Methods

hashWithSalt :: Int -> IntegrationResponse -> Int

hash :: IntegrationResponse -> Int

NFData IntegrationResponse

Methods

rnf :: IntegrationResponse -> ()

type Rep IntegrationResponse

type Rep IntegrationResponse = D1 (MetaData "IntegrationResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "IntegrationResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_iSelectionPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_iStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))))))

Response Lenses

iResponseTemplates :: 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.

iSelectionPattern :: Lens' IntegrationResponse (Maybe Text)

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.

iStatusCode :: Lens' IntegrationResponse (Maybe Text)

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

iResponseParameters :: Lens' IntegrationResponse (HashMap Text Text)

Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the MethodResponse. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern 'integration.response.header.{name}'.