AWS SDK Version 3 for .NET
API Reference

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.

Container for the parameters to the ListStreams operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Kinesis.AmazonKinesisRequest
      Amazon.Kinesis.Model.ListStreamsRequest

Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z

Syntax

C#
public class ListStreamsRequest : AmazonKinesisRequest
         IAmazonWebServiceRequest

The ListStreamsRequest type exposes the following members

Constructors

NameDescription
Public Method ListStreamsRequest()

Properties

NameTypeDescription
Public Property ExclusiveStartStreamName System.String

Gets and sets the property ExclusiveStartStreamName.

The name of the stream to start the list with.

Public Property Limit System.Int32

Gets and sets the property Limit.

The maximum number of streams to list. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

Public Property NextToken System.String

Gets and sets the property NextToken.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5