Struct aws_sdk_kinesis::client::fluent_builders::ListStreams

pub struct ListStreams<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to ListStreams.

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 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.

Implementations

impl<C, M, R> ListStreams<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<ListStreamsOutput, SdkError<ListStreamsError>> where
    R::Policy: SmithyRetryPolicy<ListStreamsInputOperationOutputAlias, ListStreamsOutput, ListStreamsError, ListStreamsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn limit(self, inp: i32) -> Self

The maximum number of streams to list.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of streams to list.

pub fn exclusive_start_stream_name(self, inp: impl Into<String>) -> Self

The name of the stream to start the list with.

pub fn set_exclusive_start_stream_name(self, input: Option<String>) -> Self

The name of the stream to start the list with.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for ListStreams<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.