Struct aws_sdk_kinesis::operation::list_streams::builders::ListStreamsFluentBuilder

pub struct ListStreamsFluentBuilder { /* private fields */ }

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

impl ListStreamsFluentBuilder

pub fn as_input(&self) -> &ListStreamsInputBuilder

Access the ListStreams as a reference.

pub async fn send( self ) -> Result<ListStreamsOutput, SdkError<ListStreamsError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<ListStreamsOutput, ListStreamsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListStreamsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

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.

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.

pub fn get_limit(&self) -> &Option<i32>

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.

pub fn exclusive_start_stream_name(self, input: 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.

pub fn get_exclusive_start_stream_name(&self) -> &Option<String>

The name of the stream to start the list with.

pub fn next_token(self, input: impl Into<String>) -> Self

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

pub fn get_next_token(&self) -> &Option<String>

Trait Implementations

impl Clone for ListStreamsFluentBuilder

fn clone(&self) -> ListStreamsFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListStreamsFluentBuilder

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

Formats the value using the given formatter.