aws_sdk_medialive/client/
describe_channel_placement_group.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 [`DescribeChannelPlacementGroup`](crate::operation::describe_channel_placement_group::builders::DescribeChannelPlacementGroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`channel_placement_group_id(impl Into<String>)`](crate::operation::describe_channel_placement_group::builders::DescribeChannelPlacementGroupFluentBuilder::channel_placement_group_id) / [`set_channel_placement_group_id(Option<String>)`](crate::operation::describe_channel_placement_group::builders::DescribeChannelPlacementGroupFluentBuilder::set_channel_placement_group_id):<br>required: **true**<br>The ID of the channel placement group.<br>
7    ///   - [`cluster_id(impl Into<String>)`](crate::operation::describe_channel_placement_group::builders::DescribeChannelPlacementGroupFluentBuilder::cluster_id) / [`set_cluster_id(Option<String>)`](crate::operation::describe_channel_placement_group::builders::DescribeChannelPlacementGroupFluentBuilder::set_cluster_id):<br>required: **true**<br>The ID of the cluster.<br>
8    /// - On success, responds with [`DescribeChannelPlacementGroupOutput`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupOutput) with field(s):
9    ///   - [`arn(Option<String>)`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupOutput::arn): The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.
10    ///   - [`channels(Option<Vec::<String>>)`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupOutput::channels): Used in ListChannelPlacementGroupsResult
11    ///   - [`cluster_id(Option<String>)`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupOutput::cluster_id): The ID of the Cluster that the Node belongs to.
12    ///   - [`id(Option<String>)`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupOutput::id): The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.
13    ///   - [`name(Option<String>)`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupOutput::name): The name that you specified for the ChannelPlacementGroup.
14    ///   - [`nodes(Option<Vec::<String>>)`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupOutput::nodes): An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.
15    ///   - [`state(Option<ChannelPlacementGroupState>)`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupOutput::state): The current state of the ChannelPlacementGroup.
16    /// - On failure, responds with [`SdkError<DescribeChannelPlacementGroupError>`](crate::operation::describe_channel_placement_group::DescribeChannelPlacementGroupError)
17    pub fn describe_channel_placement_group(
18        &self,
19    ) -> crate::operation::describe_channel_placement_group::builders::DescribeChannelPlacementGroupFluentBuilder {
20        crate::operation::describe_channel_placement_group::builders::DescribeChannelPlacementGroupFluentBuilder::new(self.handle.clone())
21    }
22}