paws.analytics (version 0.1.0)

kinesis_list_streams: Lists your Kinesis data streams

Description

Lists your Kinesis data streams.

Usage

kinesis_list_streams(Limit, ExclusiveStartStreamName)

Arguments

Limit

The maximum number of streams to list.

ExclusiveStartStreamName

The name of the stream to start the list with.

Request syntax

svc$list_streams(
  Limit = 123,
  ExclusiveStartStreamName = "string"
)

Details

The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of five transactions per second per account.