Lists the channels in your account¶

Description¶

Lists the channels in your account. You can filter the results by source stream. The results are paginated. Use the NextToken value returned in the response to retrieve additional results.

Use this operation to find channels before deleting a stream, or to audit the channels configured in an Amazon Web Services Region.

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

Usage¶

kinesis_list_channels(StreamFilter, MaxResults, NextToken)

Arguments¶

• StreamFilter

Filters the results to channels associated with the specified streams.

• MaxResults

The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

• NextToken

The pagination token returned by a previous call. Specify this token to retrieve the next page of results.

Value¶

A list with the following syntax:

list(
  ChannelSummaries = list(
    list(
      ChannelName = "string",
      ChannelARN = "string",
      ChannelId = "string",
      ChannelStatus = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"FAILED",
      ChannelStatusReason = "string",
      ChannelCreationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ChannelDestinationType = "S3"|"S3_TABLES",
      Streams = list(
        list(
          StreamARN = "string",
          StreamCreationTimestamp = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_channels(
  StreamFilter = list(
    list(
      StreamARN = "string",
      StreamCreationTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)