Network.AWS.APIGateway.PutMethodResponse

Adds a MethodResponse to an existing Method resource.

Creating a Request

putMethodResponse

Arguments

:: Text

pmRestAPIId

-> Text

pmResourceId

-> Text

pmHttpMethod

-> Text

pmStatusCode

-> PutMethodResponse

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

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

• pmResponseModels - Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
• pmResponseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the > prefix.)
• pmRestAPIId - [Required] The string identifier of the associated RestApi .
• pmResourceId - [Required] The Resource identifier for the Method resource.
• pmHttpMethod - [Required] The HTTP verb of the Method resource.
• pmStatusCode - [Required] The method response's status code.

data PutMethodResponse

Request to add a MethodResponse to an existing Method resource.

See: putMethodResponse smart constructor.

Instances

Eq PutMethodResponse

Methods

(==) :: PutMethodResponse -> PutMethodResponse -> Bool

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

Data PutMethodResponse

Methods

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

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

toConstr :: PutMethodResponse -> Constr

dataTypeOf :: PutMethodResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read PutMethodResponse

Methods

readsPrec :: Int -> ReadS PutMethodResponse

readList :: ReadS [PutMethodResponse]

readPrec :: ReadPrec PutMethodResponse

readListPrec :: ReadPrec [PutMethodResponse]

Show PutMethodResponse

Methods

showsPrec :: Int -> PutMethodResponse -> ShowS

show :: PutMethodResponse -> String

showList :: [PutMethodResponse] -> ShowS

Generic PutMethodResponse

Associated Types

type Rep PutMethodResponse :: * -> *

Methods

from :: PutMethodResponse -> Rep PutMethodResponse x

to :: Rep PutMethodResponse x -> PutMethodResponse

Hashable PutMethodResponse

Methods

hashWithSalt :: Int -> PutMethodResponse -> Int

hash :: PutMethodResponse -> Int

ToJSON PutMethodResponse

Methods

toJSON :: PutMethodResponse -> Value

toEncoding :: PutMethodResponse -> Encoding

toJSONList :: [PutMethodResponse] -> Value

toEncodingList :: [PutMethodResponse] -> Encoding

NFData PutMethodResponse

Methods

rnf :: PutMethodResponse -> ()

AWSRequest PutMethodResponse

Associated Types

type Rs PutMethodResponse :: *

Methods

request :: PutMethodResponse -> Request PutMethodResponse

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

ToHeaders PutMethodResponse

Methods

toHeaders :: PutMethodResponse -> [Header]

ToPath PutMethodResponse

Methods

toPath :: PutMethodResponse -> ByteString

ToQuery PutMethodResponse

Methods

toQuery :: PutMethodResponse -> QueryString

type Rep PutMethodResponse

type Rep PutMethodResponse = D1 * (MetaData "PutMethodResponse" "Network.AWS.APIGateway.PutMethodResponse" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "PutMethodResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_pmResponseModels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pmResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Bool)))) (S1 * (MetaSel (Just Symbol "_pmRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pmResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_pmHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_pmStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs PutMethodResponse

type Rs PutMethodResponse = MethodResponse

Request Lenses

pmResponseModels :: Lens' PutMethodResponse (HashMap Text Text)

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

pmResponseParameters :: Lens' PutMethodResponse (HashMap Text Bool)

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the > prefix.)

pmRestAPIId :: Lens' PutMethodResponse Text

Required

The string identifier of the associated RestApi .

pmResourceId :: Lens' PutMethodResponse Text

Required

The Resource identifier for the Method resource.

pmHttpMethod :: Lens' PutMethodResponse Text

Required

The HTTP verb of the Method resource.

pmStatusCode :: Lens' PutMethodResponse Text

Required

The method response's status code.

Destructuring the Response

methodResponse :: MethodResponse

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

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

• mResponseModels - Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
• mStatusCode - The method response's status code.
• mResponseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse . The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the > prefix.)

data MethodResponse

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

Example: A MethodResponse instance of an API Request The example request retrieves a MethodResponse of the 200 status code.

@GET restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160603us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns 200 OK@ status and a payload as follows:

@{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "title": "200" }, "methodresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" }, "methodresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" } }, "responseModels": { "application/json": Empty }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } @

Method , IntegrationResponse , Integration Creating an API

See: methodResponse smart constructor.

Instances

Eq MethodResponse

Methods

(==) :: MethodResponse -> MethodResponse -> Bool

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

Data MethodResponse

Methods

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

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

toConstr :: MethodResponse -> Constr

dataTypeOf :: MethodResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read MethodResponse

Methods

readsPrec :: Int -> ReadS MethodResponse

readList :: ReadS [MethodResponse]

readPrec :: ReadPrec MethodResponse

readListPrec :: ReadPrec [MethodResponse]

Show MethodResponse

Methods

showsPrec :: Int -> MethodResponse -> ShowS

show :: MethodResponse -> String

showList :: [MethodResponse] -> ShowS

Generic MethodResponse

Associated Types

type Rep MethodResponse :: * -> *

Methods

from :: MethodResponse -> Rep MethodResponse x

to :: Rep MethodResponse x -> MethodResponse

Hashable MethodResponse

Methods

hashWithSalt :: Int -> MethodResponse -> Int

hash :: MethodResponse -> Int

FromJSON MethodResponse

Methods

parseJSON :: Value -> Parser MethodResponse

parseJSONList :: Value -> Parser [MethodResponse]

NFData MethodResponse

Methods

rnf :: MethodResponse -> ()

type Rep MethodResponse

type Rep MethodResponse = D1 * (MetaData "MethodResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "MethodResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_mResponseModels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Bool)))))))

Response Lenses

mResponseModels :: Lens' MethodResponse (HashMap Text Text)

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

mStatusCode :: Lens' MethodResponse (Maybe Text)

The method response's status code.

mResponseParameters :: Lens' MethodResponse (HashMap Text Bool)

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse . The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the > prefix.)