| Copyright | (c) 2013-2018 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 |
Network.AWS.Snowball.ListClusters
Description
Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
Synopsis
- listClusters :: ListClusters
- data ListClusters
- lcNextToken :: Lens' ListClusters (Maybe Text)
- lcMaxResults :: Lens' ListClusters (Maybe Natural)
- listClustersResponse :: Int -> ListClustersResponse
- data ListClustersResponse
- lcrsClusterListEntries :: Lens' ListClustersResponse [ClusterListEntry]
- lcrsNextToken :: Lens' ListClustersResponse (Maybe Text)
- lcrsResponseStatus :: Lens' ListClustersResponse Int
Creating a Request
listClusters :: ListClusters Source #
Creates a value of ListClusters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcNextToken- HTTP requests are stateless. To identify what object comes "next" in the list ofClusterListEntryobjects, you have the option of specifyingNextTokenas the starting point for your returned list.lcMaxResults- The number ofClusterListEntryobjects to return.
data ListClusters Source #
See: listClusters smart constructor.
Instances
Request Lenses
lcNextToken :: Lens' ListClusters (Maybe Text) Source #
HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.
lcMaxResults :: Lens' ListClusters (Maybe Natural) Source #
The number of ClusterListEntry objects to return.
Destructuring the Response
Arguments
| :: Int | |
| -> ListClustersResponse |
Creates a value of ListClustersResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcrsClusterListEntries- EachClusterListEntryobject contains a cluster's state, a cluster's ID, and other important status information.lcrsNextToken- HTTP requests are stateless. If you use the automatically generatedNextTokenvalue in your nextClusterListEntrycall, your list of returned clusters will start from this point in the array.lcrsResponseStatus- -- | The response status code.
data ListClustersResponse Source #
See: listClustersResponse smart constructor.
Instances
Response Lenses
lcrsClusterListEntries :: Lens' ListClustersResponse [ClusterListEntry] Source #
Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
lcrsNextToken :: Lens' ListClustersResponse (Maybe Text) Source #
HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.
lcrsResponseStatus :: Lens' ListClustersResponse Int Source #
- - | The response status code.