Stratosphere.ResourceProperties.ApiGatewayIntegrationResponse

IntegrationResponse is a property of the Amazon API Gateway Method Integration property that specifies the response that Amazon API Gateway (API Gateway) sends after a method's back end finishes processing a request.

Documentation

data ApiGatewayIntegrationResponse

Full data type definition for ApiGatewayIntegrationResponse. See apiGatewayIntegrationResponse for a more convenient constructor.

Constructors

ApiGatewayIntegrationResponse

Fields

• _apiGatewayIntegrationResponseResponseParameters :: Maybe Object
• _apiGatewayIntegrationResponseResponseTemplates :: Maybe Object
• _apiGatewayIntegrationResponseSelectionPattern :: Maybe (Val Text)
• _apiGatewayIntegrationResponseStatusCode :: Maybe (Val Text)

Instances

Show ApiGatewayIntegrationResponse

Methods

showsPrec :: Int -> ApiGatewayIntegrationResponse -> ShowS

show :: ApiGatewayIntegrationResponse -> String

showList :: [ApiGatewayIntegrationResponse] -> ShowS

Generic ApiGatewayIntegrationResponse

Associated Types

type Rep ApiGatewayIntegrationResponse :: * -> *

Methods

from :: ApiGatewayIntegrationResponse -> Rep ApiGatewayIntegrationResponse x

to :: Rep ApiGatewayIntegrationResponse x -> ApiGatewayIntegrationResponse

ToJSON ApiGatewayIntegrationResponse

Methods

toJSON :: ApiGatewayIntegrationResponse -> Value

toEncoding :: ApiGatewayIntegrationResponse -> Encoding

toJSONList :: [ApiGatewayIntegrationResponse] -> Value

toEncodingList :: [ApiGatewayIntegrationResponse] -> Encoding

FromJSON ApiGatewayIntegrationResponse

Methods

parseJSON :: Value -> Parser ApiGatewayIntegrationResponse

parseJSONList :: Value -> Parser [ApiGatewayIntegrationResponse]

type Rep ApiGatewayIntegrationResponse

type Rep ApiGatewayIntegrationResponse = D1 (MetaData "ApiGatewayIntegrationResponse" "Stratosphere.ResourceProperties.ApiGatewayIntegrationResponse" "stratosphere-0.2.0-B1WeL9cnxuQ3qer3csMa6f" False) (C1 (MetaCons "ApiGatewayIntegrationResponse" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayIntegrationResponseResponseParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object))) (S1 (MetaSel (Just Symbol "_apiGatewayIntegrationResponseResponseTemplates") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object)))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayIntegrationResponseSelectionPattern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_apiGatewayIntegrationResponseStatusCode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))))))

apiGatewayIntegrationResponse :: ApiGatewayIntegrationResponse

Constructor for ApiGatewayIntegrationResponse containing required fields as arguments.

agirResponseParameters :: Lens' ApiGatewayIntegrationResponse (Maybe Object)

The response parameters from the back-end response that API Gateway sends to the method response. Specify response parameters as key-value pairs (string-to-string maps), with a destination as the key and a source as the value. For more information, see API Gateway API Request and Response Parameter-Mapping Reference in the API Gateway Developer Guide. The destination must be an existing response parameter in the MethodResponse property. The source must be an existing method request parameter or a static value. Static values must be enclosed in single quotation marks and pre-encoded based on their destination in the request.

agirResponseTemplates :: Lens' ApiGatewayIntegrationResponse (Maybe Object)

The templates used to transform the integration response body. Specify templates as key-value pairs (string-to-string maps), with a content type as the key and a template as the value. For more information, see API Gateway API Request and Response Payload-Mapping Template Reference in the API Gateway Developer Guide.

agirSelectionPattern :: Lens' ApiGatewayIntegrationResponse (Maybe (Val Text))

A regular expression that specifies which error strings or status codes from the back end map to the integration response.

agirStatusCode :: Lens' ApiGatewayIntegrationResponse (Maybe (Val Text))

The status code that API Gateway uses to map the integration response to a MethodResponse status code.