AWS API Changes

2020/11/19 - AWS Elemental MediaLive - 3 updated api methods

Changes The AWS Elemental MediaLive APIs and SDKs now support the ability to see the software update status on Link devices

DescribeInputDevice (updated)

Link ¶
Changes (response)

{'DeviceUpdateStatus': 'UP_TO_DATE | NOT_UP_TO_DATE'}

Gets the details for the input device

See also: AWS API Documentation

Request Syntax

client.describe_input_device(
    InputDeviceId='string'
)

type InputDeviceId

string

param InputDeviceId

[REQUIRED] The unique ID of this input device. For example, hd-123456789abcdef.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'ConnectionState': 'DISCONNECTED'|'CONNECTED',
    'DeviceSettingsSyncState': 'SYNCED'|'SYNCING',
    'DeviceUpdateStatus': 'UP_TO_DATE'|'NOT_UP_TO_DATE',
    'HdDeviceSettings': {
        'ActiveInput': 'HDMI'|'SDI',
        'ConfiguredInput': 'AUTO'|'HDMI'|'SDI',
        'DeviceState': 'IDLE'|'STREAMING',
        'Framerate': 123.0,
        'Height': 123,
        'MaxBitrate': 123,
        'ScanType': 'INTERLACED'|'PROGRESSIVE',
        'Width': 123
    },
    'Id': 'string',
    'MacAddress': 'string',
    'Name': 'string',
    'NetworkSettings': {
        'DnsAddresses': [
            'string',
        ],
        'Gateway': 'string',
        'IpAddress': 'string',
        'IpScheme': 'STATIC'|'DHCP',
        'SubnetMask': 'string'
    },
    'SerialNumber': 'string',
    'Type': 'HD'
}

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.
- 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.

ListInputDevices (updated)

Link ¶
Changes (response)

{'InputDevices': {'DeviceUpdateStatus': 'UP_TO_DATE | NOT_UP_TO_DATE'}}

List input devices

See also: AWS API Documentation

Request Syntax

client.list_input_devices(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

Placeholder documentation for MaxResults

type NextToken

string

param NextToken

Placeholder documentation for __string

rtype

dict

returns

Response Syntax

{
    'InputDevices': [
        {
            'Arn': 'string',
            'ConnectionState': 'DISCONNECTED'|'CONNECTED',
            'DeviceSettingsSyncState': 'SYNCED'|'SYNCING',
            'DeviceUpdateStatus': 'UP_TO_DATE'|'NOT_UP_TO_DATE',
            'HdDeviceSettings': {
                'ActiveInput': 'HDMI'|'SDI',
                'ConfiguredInput': 'AUTO'|'HDMI'|'SDI',
                'DeviceState': 'IDLE'|'STREAMING',
                'Framerate': 123.0,
                'Height': 123,
                'MaxBitrate': 123,
                'ScanType': 'INTERLACED'|'PROGRESSIVE',
                'Width': 123
            },
            'Id': 'string',
            'MacAddress': 'string',
            'Name': 'string',
            'NetworkSettings': {
                'DnsAddresses': [
                    'string',
                ],
                'Gateway': 'string',
                'IpAddress': 'string',
                'IpScheme': 'STATIC'|'DHCP',
                'SubnetMask': 'string'
            },
            'SerialNumber': 'string',
            'Type': 'HD'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) -- An array of input devices.
- InputDevices (list) -- The list of input devices.
  - (dict) -- Details of 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.
    - 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) -- 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.
- NextToken (string) -- A token to get additional list results.

UpdateInputDevice (updated)

Link ¶
Changes (response)

{'DeviceUpdateStatus': 'UP_TO_DATE | NOT_UP_TO_DATE'}

Updates the parameters for the input device.

See also: AWS API Documentation

Request Syntax

client.update_input_device(
    HdDeviceSettings={
        'ConfiguredInput': 'AUTO'|'HDMI'|'SDI',
        'MaxBitrate': 123
    },
    InputDeviceId='string',
    Name='string'
)

type HdDeviceSettings

dict

param HdDeviceSettings

The settings that you want to apply to the input device.

ConfiguredInput (string) -- The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source.
MaxBitrate (integer) -- The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.

type InputDeviceId

string

param InputDeviceId

[REQUIRED] The unique ID of the input device. For example, hd-123456789abcdef.

type Name

string

param Name

The name that you assigned to this input device (not the unique ID).

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'ConnectionState': 'DISCONNECTED'|'CONNECTED',
    'DeviceSettingsSyncState': 'SYNCED'|'SYNCING',
    'DeviceUpdateStatus': 'UP_TO_DATE'|'NOT_UP_TO_DATE',
    'HdDeviceSettings': {
        'ActiveInput': 'HDMI'|'SDI',
        'ConfiguredInput': 'AUTO'|'HDMI'|'SDI',
        'DeviceState': 'IDLE'|'STREAMING',
        'Framerate': 123.0,
        'Height': 123,
        'MaxBitrate': 123,
        'ScanType': 'INTERLACED'|'PROGRESSIVE',
        'Width': 123
    },
    'Id': 'string',
    'MacAddress': 'string',
    'Name': 'string',
    'NetworkSettings': {
        'DnsAddresses': [
            'string',
        ],
        'Gateway': 'string',
        'IpAddress': 'string',
        'IpScheme': 'STATIC'|'DHCP',
        'SubnetMask': 'string'
    },
    'SerialNumber': 'string',
    'Type': 'HD'
}

Response Structure

(dict) -- Input device update is in progress.
- 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.
- 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.