Struct aws_sdk_iotanalytics::client::fluent_builders::SampleChannelData

pub struct SampleChannelData { /* private fields */ }

Fluent builder constructing a request to SampleChannelData.

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

Implementations

impl SampleChannelData

pub async fn customize(
    self
) -> Result<CustomizableOperation<SampleChannelData, AwsResponseRetryClassifier>, SdkError<SampleChannelDataError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<SampleChannelDataOutput, SdkError<SampleChannelDataError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn channel_name(self, input: impl Into<String>) -> Self

The name of the channel whose message samples are retrieved.

pub fn set_channel_name(self, input: Option<String>) -> Self

The name of the channel whose message samples are retrieved.

pub fn max_messages(self, input: i32) -> Self

The number of sample messages to be retrieved. The limit is 10. The default is also 10.

pub fn set_max_messages(self, input: Option<i32>) -> Self

The number of sample messages to be retrieved. The limit is 10. The default is also 10.

pub fn start_time(self, input: DateTime) -> Self

The start of the time window from which sample messages are retrieved.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The start of the time window from which sample messages are retrieved.

pub fn end_time(self, input: DateTime) -> Self

The end of the time window from which sample messages are retrieved.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The end of the time window from which sample messages are retrieved.

Trait Implementations

impl Clone for SampleChannelData

fn clone(&self) -> SampleChannelData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SampleChannelData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.