Struct aws_sdk_kinesis::input::DescribeStreamInput

#[non_exhaustive]
pub struct DescribeStreamInput {
    pub stream_name: Option<String>,
    pub limit: Option<i32>,
    pub exclusive_start_shard_id: Option<String>,
}

Represents the input for DescribeStream.

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_name: Option<String>

The name of the stream to describe.

limit: Option<i32>

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

exclusive_start_shard_id: Option<String>

The shard ID of the shard to start with.

Implementations

impl DescribeStreamInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeStream, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribeStream>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeStreamInput

impl DescribeStreamInput

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

The name of the stream to describe.

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

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

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

The shard ID of the shard to start with.

Trait Implementations

impl Clone for DescribeStreamInput

fn clone(&self) -> DescribeStreamInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeStreamInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeStreamInput> for DescribeStreamInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for DescribeStreamInput