| Copyright | (c) 2013-2015 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 |
Network.AWS.APIGateway.GetRestAPIs
Description
Lists the RestApis resources for your collection.
See: AWS API Reference for GetRestAPIs.
- getRestAPIs :: GetRestAPIs
- data GetRestAPIs
- graLimit :: Lens' GetRestAPIs (Maybe Int)
- graPosition :: Lens' GetRestAPIs (Maybe Text)
- getRestAPIsResponse :: Int -> GetRestAPIsResponse
- data GetRestAPIsResponse
- grarsItems :: Lens' GetRestAPIsResponse [RestAPI]
- grarsPosition :: Lens' GetRestAPIsResponse (Maybe Text)
- grarsResponseStatus :: Lens' GetRestAPIsResponse Int
Creating a Request
getRestAPIs :: GetRestAPIs Source
Creates a value of GetRestAPIs with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetRestAPIs Source
Request to list existing RestApis defined for your collection.
See: getRestAPIs smart constructor.
Instances
Request Lenses
graLimit :: Lens' GetRestAPIs (Maybe Int) Source
The maximum number of RestApi resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
graPosition :: Lens' GetRestAPIs (Maybe Text) Source
The position of the current RestApis resource in the collection to get information about.
Destructuring the Response
Arguments
| :: Int | |
| -> GetRestAPIsResponse |
Creates a value of GetRestAPIsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetRestAPIsResponse Source
Contains references to your APIs and links that guide you in ways to interact with your collection. A collection offers a paginated view of your APIs.
See: getRestAPIsResponse smart constructor.
Response Lenses
grarsItems :: Lens' GetRestAPIsResponse [RestAPI] Source
An array of links to the current page of RestApi resources.
grarsPosition :: Lens' GetRestAPIsResponse (Maybe Text) Source
Undocumented member.
grarsResponseStatus :: Lens' GetRestAPIsResponse Int Source
The response status code.