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 |
Returns a list of existing clusters.
This operation returns paginated results.
- listClusters :: ListClusters
- data ListClusters
- lcNextToken :: Lens' ListClusters (Maybe Text)
- lcMaxResults :: Lens' ListClusters (Maybe Int)
- listClustersResponse :: Int -> ListClustersResponse
- data ListClustersResponse
- lcrsClusterARNs :: Lens' ListClustersResponse [Text]
- 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
- ThenextToken
value returned from a previous paginatedListClusters
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return.lcMaxResults
- The maximum number of cluster results returned byListClusters
in paginated output. When this parameter is used,ListClusters
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListClusters
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListClusters
returns up to 100 results and anextToken
value if applicable.
data ListClusters Source #
See: listClusters
smart constructor.
Request Lenses
lcNextToken :: Lens' ListClusters (Maybe Text) Source #
The nextToken
value returned from a previous paginated ListClusters
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value. This value is null
when there are no more results to return.
lcMaxResults :: Lens' ListClusters (Maybe Int) Source #
The maximum number of cluster results returned by ListClusters
in paginated output. When this parameter is used, ListClusters
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListClusters
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListClusters
returns up to 100 results and a nextToken
value if applicable.
Destructuring the Response
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:
lcrsClusterARNs
- The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.lcrsNextToken
- ThenextToken
value to include in a futureListClusters
request. When the results of aListClusters
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.lcrsResponseStatus
- -- | The response status code.
data ListClustersResponse Source #
See: listClustersResponse
smart constructor.
Response Lenses
lcrsClusterARNs :: Lens' ListClustersResponse [Text] Source #
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
lcrsNextToken :: Lens' ListClustersResponse (Maybe Text) Source #
The nextToken
value to include in a future ListClusters
request. When the results of a ListClusters
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
lcrsResponseStatus :: Lens' ListClustersResponse Int Source #
- - | The response status code.