AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Lists your Kinesis data streams.
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 100.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginListStreams and EndListStreams.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public abstract Task<ListStreamsResponse> ListStreamsAsync( CancellationToken cancellationToken )
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
ExpiredNextTokenException | The pagination token passed to the operation is expired. |
InvalidArgumentException | A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. |
LimitExceededException | The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer