AWS CLI Command Reference

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . medialive ]

describe-input-device

Description

Gets the details for the input device

See also: AWS API Documentation

Synopsis

  describe-input-device
--input-device-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--input-device-id (string) The unique ID of this input device. For example, hd-123456789abcdef.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Arn -> (string)

The unique ARN of the input device.

ConnectionState -> (string)

The state of the connection between the input device and AWS.

DeviceSettingsSyncState -> (string)

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.

DeviceUpdateStatus -> (string)

The status of software on the input device.

HdDeviceSettings -> (structure)

Settings that describe an input device that is type HD.

ActiveInput -> (string)

If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).

ConfiguredInput -> (string)

The source at the input device that is currently active. You can specify this source.

DeviceState -> (string)

The state of the input device.

Framerate -> (double)

The frame rate of the video source.

Height -> (integer)

The height of the video source, in pixels.

MaxBitrate -> (integer)

The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.

ScanType -> (string)

The scan type of the video source.

Width -> (integer)

The width of the video source, in pixels.

LatencyMs -> (integer)

The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.

Id -> (string)

The unique ID of the input device.

MacAddress -> (string)

The network MAC address of the input device.

Name -> (string)

A name that you specify for the input device.

NetworkSettings -> (structure)

The network settings for the input device.

DnsAddresses -> (list)

The DNS addresses of the input device.

(string)

Placeholder documentation for __string

Gateway -> (string)

The network gateway IP address.

IpAddress -> (string)

The IP address of the input device.

IpScheme -> (string)

Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address.

SubnetMask -> (string)

The subnet mask of the input device.

SerialNumber -> (string)

The unique serial number of the input device.

Type -> (string)

The type of the input device.

UhdDeviceSettings -> (structure)

Settings that describe an input device that is type UHD.

ActiveInput -> (string)

If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).

ConfiguredInput -> (string)

The source at the input device that is currently active. You can specify this source.

DeviceState -> (string)

The state of the input device.

Framerate -> (double)

The frame rate of the video source.

Height -> (integer)

The height of the video source, in pixels.

MaxBitrate -> (integer)

The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.

ScanType -> (string)

The scan type of the video source.

Width -> (integer)

The width of the video source, in pixels.

LatencyMs -> (integer)

The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.

Tags -> (map)

A collection of key-value pairs.

key -> (string)

Placeholder documentation for __string

value -> (string)

Placeholder documentation for __string