aws_sdk_medialive/client/describe_node.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 [`DescribeNode`](crate::operation::describe_node::builders::DescribeNodeFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`cluster_id(impl Into<String>)`](crate::operation::describe_node::builders::DescribeNodeFluentBuilder::cluster_id) / [`set_cluster_id(Option<String>)`](crate::operation::describe_node::builders::DescribeNodeFluentBuilder::set_cluster_id):<br>required: **true**<br>The ID of the cluster<br>
7 /// - [`node_id(impl Into<String>)`](crate::operation::describe_node::builders::DescribeNodeFluentBuilder::node_id) / [`set_node_id(Option<String>)`](crate::operation::describe_node::builders::DescribeNodeFluentBuilder::set_node_id):<br>required: **true**<br>The ID of the node.<br>
8 /// - On success, responds with [`DescribeNodeOutput`](crate::operation::describe_node::DescribeNodeOutput) with field(s):
9 /// - [`arn(Option<String>)`](crate::operation::describe_node::DescribeNodeOutput::arn): The ARN of the Node. It is automatically assigned when the Node is created.
10 /// - [`channel_placement_groups(Option<Vec::<String>>)`](crate::operation::describe_node::DescribeNodeOutput::channel_placement_groups): An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
11 /// - [`cluster_id(Option<String>)`](crate::operation::describe_node::DescribeNodeOutput::cluster_id): The ID of the Cluster that the Node belongs to.
12 /// - [`connection_state(Option<NodeConnectionState>)`](crate::operation::describe_node::DescribeNodeOutput::connection_state): The current connection state of the Node.
13 /// - [`id(Option<String>)`](crate::operation::describe_node::DescribeNodeOutput::id): The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
14 /// - [`instance_arn(Option<String>)`](crate::operation::describe_node::DescribeNodeOutput::instance_arn): The ARN of the EC2 instance hosting the Node.
15 /// - [`name(Option<String>)`](crate::operation::describe_node::DescribeNodeOutput::name): The name that you specified for the Node.
16 /// - [`node_interface_mappings(Option<Vec::<NodeInterfaceMapping>>)`](crate::operation::describe_node::DescribeNodeOutput::node_interface_mappings): Documentation update needed
17 /// - [`role(Option<NodeRole>)`](crate::operation::describe_node::DescribeNodeOutput::role): The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
18 /// - [`state(Option<NodeState>)`](crate::operation::describe_node::DescribeNodeOutput::state): The current state of the Node.
19 /// - [`sdi_source_mappings(Option<Vec::<SdiSourceMapping>>)`](crate::operation::describe_node::DescribeNodeOutput::sdi_source_mappings): An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
20 /// - On failure, responds with [`SdkError<DescribeNodeError>`](crate::operation::describe_node::DescribeNodeError)
21 pub fn describe_node(&self) -> crate::operation::describe_node::builders::DescribeNodeFluentBuilder {
22 crate::operation::describe_node::builders::DescribeNodeFluentBuilder::new(self.handle.clone())
23 }
24}