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 ListClustersV2 = ListClustersV2' {}
- newListClustersV2 :: ListClustersV2
- listClustersV2_clusterNameFilter :: Lens' ListClustersV2 (Maybe Text)
- listClustersV2_clusterTypeFilter :: Lens' ListClustersV2 (Maybe Text)
- listClustersV2_maxResults :: Lens' ListClustersV2 (Maybe Natural)
- listClustersV2_nextToken :: Lens' ListClustersV2 (Maybe Text)
- data ListClustersV2Response = ListClustersV2Response' {
- clusterInfoList :: Maybe [Cluster]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListClustersV2Response :: Int -> ListClustersV2Response
- listClustersV2Response_clusterInfoList :: Lens' ListClustersV2Response (Maybe [Cluster])
- listClustersV2Response_nextToken :: Lens' ListClustersV2Response (Maybe Text)
- listClustersV2Response_httpStatus :: Lens' ListClustersV2Response Int
Creating a Request
data ListClustersV2 Source #
See: newListClustersV2
smart constructor.
ListClustersV2' | |
|
Instances
newListClustersV2 :: ListClustersV2 Source #
Create a value of ListClustersV2
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:ListClustersV2'
, listClustersV2_clusterNameFilter
- Specify a prefix of the names of the clusters that you want to list. The
service lists all the clusters whose names start with this prefix.
$sel:clusterTypeFilter:ListClustersV2'
, listClustersV2_clusterTypeFilter
- Specify either PROVISIONED or SERVERLESS.
$sel:maxResults:ListClustersV2'
, listClustersV2_maxResults
- The maximum number of results to return in the response. If there are
more results, the response includes a NextToken parameter.
ListClustersV2
, listClustersV2_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
listClustersV2_clusterNameFilter :: Lens' ListClustersV2 (Maybe Text) Source #
Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
listClustersV2_clusterTypeFilter :: Lens' ListClustersV2 (Maybe Text) Source #
Specify either PROVISIONED or SERVERLESS.
listClustersV2_maxResults :: Lens' ListClustersV2 (Maybe Natural) Source #
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
listClustersV2_nextToken :: Lens' ListClustersV2 (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 ListClustersV2Response Source #
See: newListClustersV2Response
smart constructor.
ListClustersV2Response' | |
|
Instances
newListClustersV2Response Source #
Create a value of ListClustersV2Response
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:ListClustersV2Response'
, listClustersV2Response_clusterInfoList
- Information on each of the MSK clusters in the response.
ListClustersV2
, listClustersV2Response_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:ListClustersV2Response'
, listClustersV2Response_httpStatus
- The response's http status code.
Response Lenses
listClustersV2Response_clusterInfoList :: Lens' ListClustersV2Response (Maybe [Cluster]) Source #
Information on each of the MSK clusters in the response.
listClustersV2Response_nextToken :: Lens' ListClustersV2Response (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.
listClustersV2Response_httpStatus :: Lens' ListClustersV2Response Int Source #
The response's http status code.