Struct aws_sdk_kinesis::client::fluent_builders::ListStreams
source · pub struct ListStreams { /* private fields */ }
Expand description
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 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.
Implementations§
source§impl ListStreams
impl ListStreams
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<ListStreams, AwsResponseRetryClassifier>, SdkError<ListStreamsError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<ListStreams, AwsResponseRetryClassifier>, SdkError<ListStreamsError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(self) -> Result<ListStreamsOutput, SdkError<ListStreamsError>>
pub async fn send(self) -> Result<ListStreamsOutput, SdkError<ListStreamsError>>
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.
sourcepub fn into_paginator(self) -> ListStreamsPaginator
pub fn into_paginator(self) -> ListStreamsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
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.
sourcepub fn set_limit(self, input: Option<i32>) -> Self
pub fn set_limit(self, input: Option<i32>) -> Self
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.
sourcepub fn exclusive_start_stream_name(self, input: impl Into<String>) -> Self
pub fn exclusive_start_stream_name(self, input: impl Into<String>) -> Self
The name of the stream to start the list with.
sourcepub fn set_exclusive_start_stream_name(self, input: Option<String>) -> Self
pub fn set_exclusive_start_stream_name(self, input: Option<String>) -> Self
The name of the stream to start the list with.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
Trait Implementations§
source§impl Clone for ListStreams
impl Clone for ListStreams
source§fn clone(&self) -> ListStreams
fn clone(&self) -> ListStreams
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more