Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Adds a MethodResponse to an existing Method resource.
- putMethodResponse :: Text -> Text -> Text -> Text -> PutMethodResponse
- data PutMethodResponse
- pmResponseModels :: Lens' PutMethodResponse (HashMap Text Text)
- pmResponseParameters :: Lens' PutMethodResponse (HashMap Text Bool)
- pmRestAPIId :: Lens' PutMethodResponse Text
- pmResourceId :: Lens' PutMethodResponse Text
- pmHttpMethod :: Lens' PutMethodResponse Text
- pmStatusCode :: Lens' PutMethodResponse Text
- methodResponse :: MethodResponse
- data MethodResponse
- mResponseModels :: Lens' MethodResponse (HashMap Text Text)
- mStatusCode :: Lens' MethodResponse (Maybe Text)
- mResponseParameters :: Lens' MethodResponse (HashMap Text Bool)
Creating a Request
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:
data PutMethodResponse Source
Request to add a MethodResponse to an existing Method resource.
See: putMethodResponse
smart constructor.
Request Lenses
pmResponseParameters :: Lens' PutMethodResponse (HashMap Text Bool) Source
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a Boolean flag as the value. The
Boolean flag is used to specify whether the parameter is required. A
destination must match the pattern 'method.response.header.{name}',
where name
is a valid, unique header name. Destinations specified here
are available to the integration for mapping from integration response
parameters.
pmHttpMethod :: Lens' PutMethodResponse Text Source
The HTTP verb that identifies the Method resource.
pmStatusCode :: Lens' PutMethodResponse Text Source
The method response's status code.
Destructuring the Response
methodResponse :: MethodResponse Source
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:
data MethodResponse Source
Represents a method response. Amazon API Gateway sends back the status code to the caller as the HTTP status code. Parameters and models can be used to transform the response from the method's integration.
See: methodResponse
smart constructor.
Response Lenses
mStatusCode :: Lens' MethodResponse (Maybe Text) Source
The method response's status code.
mResponseParameters :: Lens' MethodResponse (HashMap Text Bool) Source
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value,
which is used to specify whether the parameter is required. A
destination must match the pattern 'method.response.header.{name}',
where name
is a valid, unique header name. Destinations specified here
are available to the integration for mapping from integration response
parameters.