Skip to content

Returns the list of channels in a cluster

Description

Returns the list of channels in a cluster.

Usage

kafka_list_channels(ClusterArn, MaxResults, NextToken, TopicNameFilter)

Arguments

  • ClusterArn

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

  • MaxResults

    Maximum number of channels to return in a single response.

  • NextToken

    If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.

  • TopicNameFilter

    Filters results to channels whose topic name matches the specified value.

Value

A list with the following syntax:

list(
  Channels = list(
    list(
      ChannelArn = "string",
      ChannelName = "string",
      Status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"FAILED"|"SUSPENDING"|"SUSPENDED",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      DestinationType = "ICEBERG"|"S3",
      ClusterOperationArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

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