aws_sdk_mediapackagev2/client/

get_channel.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetChannel`](crate::operation::get_channel::builders::GetChannelFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`channel_group_name(impl Into<String>)`](crate::operation::get_channel::builders::GetChannelFluentBuilder::channel_group_name) / [`set_channel_group_name(Option<String>)`](crate::operation::get_channel::builders::GetChannelFluentBuilder::set_channel_group_name):<br>required: **true**<br><p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p><br>
    ///   - [`channel_name(impl Into<String>)`](crate::operation::get_channel::builders::GetChannelFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::get_channel::builders::GetChannelFluentBuilder::set_channel_name):<br>required: **true**<br><p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p><br>
    /// - On success, responds with [`GetChannelOutput`](crate::operation::get_channel::GetChannelOutput) with field(s):
    ///   - [`arn(String)`](crate::operation::get_channel::GetChannelOutput::arn): <p>The Amazon Resource Name (ARN) associated with the resource.</p>
    ///   - [`channel_name(String)`](crate::operation::get_channel::GetChannelOutput::channel_name): <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
    ///   - [`channel_group_name(String)`](crate::operation::get_channel::GetChannelOutput::channel_group_name): <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
    ///   - [`created_at(DateTime)`](crate::operation::get_channel::GetChannelOutput::created_at): <p>The date and time the channel was created.</p>
    ///   - [`modified_at(DateTime)`](crate::operation::get_channel::GetChannelOutput::modified_at): <p>The date and time the channel was modified.</p>
    ///   - [`reset_at(Option<DateTime>)`](crate::operation::get_channel::GetChannelOutput::reset_at): <p>The time that the channel was last reset.</p>
    ///   - [`description(Option<String>)`](crate::operation::get_channel::GetChannelOutput::description): <p>The description for your channel.</p>
    ///   - [`ingest_endpoints(Option<Vec::<IngestEndpoint>>)`](crate::operation::get_channel::GetChannelOutput::ingest_endpoints): <p>The list of ingest endpoints.</p>
    ///   - [`input_type(Option<InputType>)`](crate::operation::get_channel::GetChannelOutput::input_type): <p>The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.</p> <p>The allowed values are:</p> <ul>  <li>   <p><code>HLS</code> - The HLS streaming specification (which defines M3U8 manifests and TS segments).</p></li>  <li>   <p><code>CMAF</code> - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).</p></li> </ul>
    ///   - [`e_tag(Option<String>)`](crate::operation::get_channel::GetChannelOutput::e_tag): <p>The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_channel::GetChannelOutput::tags): <p>The comma-separated list of tag key:value pairs assigned to the channel.</p>
    ///   - [`input_switch_configuration(Option<InputSwitchConfiguration>)`](crate::operation::get_channel::GetChannelOutput::input_switch_configuration): <p>The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
    ///   - [`output_header_configuration(Option<OutputHeaderConfiguration>)`](crate::operation::get_channel::GetChannelOutput::output_header_configuration): <p>The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
    /// - On failure, responds with [`SdkError<GetChannelError>`](crate::operation::get_channel::GetChannelError)
    pub fn get_channel(&self) -> crate::operation::get_channel::builders::GetChannelFluentBuilder {
        crate::operation::get_channel::builders::GetChannelFluentBuilder::new(self.handle.clone())
    }
}