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 |
Updates an existing Method resource.
- updateMethod :: Text -> Text -> Text -> UpdateMethod
- data UpdateMethod
- ummPatchOperations :: Lens' UpdateMethod [PatchOperation]
- ummRestAPIId :: Lens' UpdateMethod Text
- ummResourceId :: Lens' UpdateMethod Text
- ummHttpMethod :: Lens' UpdateMethod Text
- method :: Method
- data Method
- mMethodResponses :: Lens' Method (HashMap Text MethodResponse)
- mHttpMethod :: Lens' Method (Maybe Text)
- mRequestModels :: Lens' Method (HashMap Text Text)
- mRequestParameters :: Lens' Method (HashMap Text Bool)
- mAuthorizerId :: Lens' Method (Maybe Text)
- mAuthorizationType :: Lens' Method (Maybe Text)
- mApiKeyRequired :: Lens' Method (Maybe Bool)
- mMethodIntegration :: Lens' Method (Maybe Integration)
Creating a Request
Creates a value of UpdateMethod
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateMethod Source #
Request to update an existing Method resource.
See: updateMethod
smart constructor.
Request Lenses
ummPatchOperations :: Lens' UpdateMethod [PatchOperation] Source #
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
ummHttpMethod :: Lens' UpdateMethod Text Source #
The HTTP verb that identifies the Method resource.
Destructuring the Response
Creates a value of Method
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Represents a method.
See: method
smart constructor.
Response Lenses
mMethodResponses :: Lens' Method (HashMap Text MethodResponse) Source #
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
mRequestParameters :: Lens' Method (HashMap Text Bool) Source #
Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern 'method.request.{location}.{name}', where location
is either querystring, path, or header. name
is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.
mAuthorizerId :: Lens' Method (Maybe Text) Source #
Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
mApiKeyRequired :: Lens' Method (Maybe Bool) Source #
Specifies whether the method requires a valid ApiKey.
mMethodIntegration :: Lens' Method (Maybe Integration) Source #
The method's integration.