Struct aws_sdk_kinesis::input::DescribeStreamInput

#[non_exhaustive]
pub struct DescribeStreamInput { /* private fields */ }

Represents the input for DescribeStream.

Implementations

impl DescribeStreamInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeStream, AwsResponseRetryClassifier>, 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 results are returned.

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

The shard ID of the shard to start with.

Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows ExclusiveStartShardId.

If you don't specify this parameter, the default behavior for DescribeStream is to describe the stream starting with the first shard in the stream.

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

The ARN of the stream.

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: &Rhs) -> bool

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

impl StructuralPartialEq for DescribeStreamInput