aws_sdk_dsql/client/
get_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 [`GetStream`](crate::operation::get_stream::builders::GetStreamFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_identifier(impl Into<String>)`](crate::operation::get_stream::builders::GetStreamFluentBuilder::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::operation::get_stream::builders::GetStreamFluentBuilder::set_cluster_identifier):<br>required: **true**<br><p>The ID of the cluster containing the stream to retrieve.</p><br>
7    ///   - [`stream_identifier(impl Into<String>)`](crate::operation::get_stream::builders::GetStreamFluentBuilder::stream_identifier) / [`set_stream_identifier(Option<String>)`](crate::operation::get_stream::builders::GetStreamFluentBuilder::set_stream_identifier):<br>required: **true**<br><p>The ID of the stream to retrieve.</p><br>
8    /// - On success, responds with [`GetStreamOutput`](crate::operation::get_stream::GetStreamOutput) with field(s):
9    ///   - [`cluster_identifier(String)`](crate::operation::get_stream::GetStreamOutput::cluster_identifier): <p>The ID of the cluster for the retrieved stream.</p>
10    ///   - [`stream_identifier(String)`](crate::operation::get_stream::GetStreamOutput::stream_identifier): <p>The ID of the retrieved stream.</p>
11    ///   - [`arn(String)`](crate::operation::get_stream::GetStreamOutput::arn): <p>The ARN of the retrieved stream.</p>
12    ///   - [`status(StreamStatus)`](crate::operation::get_stream::GetStreamOutput::status): <p>The current status of the retrieved stream.</p>
13    ///   - [`creation_time(DateTime)`](crate::operation::get_stream::GetStreamOutput::creation_time): <p>The time when the stream was created.</p>
14    ///   - [`ordering(StreamOrdering)`](crate::operation::get_stream::GetStreamOutput::ordering): <p>The ordering mode of the stream.</p>
15    ///   - [`format(StreamFormat)`](crate::operation::get_stream::GetStreamOutput::format): <p>The format of the stream records.</p>
16    ///   - [`target_definition(Option<TargetDefinition>)`](crate::operation::get_stream::GetStreamOutput::target_definition): <p>The target definition for the stream destination.</p>
17    ///   - [`status_reason(Option<StatusReason>)`](crate::operation::get_stream::GetStreamOutput::status_reason): <p>Stream status reason with error code and timestamp (if applicable).</p>
18    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_stream::GetStreamOutput::tags): <p>A map of tags associated with the stream.</p>
19    /// - On failure, responds with [`SdkError<GetStreamError>`](crate::operation::get_stream::GetStreamError)
20    pub fn get_stream(&self) -> crate::operation::get_stream::builders::GetStreamFluentBuilder {
21        crate::operation::get_stream::builders::GetStreamFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_dsql/client/get_stream.rs

aws_sdk_dsql/client/
get_stream.rs
