Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a new RestApi
resource.
- createRestAPI :: Text -> CreateRestAPI
- data CreateRestAPI
- craBinaryMediaTypes :: Lens' CreateRestAPI [Text]
- craVersion :: Lens' CreateRestAPI (Maybe Text)
- craCloneFrom :: Lens' CreateRestAPI (Maybe Text)
- craEndpointConfiguration :: Lens' CreateRestAPI (Maybe EndpointConfiguration)
- craDescription :: Lens' CreateRestAPI (Maybe Text)
- craName :: Lens' CreateRestAPI 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)
- raEndpointConfiguration :: Lens' RestAPI (Maybe EndpointConfiguration)
- raDescription :: Lens' RestAPI (Maybe Text)
Creating a Request
:: Text | |
-> CreateRestAPI |
Creates a value of CreateRestAPI
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
craBinaryMediaTypes
- The list of binary media types supported by theRestApi
. By default, theRestApi
supports only UTF-8-encoded text payloads.craVersion
- A version identifier for the API.craCloneFrom
- The ID of theRestApi
that you want to clone from.craEndpointConfiguration
- The endpoint configuration of thisRestApi
showing the endpoint types of the API.craDescription
- The description of theRestApi
.craName
- The name of theRestApi
.
data CreateRestAPI Source #
The POST Request to add a new RestApi
resource to your collection.
See: createRestAPI
smart constructor.
Request Lenses
craBinaryMediaTypes :: Lens' CreateRestAPI [Text] Source #
The list of binary media types supported by the RestApi
. By default, the RestApi
supports only UTF-8-encoded text payloads.
craVersion :: Lens' CreateRestAPI (Maybe Text) Source #
A version identifier for the API.
craCloneFrom :: Lens' CreateRestAPI (Maybe Text) Source #
The ID of the RestApi
that you want to clone from.
craEndpointConfiguration :: Lens' CreateRestAPI (Maybe EndpointConfiguration) Source #
The endpoint configuration of this RestApi
showing the endpoint types of the API.
craDescription :: Lens' CreateRestAPI (Maybe Text) Source #
The description of the RestApi
.
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 timestamp when the API was created.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.raEndpointConfiguration
- The endpoint configuration of thisRestApi
showing the endpoint types of the API.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.
raId :: Lens' RestAPI (Maybe Text) Source #
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
raEndpointConfiguration :: Lens' RestAPI (Maybe EndpointConfiguration) Source #
The endpoint configuration of this RestApi
showing the endpoint types of the API.