aws_sdk_iotanalytics/client/
sample_channel_data.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 [`SampleChannelData`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`channel_name(impl Into<String>)`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::set_channel_name):<br>required: **true**<br><p>The name of the channel whose message samples are retrieved.</p><br>
7    ///   - [`max_messages(i32)`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::max_messages) / [`set_max_messages(Option<i32>)`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::set_max_messages):<br>required: **false**<br><p>The number of sample messages to be retrieved. The limit is 10. The default is also 10.</p><br>
8    ///   - [`start_time(DateTime)`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::set_start_time):<br>required: **false**<br><p>The start of the time window from which sample messages are retrieved.</p><br>
9    ///   - [`end_time(DateTime)`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::set_end_time):<br>required: **false**<br><p>The end of the time window from which sample messages are retrieved.</p><br>
10    /// - On success, responds with [`SampleChannelDataOutput`](crate::operation::sample_channel_data::SampleChannelDataOutput) with field(s):
11    ///   - [`payloads(Option<Vec::<Blob>>)`](crate::operation::sample_channel_data::SampleChannelDataOutput::payloads): <p>The list of message samples. Each sample message is returned as a base64-encoded string.</p>
12    /// - On failure, responds with [`SdkError<SampleChannelDataError>`](crate::operation::sample_channel_data::SampleChannelDataError)
13    pub fn sample_channel_data(&self) -> crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder {
14        crate::operation::sample_channel_data::builders::SampleChannelDataFluentBuilder::new(self.handle.clone())
15    }
16}