MediaLive / Client / describe_input_device

describe_input_device#

MediaLive.Client.describe_input_device(**kwargs)#

Gets the details for the input device

Request Syntax

response = client.describe_input_device(
    InputDeviceId='string'
)

Parameters:

InputDeviceId (string) – [REQUIRED] The unique ID of this input device. For example, hd-123456789abcdef.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'ConnectionState': 'DISCONNECTED'|'CONNECTED',
    'DeviceSettingsSyncState': 'SYNCED'|'SYNCING',
    'DeviceUpdateStatus': 'UP_TO_DATE'|'NOT_UP_TO_DATE'|'UPDATING',
    'HdDeviceSettings': {
        'ActiveInput': 'HDMI'|'SDI',
        'ConfiguredInput': 'AUTO'|'HDMI'|'SDI',
        'DeviceState': 'IDLE'|'STREAMING',
        'Framerate': 123.0,
        'Height': 123,
        'MaxBitrate': 123,
        'ScanType': 'INTERLACED'|'PROGRESSIVE',
        'Width': 123,
        'LatencyMs': 123
    },
    'Id': 'string',
    'MacAddress': 'string',
    'Name': 'string',
    'NetworkSettings': {
        'DnsAddresses': [
            'string',
        ],
        'Gateway': 'string',
        'IpAddress': 'string',
        'IpScheme': 'STATIC'|'DHCP',
        'SubnetMask': 'string'
    },
    'SerialNumber': 'string',
    'Type': 'HD'|'UHD',
    'UhdDeviceSettings': {
        'ActiveInput': 'HDMI'|'SDI',
        'ConfiguredInput': 'AUTO'|'HDMI'|'SDI',
        'DeviceState': 'IDLE'|'STREAMING',
        'Framerate': 123.0,
        'Height': 123,
        'MaxBitrate': 123,
        'ScanType': 'INTERLACED'|'PROGRESSIVE',
        'Width': 123,
        'LatencyMs': 123,
        'Codec': 'HEVC'|'AVC',
        'MediaconnectSettings': {
            'FlowArn': 'string',
            'RoleArn': 'string',
            'SecretArn': 'string',
            'SourceName': 'string'
        }
    },
    'Tags': {
        'string': 'string'
    },
    'AvailabilityZone': 'string',
    'MedialiveInputArns': [
        'string',
    ],
    'OutputType': 'NONE'|'MEDIALIVE_INPUT'|'MEDIACONNECT_FLOW'
}

Response Structure

(dict) – Details for the input device.
- 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 (dict) – 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 (float) – 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 (dict) – 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 (dict) – 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 (float) – 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.
  - Codec (string) – The codec for the video that the device produces.
  - MediaconnectSettings (dict) – Information about the MediaConnect flow attached to the device. Returned only if the outputType is MEDIACONNECT_FLOW.
    - FlowArn (string) – The ARN of the MediaConnect flow.
    - RoleArn (string) – The ARN for the role that MediaLive assumes to access the attached flow and secret.
    - SecretArn (string) – The ARN of the secret used to encrypt the stream.
    - SourceName (string) – The name of the MediaConnect flow source.
- Tags (dict) – A collection of key-value pairs.
  - (string) – Placeholder documentation for __string
    - (string) – Placeholder documentation for __string
- AvailabilityZone (string) – The Availability Zone associated with this input device.
- MedialiveInputArns (list) – An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.
  - (string) – Placeholder documentation for __string
- OutputType (string) – 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.

Exceptions

MediaLive.Client.exceptions.BadRequestException
MediaLive.Client.exceptions.InternalServerErrorException
MediaLive.Client.exceptions.ForbiddenException
MediaLive.Client.exceptions.BadGatewayException
MediaLive.Client.exceptions.NotFoundException
MediaLive.Client.exceptions.GatewayTimeoutException
MediaLive.Client.exceptions.TooManyRequestsException