Network.AWS.APIGateway.GetMethodResponse

Describes a MethodResponse resource.

Creating a Request

getMethodResponse

Arguments

:: Text

gmRestAPIId

-> Text

gmResourceId

-> Text

gmHttpMethod

-> Text

gmStatusCode

-> GetMethodResponse

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

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

• gmRestAPIId - The string identifier of the associated RestApi .
• gmResourceId - The Resource identifier for the MethodResponse resource.
• gmHttpMethod - The HTTP verb of the Method resource.
• gmStatusCode - The status code for the MethodResponse resource.

data GetMethodResponse

Request to describe a MethodResponse resource.

See: getMethodResponse smart constructor.

Instances

Eq GetMethodResponse

Methods

(==) :: GetMethodResponse -> GetMethodResponse -> Bool

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

Data GetMethodResponse

Methods

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

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

toConstr :: GetMethodResponse -> Constr

dataTypeOf :: GetMethodResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetMethodResponse

Methods

readsPrec :: Int -> ReadS GetMethodResponse

readList :: ReadS [GetMethodResponse]

readPrec :: ReadPrec GetMethodResponse

readListPrec :: ReadPrec [GetMethodResponse]

Show GetMethodResponse

Methods

showsPrec :: Int -> GetMethodResponse -> ShowS

show :: GetMethodResponse -> String

showList :: [GetMethodResponse] -> ShowS

Generic GetMethodResponse

Associated Types

type Rep GetMethodResponse :: * -> *

Methods

from :: GetMethodResponse -> Rep GetMethodResponse x

to :: Rep GetMethodResponse x -> GetMethodResponse

Hashable GetMethodResponse

Methods

hashWithSalt :: Int -> GetMethodResponse -> Int

hash :: GetMethodResponse -> Int

NFData GetMethodResponse

Methods

rnf :: GetMethodResponse -> ()

AWSRequest GetMethodResponse

Associated Types

type Rs GetMethodResponse :: *

Methods

request :: GetMethodResponse -> Request GetMethodResponse

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

ToQuery GetMethodResponse

Methods

toQuery :: GetMethodResponse -> QueryString

ToPath GetMethodResponse

Methods

toPath :: GetMethodResponse -> ByteString

ToHeaders GetMethodResponse

Methods

toHeaders :: GetMethodResponse -> [Header]

type Rep GetMethodResponse

type Rep GetMethodResponse = D1 (MetaData "GetMethodResponse" "Network.AWS.APIGateway.GetMethodResponse" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetMethodResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gmRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gmResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gmHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gmStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetMethodResponse

type Rs GetMethodResponse = MethodResponse

Request Lenses

gmRestAPIId :: Lens' GetMethodResponse Text

The string identifier of the associated RestApi .

gmResourceId :: Lens' GetMethodResponse Text

The Resource identifier for the MethodResponse resource.

gmHttpMethod :: Lens' GetMethodResponse Text

The HTTP verb of the Method resource.

gmStatusCode :: Lens' GetMethodResponse Text

The status code for the MethodResponse resource.

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 Amazon 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. Amazon 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.5.0-3jDq4KKltGt78uikPpOCEJ" 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 Amazon 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. Amazon 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.)