aws_sdk_medialive/client/
describe_multiplex.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 [`DescribeMultiplex`](crate::operation::describe_multiplex::builders::DescribeMultiplexFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`multiplex_id(impl Into<String>)`](crate::operation::describe_multiplex::builders::DescribeMultiplexFluentBuilder::multiplex_id) / [`set_multiplex_id(Option<String>)`](crate::operation::describe_multiplex::builders::DescribeMultiplexFluentBuilder::set_multiplex_id):<br>required: **true**<br>The ID of the multiplex.<br>
7    /// - On success, responds with [`DescribeMultiplexOutput`](crate::operation::describe_multiplex::DescribeMultiplexOutput) with field(s):
8    ///   - [`arn(Option<String>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::arn): The unique arn of the multiplex.
9    ///   - [`availability_zones(Option<Vec::<String>>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::availability_zones): A list of availability zones for the multiplex.
10    ///   - [`destinations(Option<Vec::<MultiplexOutputDestination>>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::destinations): A list of the multiplex output destinations.
11    ///   - [`id(Option<String>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::id): The unique id of the multiplex.
12    ///   - [`multiplex_settings(Option<MultiplexSettings>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::multiplex_settings): Configuration for a multiplex event.
13    ///   - [`name(Option<String>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::name): The name of the multiplex.
14    ///   - [`pipelines_running_count(Option<i32>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::pipelines_running_count): The number of currently healthy pipelines.
15    ///   - [`program_count(Option<i32>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::program_count): The number of programs in the multiplex.
16    ///   - [`state(Option<MultiplexState>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::state): The current state of the multiplex.
17    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_multiplex::DescribeMultiplexOutput::tags): A collection of key-value pairs.
18    /// - On failure, responds with [`SdkError<DescribeMultiplexError>`](crate::operation::describe_multiplex::DescribeMultiplexError)
19    pub fn describe_multiplex(&self) -> crate::operation::describe_multiplex::builders::DescribeMultiplexFluentBuilder {
20        crate::operation::describe_multiplex::builders::DescribeMultiplexFluentBuilder::new(self.handle.clone())
21    }
22}