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 |
Lists the RestApi
resource in the collection.
- getRestAPI :: Text -> GetRestAPI
- data GetRestAPI
- graRestAPIId :: Lens' GetRestAPI 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
Creates a value of GetRestAPI
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
graRestAPIId
- The identifier of theRestApi
resource.
data GetRestAPI Source #
The GET request to list an existing RestApi
defined for your collection.
See: getRestAPI
smart constructor.
Request Lenses
graRestAPIId :: Lens' GetRestAPI Text Source #
The identifier of the RestApi
resource.
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.