Skip to content

List Topics

kafka_list_topics R Documentation

List topics in a MSK cluster

Description

List topics in a MSK cluster.

Usage

kafka_list_topics(ClusterArn, MaxResults, NextToken, TopicNameFilter)

Arguments

ClusterArn

[required] The Amazon Resource Name (ARN) that uniquely identifies the cluster.

MaxResults

The maximum number of results to return in the response. If there are more results, the response includes a NextToken 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.

TopicNameFilter

Returns topics starting with given name.

Value

A list with the following syntax:

list(
  Topics = list(
    list(
      TopicArn = "string",
      TopicName = "string",
      ReplicationFactor = 123,
      PartitionCount = 123,
      OutOfSyncReplicaCount = 123
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_topics(
  ClusterArn = "string",
  MaxResults = 123,
  NextToken = "string",
  TopicNameFilter = "string"
)