| 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 |
Network.AWS.APIGateway.GetDeployments
Description
Gets information about a Deployments collection.
This operation returns paginated results.
- getDeployments :: Text -> GetDeployments
- data GetDeployments
- gdLimit :: Lens' GetDeployments (Maybe Int)
- gdPosition :: Lens' GetDeployments (Maybe Text)
- gdRestAPIId :: Lens' GetDeployments Text
- getDeploymentsResponse :: Int -> GetDeploymentsResponse
- data GetDeploymentsResponse
- gdrsItems :: Lens' GetDeploymentsResponse [Deployment]
- gdrsPosition :: Lens' GetDeploymentsResponse (Maybe Text)
- gdrsResponseStatus :: Lens' GetDeploymentsResponse Int
Creating a Request
Arguments
| :: Text | |
| -> GetDeployments |
Creates a value of GetDeployments with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetDeployments Source
Requests Amazon API Gateway to get information about a Deployments collection.
See: getDeployments smart constructor.
Instances
Request Lenses
gdLimit :: Lens' GetDeployments (Maybe Int) Source
The maximum number of Deployment resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
gdPosition :: Lens' GetDeployments (Maybe Text) Source
The position of the current Deployment resource in the collection to get information about.
gdRestAPIId :: Lens' GetDeployments Text Source
The identifier of the RestApi resource for the collection of Deployment resources to get information about.
Destructuring the Response
Arguments
| :: Int | |
| -> GetDeploymentsResponse |
Creates a value of GetDeploymentsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetDeploymentsResponse Source
Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on ways to interact with your collection. The collection offers a paginated view of the contained deployments.
See: getDeploymentsResponse smart constructor.
Response Lenses
gdrsItems :: Lens' GetDeploymentsResponse [Deployment] Source
The current page of any Deployment resources in the collection of deployment resources.
gdrsPosition :: Lens' GetDeploymentsResponse (Maybe Text) Source
Undocumented member.
gdrsResponseStatus :: Lens' GetDeploymentsResponse Int Source
The response status code.