Stratosphere.ResourceProperties.ApiGatewayMethodResponse

MethodResponse is a property of the AWS::ApiGateway::Method resource that defines the responses that can be sent to the client who calls an Amazon API Gateway (API Gateway) method.

Documentation

data ApiGatewayMethodResponse

Full data type definition for ApiGatewayMethodResponse. See apiGatewayMethodResponse for a more convenient constructor.

Constructors

ApiGatewayMethodResponse

Fields

• _apiGatewayMethodResponseResponseModels :: Maybe Object
• _apiGatewayMethodResponseResponseParameters :: Maybe Object
• _apiGatewayMethodResponseStatusCode :: Val Text

Instances

Show ApiGatewayMethodResponse

Methods

showsPrec :: Int -> ApiGatewayMethodResponse -> ShowS

show :: ApiGatewayMethodResponse -> String

showList :: [ApiGatewayMethodResponse] -> ShowS

Generic ApiGatewayMethodResponse

Associated Types

type Rep ApiGatewayMethodResponse :: * -> *

Methods

from :: ApiGatewayMethodResponse -> Rep ApiGatewayMethodResponse x

to :: Rep ApiGatewayMethodResponse x -> ApiGatewayMethodResponse

ToJSON ApiGatewayMethodResponse

Methods

toJSON :: ApiGatewayMethodResponse -> Value

toEncoding :: ApiGatewayMethodResponse -> Encoding

toJSONList :: [ApiGatewayMethodResponse] -> Value

toEncodingList :: [ApiGatewayMethodResponse] -> Encoding

FromJSON ApiGatewayMethodResponse

Methods

parseJSON :: Value -> Parser ApiGatewayMethodResponse

parseJSONList :: Value -> Parser [ApiGatewayMethodResponse]

type Rep ApiGatewayMethodResponse

type Rep ApiGatewayMethodResponse = D1 (MetaData "ApiGatewayMethodResponse" "Stratosphere.ResourceProperties.ApiGatewayMethodResponse" "stratosphere-0.2.1-7UjeTxLOKRACY1vyFAxa7V" False) (C1 (MetaCons "ApiGatewayMethodResponse" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayMethodResponseResponseModels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayMethodResponseResponseParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object))) (S1 (MetaSel (Just Symbol "_apiGatewayMethodResponseStatusCode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))))))

apiGatewayMethodResponse

Arguments

:: Val Text

agmrStatusCode

-> ApiGatewayMethodResponse

Constructor for ApiGatewayMethodResponse containing required fields as arguments.

agmrResponseModels :: Lens' ApiGatewayMethodResponse (Maybe Object)

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

agmrResponseParameters :: Lens' ApiGatewayMethodResponse (Maybe Object)

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header.name, where the name is a valid, unique header name. The Boolean specifies whether a parameter is required.

agmrStatusCode :: Lens' ApiGatewayMethodResponse (Val Text)

The method response's status code, which you map to an IntegrationResponse.