Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns a list of all the MSK clusters in the current Region.
This operation returns paginated results.
Synopsis
- data ListClusters = ListClusters' {}
- newListClusters :: ListClusters
- listClusters_clusterNameFilter :: Lens' ListClusters (Maybe Text)
- listClusters_maxResults :: Lens' ListClusters (Maybe Natural)
- listClusters_nextToken :: Lens' ListClusters (Maybe Text)
- data ListClustersResponse = ListClustersResponse' {
- clusterInfoList :: Maybe [ClusterInfo]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListClustersResponse :: Int -> ListClustersResponse
- listClustersResponse_clusterInfoList :: Lens' ListClustersResponse (Maybe [ClusterInfo])
- listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)
- listClustersResponse_httpStatus :: Lens' ListClustersResponse Int
Creating a Request
data ListClusters Source #
See: newListClusters
smart constructor.
ListClusters' | |
|
Instances
newListClusters :: ListClusters Source #
Create a value of ListClusters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterNameFilter:ListClusters'
, listClusters_clusterNameFilter
- Specify a prefix of the name of the clusters that you want to list. The
service lists all the clusters whose names start with this prefix.
$sel:maxResults:ListClusters'
, listClusters_maxResults
- The maximum number of results to return in the response. If there are
more results, the response includes a NextToken parameter.
ListClusters
, listClusters_nextToken
- The paginated results marker. When the result of the operation is
truncated, the call returns NextToken in the response. To get the next
batch, provide this token in your next request.
Request Lenses
listClusters_clusterNameFilter :: Lens' ListClusters (Maybe Text) Source #
Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #
The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.
Destructuring the Response
data ListClustersResponse Source #
See: newListClustersResponse
smart constructor.
ListClustersResponse' | |
|
Instances
newListClustersResponse Source #
Create a value of ListClustersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterInfoList:ListClustersResponse'
, listClustersResponse_clusterInfoList
- Information on each of the MSK clusters in the response.
ListClusters
, listClustersResponse_nextToken
- The paginated results marker. When the result of a ListClusters
operation is truncated, the call returns NextToken in the response. To
get another batch of clusters, provide this token in your next request.
$sel:httpStatus:ListClustersResponse'
, listClustersResponse_httpStatus
- The response's http status code.
Response Lenses
listClustersResponse_clusterInfoList :: Lens' ListClustersResponse (Maybe [ClusterInfo]) Source #
Information on each of the MSK clusters in the response.
listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #
The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.
listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #
The response's http status code.