aws_sdk_mediatailor/client/describe_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 [`DescribeChannel`](crate::operation::describe_channel::builders::DescribeChannelFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`channel_name(impl Into<String>)`](crate::operation::describe_channel::builders::DescribeChannelFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::describe_channel::builders::DescribeChannelFluentBuilder::set_channel_name):<br>required: **true**<br><p>The name of the channel.</p><br>
7 /// - On success, responds with [`DescribeChannelOutput`](crate::operation::describe_channel::DescribeChannelOutput) with field(s):
8 /// - [`arn(Option<String>)`](crate::operation::describe_channel::DescribeChannelOutput::arn): <p>The ARN of the channel.</p>
9 /// - [`channel_name(Option<String>)`](crate::operation::describe_channel::DescribeChannelOutput::channel_name): <p>The name of the channel.</p>
10 /// - [`channel_state(Option<ChannelState>)`](crate::operation::describe_channel::DescribeChannelOutput::channel_state): <p>Indicates whether the channel is in a running state or not.</p>
11 /// - [`creation_time(Option<DateTime>)`](crate::operation::describe_channel::DescribeChannelOutput::creation_time): <p>The timestamp of when the channel was created.</p>
12 /// - [`filler_slate(Option<SlateSource>)`](crate::operation::describe_channel::DescribeChannelOutput::filler_slate): <p>Contains information about the slate used to fill gaps between programs in the schedule.</p>
13 /// - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_channel::DescribeChannelOutput::last_modified_time): <p>The timestamp of when the channel was last modified.</p>
14 /// - [`outputs(Option<Vec::<ResponseOutputItem>>)`](crate::operation::describe_channel::DescribeChannelOutput::outputs): <p>The channel's output properties.</p>
15 /// - [`playback_mode(Option<String>)`](crate::operation::describe_channel::DescribeChannelOutput::playback_mode): <p>The channel's playback mode.</p>
16 /// - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_channel::DescribeChannelOutput::tags): <p>The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
17 /// - [`tier(Option<String>)`](crate::operation::describe_channel::DescribeChannelOutput::tier): <p>The channel's tier.</p>
18 /// - [`log_configuration(Option<LogConfigurationForChannel>)`](crate::operation::describe_channel::DescribeChannelOutput::log_configuration): <p>The log configuration for the channel.</p>
19 /// - [`time_shift_configuration(Option<TimeShiftConfiguration>)`](crate::operation::describe_channel::DescribeChannelOutput::time_shift_configuration): <p>The time-shifted viewing configuration for the channel.</p>
20 /// - [`audiences(Option<Vec::<String>>)`](crate::operation::describe_channel::DescribeChannelOutput::audiences): <p>The list of audiences defined in channel.</p>
21 /// - On failure, responds with [`SdkError<DescribeChannelError>`](crate::operation::describe_channel::DescribeChannelError)
22 pub fn describe_channel(&self) -> crate::operation::describe_channel::builders::DescribeChannelFluentBuilder {
23 crate::operation::describe_channel::builders::DescribeChannelFluentBuilder::new(self.handle.clone())
24 }
25}