Struct GetStreamInput 

#[non_exhaustive]
pub struct GetStreamInput {
    pub stream_arn: Option<String>,
    pub max_results: Option<i32>,
    pub shard_filter: Option<ShardFilter>,
    pub next_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stream_arn: Option<String>

The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.

max_results: Option<i32>

The maximum number of shard objects to return in a single GetStream request. Default value is 100. The minimum value is 1 and the maximum value is 100.

shard_filter: Option<ShardFilter>

Optional filter criteria to apply when retrieving shards. You can filter shards based on their state or other attributes to narrow down the results returned by the GetStream operation.

next_token: Option<String>

An optional pagination token provided by a previous GetStream operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.

Implementations

impl GetStreamInput

pub fn stream_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.

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

The maximum number of shard objects to return in a single GetStream request. Default value is 100. The minimum value is 1 and the maximum value is 100.

pub fn shard_filter(&self) -> Option<&ShardFilter>

Optional filter criteria to apply when retrieving shards. You can filter shards based on their state or other attributes to narrow down the results returned by the GetStream operation.

pub fn next_token(&self) -> Option<&str>

An optional pagination token provided by a previous GetStream operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.

impl GetStreamInput

pub fn builder() -> GetStreamInputBuilder

Creates a new builder-style object to manufacture GetStreamInput.

Trait Implementations

impl Clone for GetStreamInput

fn clone(&self) -> GetStreamInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetStreamInput

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

Formats the value using the given formatter.

impl PartialEq for GetStreamInput

fn eq(&self, other: &GetStreamInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetStreamInput