listChannels

abstract suspend fun listChannels(input: ListChannelsRequest = ListChannelsRequest { }): ListChannelsResponse

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.

Samples

// To list channels
val resp = kinesisClient.listChannels()
// To list channels filtered by stream
val resp = kinesisClient.listChannels {
    streamFilter = listOf<StreamFilter>(
        StreamFilter {
            streamArn = "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream-name"
        }            
    )
    maxResults = 10
}