aws_sdk_iotanalytics/client/
create_channel.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 [`CreateChannel`](crate::operation::create_channel::builders::CreateChannelFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`channel_name(impl Into<String>)`](crate::operation::create_channel::builders::CreateChannelFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::create_channel::builders::CreateChannelFluentBuilder::set_channel_name):<br>required: **true**<br><p>The name of the channel.</p><br>
7    ///   - [`channel_storage(ChannelStorage)`](crate::operation::create_channel::builders::CreateChannelFluentBuilder::channel_storage) / [`set_channel_storage(Option<ChannelStorage>)`](crate::operation::create_channel::builders::CreateChannelFluentBuilder::set_channel_storage):<br>required: **false**<br><p>Where channel data is stored. You can choose one of <code>serviceManagedS3</code> or <code>customerManagedS3</code> storage. If not specified, the default is <code>serviceManagedS3</code>. You can't change this storage option after the channel is created.</p><br>
8    ///   - [`retention_period(RetentionPeriod)`](crate::operation::create_channel::builders::CreateChannelFluentBuilder::retention_period) / [`set_retention_period(Option<RetentionPeriod>)`](crate::operation::create_channel::builders::CreateChannelFluentBuilder::set_retention_period):<br>required: **false**<br><p>How long, in days, message data is kept for the channel. When <code>customerManagedS3</code> storage is selected, this parameter is ignored.</p><br>
9    ///   - [`tags(Tag)`](crate::operation::create_channel::builders::CreateChannelFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_channel::builders::CreateChannelFluentBuilder::set_tags):<br>required: **false**<br><p>Metadata which can be used to manage the channel.</p><br>
10    /// - On success, responds with [`CreateChannelOutput`](crate::operation::create_channel::CreateChannelOutput) with field(s):
11    ///   - [`channel_name(Option<String>)`](crate::operation::create_channel::CreateChannelOutput::channel_name): <p>The name of the channel.</p>
12    ///   - [`channel_arn(Option<String>)`](crate::operation::create_channel::CreateChannelOutput::channel_arn): <p>The ARN of the channel.</p>
13    ///   - [`retention_period(Option<RetentionPeriod>)`](crate::operation::create_channel::CreateChannelOutput::retention_period): <p>How long, in days, message data is kept for the channel.</p>
14    /// - On failure, responds with [`SdkError<CreateChannelError>`](crate::operation::create_channel::CreateChannelError)
15    pub fn create_channel(&self) -> crate::operation::create_channel::builders::CreateChannelFluentBuilder {
16        crate::operation::create_channel::builders::CreateChannelFluentBuilder::new(self.handle.clone())
17    }
18}