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 |
A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
- putRestAPI :: Text -> HashMap Text Value -> PutRestAPI
- data PutRestAPI
- praMode :: Lens' PutRestAPI (Maybe PutMode)
- praFailOnWarnings :: Lens' PutRestAPI (Maybe Bool)
- praParameters :: Lens' PutRestAPI (HashMap Text Text)
- praRestAPIId :: Lens' PutRestAPI Text
- praBody :: Lens' PutRestAPI (HashMap Text Value)
- 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 PutRestAPI
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
praMode
- Themode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".praFailOnWarnings
- A query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered. The default value isfalse
.praParameters
- Custom headers supplied as part of the request.praRestAPIId
- The identifier of theRestApi
to be updated.praBody
- The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
data PutRestAPI Source #
A PUT request to update an existing API, with external API definitions specified as the request body.
See: putRestAPI
smart constructor.
Request Lenses
praMode :: Lens' PutRestAPI (Maybe PutMode) Source #
The mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
praFailOnWarnings :: Lens' PutRestAPI (Maybe Bool) Source #
A query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered. The default value is false
.
praParameters :: Lens' PutRestAPI (HashMap Text Text) Source #
Custom headers supplied as part of the request.
praRestAPIId :: Lens' PutRestAPI Text Source #
The identifier of the RestApi
to be updated.
praBody :: Lens' PutRestAPI (HashMap Text Value) Source #
The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
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 .