Struct aws_sdk_iotanalytics::types::Channel

#[non_exhaustive]
pub struct Channel {
    pub name: Option<String>,
    pub storage: Option<ChannelStorage>,
    pub arn: Option<String>,
    pub status: Option<ChannelStatus>,
    pub retention_period: Option<RetentionPeriod>,
    pub creation_time: Option<DateTime>,
    pub last_update_time: Option<DateTime>,
    pub last_message_arrival_time: Option<DateTime>,
}

A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the channel.

storage: Option<ChannelStorage>

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

arn: Option<String>

The ARN of the channel.

status: Option<ChannelStatus>

The status of the channel.

retention_period: Option<RetentionPeriod>

How long, in days, message data is kept for the channel.

creation_time: Option<DateTime>

When the channel was created.

last_update_time: Option<DateTime>

When the channel was last updated.

last_message_arrival_time: Option<DateTime>

The last time when a new message arrived in the channel.

IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation.

This feature only applies to messages that arrived in the data store after October 23, 2020.

Implementations

impl Channel

pub fn name(&self) -> Option<&str>

The name of the channel.

pub fn storage(&self) -> Option<&ChannelStorage>

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

pub fn arn(&self) -> Option<&str>

The ARN of the channel.

pub fn status(&self) -> Option<&ChannelStatus>

The status of the channel.

pub fn retention_period(&self) -> Option<&RetentionPeriod>

How long, in days, message data is kept for the channel.

pub fn creation_time(&self) -> Option<&DateTime>

When the channel was created.

pub fn last_update_time(&self) -> Option<&DateTime>

When the channel was last updated.

pub fn last_message_arrival_time(&self) -> Option<&DateTime>

The last time when a new message arrived in the channel.

IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation.

This feature only applies to messages that arrived in the data store after October 23, 2020.

impl Channel

pub fn builder() -> ChannelBuilder

Creates a new builder-style object to manufacture Channel.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl PartialEq for Channel

fn eq(&self, other: &Channel) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Channel