listTopics method

Future<ListTopicsResponse> listTopics({ required String clusterArn, int? maxResults, String? nextToken, String? topicNameFilter, })

List topics in a MSK cluster.

May throw BadRequestException. May throw ForbiddenException. May throw InternalServerErrorException. May throw ServiceUnavailableException. May throw UnauthorizedException.

Parameter clusterArn : The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Parameter maxResults : The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

Parameter 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.

Parameter topicNameFilter : Returns topics starting with given name.

Implementation

Future<ListTopicsResponse> listTopics({
  required String clusterArn,
  int? maxResults,
  String? nextToken,
  String? topicNameFilter,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
    if (topicNameFilter != null) 'topicNameFilter': [topicNameFilter],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/v1/clusters/${Uri.encodeComponent(clusterArn)}/topics',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListTopicsResponse.fromJson(response);
}