aws_sdk_qldb/client/
describe_journal_kinesis_stream.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeJournalKinesisStream`](crate::operation::describe_journal_kinesis_stream::builders::DescribeJournalKinesisStreamFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`ledger_name(impl Into<String>)`](crate::operation::describe_journal_kinesis_stream::builders::DescribeJournalKinesisStreamFluentBuilder::ledger_name) / [`set_ledger_name(Option<String>)`](crate::operation::describe_journal_kinesis_stream::builders::DescribeJournalKinesisStreamFluentBuilder::set_ledger_name):<br>required: **true**<br><p>The name of the ledger.</p><br>
7    ///   - [`stream_id(impl Into<String>)`](crate::operation::describe_journal_kinesis_stream::builders::DescribeJournalKinesisStreamFluentBuilder::stream_id) / [`set_stream_id(Option<String>)`](crate::operation::describe_journal_kinesis_stream::builders::DescribeJournalKinesisStreamFluentBuilder::set_stream_id):<br>required: **true**<br><p>The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe.</p><br>
8    /// - On success, responds with [`DescribeJournalKinesisStreamOutput`](crate::operation::describe_journal_kinesis_stream::DescribeJournalKinesisStreamOutput) with field(s):
9    ///   - [`stream(Option<JournalKinesisStreamDescription>)`](crate::operation::describe_journal_kinesis_stream::DescribeJournalKinesisStreamOutput::stream): <p>Information about the QLDB journal stream returned by a <code>DescribeJournalS3Export</code> request.</p>
10    /// - On failure, responds with [`SdkError<DescribeJournalKinesisStreamError>`](crate::operation::describe_journal_kinesis_stream::DescribeJournalKinesisStreamError)
11    pub fn describe_journal_kinesis_stream(
12        &self,
13    ) -> crate::operation::describe_journal_kinesis_stream::builders::DescribeJournalKinesisStreamFluentBuilder {
14        crate::operation::describe_journal_kinesis_stream::builders::DescribeJournalKinesisStreamFluentBuilder::new(self.handle.clone())
15    }
16}