aws_sdk_medialive/client/describe_input_device.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 [`DescribeInputDevice`](crate::operation::describe_input_device::builders::DescribeInputDeviceFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`input_device_id(impl Into<String>)`](crate::operation::describe_input_device::builders::DescribeInputDeviceFluentBuilder::input_device_id) / [`set_input_device_id(Option<String>)`](crate::operation::describe_input_device::builders::DescribeInputDeviceFluentBuilder::set_input_device_id):<br>required: **true**<br>The unique ID of this input device. For example, hd-123456789abcdef.<br>
7 /// - On success, responds with [`DescribeInputDeviceOutput`](crate::operation::describe_input_device::DescribeInputDeviceOutput) with field(s):
8 /// - [`arn(Option<String>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::arn): The unique ARN of the input device.
9 /// - [`connection_state(Option<InputDeviceConnectionState>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::connection_state): The state of the connection between the input device and AWS.
10 /// - [`device_settings_sync_state(Option<DeviceSettingsSyncState>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::device_settings_sync_state): The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.
11 /// - [`device_update_status(Option<DeviceUpdateStatus>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::device_update_status): The status of software on the input device.
12 /// - [`hd_device_settings(Option<InputDeviceHdSettings>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::hd_device_settings): Settings that describe an input device that is type HD.
13 /// - [`id(Option<String>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::id): The unique ID of the input device.
14 /// - [`mac_address(Option<String>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::mac_address): The network MAC address of the input device.
15 /// - [`name(Option<String>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::name): A name that you specify for the input device.
16 /// - [`network_settings(Option<InputDeviceNetworkSettings>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::network_settings): The network settings for the input device.
17 /// - [`serial_number(Option<String>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::serial_number): The unique serial number of the input device.
18 /// - [`r#type(Option<InputDeviceType>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::type): The type of the input device.
19 /// - [`uhd_device_settings(Option<InputDeviceUhdSettings>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::uhd_device_settings): Settings that describe an input device that is type UHD.
20 /// - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::tags): A collection of key-value pairs.
21 /// - [`availability_zone(Option<String>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::availability_zone): The Availability Zone associated with this input device.
22 /// - [`medialive_input_arns(Option<Vec::<String>>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::medialive_input_arns): An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.
23 /// - [`output_type(Option<InputDeviceOutputType>)`](crate::operation::describe_input_device::DescribeInputDeviceOutput::output_type): The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.
24 /// - On failure, responds with [`SdkError<DescribeInputDeviceError>`](crate::operation::describe_input_device::DescribeInputDeviceError)
25 pub fn describe_input_device(&self) -> crate::operation::describe_input_device::builders::DescribeInputDeviceFluentBuilder {
26 crate::operation::describe_input_device::builders::DescribeInputDeviceFluentBuilder::new(self.handle.clone())
27 }
28}