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 |
Changes information about the specified API.
- updateRestAPI :: Text -> UpdateRestAPI
- data UpdateRestAPI
- uraPatchOperations :: Lens' UpdateRestAPI [PatchOperation]
- uraRestAPIId :: Lens' UpdateRestAPI Text
- restAPI :: RestAPI
- data RestAPI
- raBinaryMediaTypes :: Lens' RestAPI [Text]
- raWarnings :: Lens' RestAPI [Text]
- raCreatedDate :: Lens' RestAPI (Maybe UTCTime)
- raName :: Lens' RestAPI (Maybe Text)
- raVersion :: Lens' RestAPI (Maybe Text)
- raId :: Lens' RestAPI (Maybe Text)
- raDescription :: Lens' RestAPI (Maybe Text)
Creating a Request
Creates a value of UpdateRestAPI
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uraPatchOperations
- A list of update operations to be applied to the specified resource and in the order specified in this list.uraRestAPIId
- The ID of theRestApi
you want to update.
data UpdateRestAPI Source #
Request to update an existing RestApi
resource in your collection.
See: updateRestAPI
smart constructor.
Request Lenses
uraPatchOperations :: Lens' UpdateRestAPI [PatchOperation] Source #
A list of update operations to be applied to the specified resource and in the order specified in this list.
uraRestAPIId :: Lens' UpdateRestAPI Text Source #
The ID of the RestApi
you want to update.
Destructuring the Response
Creates a value of RestAPI
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
raBinaryMediaTypes
- The list of binary media types supported by theRestApi
. By default, theRestApi
supports only UTF-8-encoded text payloads.raWarnings
- The warning messages reported whenfailonwarnings
is turned on during API import.raCreatedDate
- The date when the API was created, in ISO 8601 format .raName
- The API's name.raVersion
- A version identifier for the API.raId
- The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.raDescription
- The API's description.
Response Lenses
raBinaryMediaTypes :: Lens' RestAPI [Text] Source #
The list of binary media types supported by the RestApi
. By default, the RestApi
supports only UTF-8-encoded text payloads.
raWarnings :: Lens' RestAPI [Text] Source #
The warning messages reported when failonwarnings
is turned on during API import.
raCreatedDate :: Lens' RestAPI (Maybe UTCTime) Source #
The date when the API was created, in ISO 8601 format .