InputDevices inputDeviceId - AWS Elemental MediaLive API Reference

InputDevices inputDeviceId

URI

/prod/inputDevices/inputDeviceId

HTTP Methods

GET

Operation ID: DescribeInputDevice

Get the details for one input device.

Path Parameters
Name Type Required Description
inputDeviceId String True
Responses
Status Code Response Model Description
200 InputDevice

200 response.

400 InvalidRequest

400 response.

403 AccessDenied

403 response.

404 ResourceNotFound

404 response.

429 LimitExceeded

429 response.

500 InternalServiceError

500 response.

502 BadGatewayException

502 response.

504 GatewayTimeoutException

504 response.

PUT

Operation ID: UpdateInputDevice

Change the properites of one input device.

Path Parameters
Name Type Required Description
inputDeviceId String True
Responses
Status Code Response Model Description
200 InputDevice

200 response.

400 InvalidRequest

400 response.

403 AccessDenied

403 response.

404 ResourceNotFound

404 response.

422 InputDeviceConfigurationValidationError

422 response.

429 LimitExceeded

429 response.

500 InternalServiceError

500 response.

502 BadGatewayException

502 response.

504 GatewayTimeoutException

504 response.

Schemas

Request Bodies

Example PUT

{ "name": "string", "hdDeviceSettings": { "maxBitrate": integer, "configuredInput": enum } }

Response Bodies

Example InputDevice

{ "id": "string", "arn": "string", "name": "string", "serialNumber": "string", "macAddress": "string", "type": enum, "connectionState": enum, "deviceSettingsSyncState": enum, "hdDeviceSettings": { "maxBitrate": integer, "configuredInput": enum, "activeInput": enum, "deviceState": enum, "width": integer, "height": integer, "scanType": enum, "framerate": number }, "networkSettings": { "ipAddress": "string", "subnetMask": "string", "dnsAddresses": [ "string" ], "gateway": "string", "ipScheme": enum } }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example InputDeviceConfigurationValidationError

{ "message": "string", "validationErrors": [ { "errorMessage": "string", "elementPath": "string" } ] }

Example LimitExceeded

{ "message": "string" }

Example InternalServiceError

{ "message": "string" }

Example BadGatewayException

{ "message": "string" }

Example GatewayTimeoutException

{ "message": "string" }

Properties

AccessDenied

Property Type Required Description
message

string

False

BadGatewayException

Property Type Required Description
message

string

False

DeviceSettingsSyncState

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. This element belongs to InputDevice.

  • SYNCED

  • SYNCING

GatewayTimeoutException

Property Type Required Description
message

string

False

InputDevice

This element is the response for some input device operations.

Property Type Required Description
id

string

False

The unique ID of the input device.

arn

string

False

The unique ARN of the input device.

name

string

False

A name that you specify for the input device.

serialNumber

string

False

The unique serial number of the input device.

macAddress

string

False

The network MAC address of the input device.

type

InputDeviceType

False

The type of the input device.

connectionState

InputDeviceConnectionState

False

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

deviceSettingsSyncState

DeviceSettingsSyncState

False

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.

hdDeviceSettings

InputDeviceHdSettings

False

Settings that describe an input device that is type HD.

networkSettings

InputDeviceNetworkSettings

False

The network settings for the input device.

InputDeviceActiveInput

The source at the input device that is currently active. This element belongs to InputDeviceHdSettings.

  • HDMI

  • SDI

InputDeviceConfigurableSettings

Configurable settings for the input device.

Property Type Required Description
maxBitrate

integer

False

The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.

configuredInput

InputDeviceConfiguredInput

False

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.

InputDeviceConfigurationValidationError

Property Type Required Description
message

string

False

The error message.

validationErrors

Array of type ValidationError

False

A collection of validation error responses.

InputDeviceConfiguredInput

The source to activate (use) from the input device. This element belongs to InputDeviceHdSettings and InputDeviceConfigurableSettings.

  • AUTO

  • HDMI

  • SDI

InputDeviceConnectionState

The state of the connection between the input device and AWS. This element belongs to InputDevice.

  • DISCONNECTED

  • CONNECTED

InputDeviceHdSettings

Settings that describe the active source from an HD input device, and the video characteristics of that source. You can change some of these settings. This element belongs to InputDevice, which is in the response for some operations. It is also a parameter in a request to change the parameters of an input device.

Property Type Required Description
maxBitrate

integer

False

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

configuredInput

InputDeviceConfiguredInput

False

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

activeInput

InputDeviceActiveInput

False

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

deviceState

InputDeviceState

False

The state of the input device.

width

integer

False

The width of the video source, in pixels.

height

integer

False

The height of the video source, in pixels.

scanType

InputDeviceScanType

False

The scan type of the video source.

framerate

number

False

The frame rate of the video source.

InputDeviceIpScheme

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

  • STATIC

  • DHCP

InputDeviceNetworkSettings

The network settings for the input device. This element belongs to InputDevice and InputDeviceSummary.

Property Type Required Description
ipAddress

string

False

The IP address of the input device.

subnetMask

string

False

The subnet mask of the input device.

dnsAddresses

Array of type string

False

The DNS addresses of the input device.

gateway

string

False

The network gateway IP address.

ipScheme

InputDeviceIpScheme

False

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

InputDeviceScanType

The scan type of the video source. This element belongs to InputDeviceHdSettings.

  • INTERLACED

  • PROGRESSIVE

InputDeviceState

The state of the input device.

  • IDLE

  • STREAMING

InputDeviceType

The type of the input device. This element belongs to InputDevice.

  • HD

InternalServiceError

Property Type Required Description
message

string

False

InvalidRequest

Property Type Required Description
message

string

False

LimitExceeded

Property Type Required Description
message

string

False

ResourceNotFound

Property Type Required Description
message

string

False

UpdateInputDevice

The top container for a request to change the configuration of an input device.

Property Type Required Description
name

string

False

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

hdDeviceSettings

InputDeviceConfigurableSettings

False

Include this element if you want to change the user-configurable fields of an HD input device.

ValidationError

Property Type Required Description
errorMessage

string

False

The error message.

elementPath

string

False

Path to the source of the error.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeInputDevice

UpdateInputDevice