1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeStream`](crate::operation::describe_stream::builders::DescribeStreamFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`stream_arn(impl Into<String>)`](crate::operation::describe_stream::builders::DescribeStreamFluentBuilder::stream_arn) / [`set_stream_arn(Option<String>)`](crate::operation::describe_stream::builders::DescribeStreamFluentBuilder::set_stream_arn): <p>The Amazon Resource Name (ARN) for the stream.</p>
    ///   - [`limit(i32)`](crate::operation::describe_stream::builders::DescribeStreamFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_stream::builders::DescribeStreamFluentBuilder::set_limit): <p>The maximum number of shard objects to return. The upper limit is 100.</p>
    ///   - [`exclusive_start_shard_id(impl Into<String>)`](crate::operation::describe_stream::builders::DescribeStreamFluentBuilder::exclusive_start_shard_id) / [`set_exclusive_start_shard_id(Option<String>)`](crate::operation::describe_stream::builders::DescribeStreamFluentBuilder::set_exclusive_start_shard_id): <p>The shard ID of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedShardId</code> in the previous operation. </p>
    /// - On success, responds with [`DescribeStreamOutput`](crate::operation::describe_stream::DescribeStreamOutput) with field(s):
    ///   - [`stream_description(Option<StreamDescription>)`](crate::operation::describe_stream::DescribeStreamOutput::stream_description): <p>A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.</p>
    /// - On failure, responds with [`SdkError<DescribeStreamError>`](crate::operation::describe_stream::DescribeStreamError)
    pub fn describe_stream(&self) -> crate::operation::describe_stream::builders::DescribeStreamFluentBuilder {
        crate::operation::describe_stream::builders::DescribeStreamFluentBuilder::new(self.handle.clone())
    }
}