URI HTTP methods Schemas Properties See also

Input devices: device ID

URI

/prod/inputDevices/inputDeviceId

HTTP methods

GET

Operation ID: DescribeInputDevice

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

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


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

Response bodies


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


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


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


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


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

SYNCED
SYNCING

DeviceUpdateStatus

The status of software on the input device.

UP_TO_DATE
NOT_UP_TO_DATE
UPDATING

GatewayTimeoutException

Property	Type	Required	Description
`message`	string	False

InputDevice

An input device.

Property	Type	Required	Description
`arn`	string	False	The unique ARN of the input device.
`availabilityZone`	string	False	The Availability Zone associated with this 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.
`deviceUpdateStatus`	DeviceUpdateStatus	False	The status of software on the input device.
`hdDeviceSettings`	InputDeviceHdSettings	False	Settings that describe an input device that is type HD.
`id`	string	False	The unique ID of the input device.
`macAddress`	string	False	The network MAC address of the input device.
`name`	string	False	A name that you specify for the input device.
`networkSettings`	InputDeviceNetworkSettings	False	The network settings for the input device.
`serialNumber`	string	False	The unique serial number of the input device.
`type`	InputDeviceType	False	The type of the input device.
`uhdDeviceSettings`	InputDeviceUhdSettings	False	Settings that describe an input device that is type UHD.

InputDeviceActiveInput

The source at the input device that is currently active.

HDMI
SDI

InputDeviceConfigurableSettings

Configurable settings for the input device.

Property	Type	Required	Description
`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.
`maxBitrate`	integer	False	The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.

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.

AUTO
HDMI
SDI

InputDeviceConnectionState

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

DISCONNECTED
CONNECTED

InputDeviceHdSettings

Settings that describe the active source from the input device, and the video characteristics of that source.

Property	Type	Required	Description
`activeInput`	InputDeviceActiveInput	False	If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).
`configuredInput`	InputDeviceConfiguredInput	False	The source at the input device that is currently active. You can specify this source.
`deviceState`	InputDeviceState	False	The state of the input device.
`framerate`	number	False	The frame rate of the video source.
`height`	integer	False	The height of the video source, in pixels.
`maxBitrate`	integer	False	The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.
`scanType`	InputDeviceScanType	False	The scan type of the video source.
`width`	integer	False	The width of the video source, in pixels.

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.

STATIC
DHCP

InputDeviceNetworkSettings

The network settings for the input device.

Property	Type	Required	Description
`dnsAddresses`	Array of type string	False	The DNS addresses of the input device.
`gateway`	string	False	The network gateway IP address.
`ipAddress`	string	False	The IP address of the input device.
`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.
`subnetMask`	string	False	The subnet mask of the input device.

InputDeviceScanType

The scan type of the video source.

INTERLACED
PROGRESSIVE

InputDeviceState

The state of the input device.

IDLE
STREAMING

InputDeviceType

The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose "HD".

HD
UHD

InputDeviceUhdSettings

Settings that describe the active source from the input device, and the video characteristics of that source.

Property	Type	Required	Description
`activeInput`	InputDeviceActiveInput	False	If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).
`configuredInput`	InputDeviceConfiguredInput	False	The source at the input device that is currently active. You can specify this source.
`deviceState`	InputDeviceState	False	The state of the input device.
`framerate`	number	False	The frame rate of the video source.
`height`	integer	False	The height of the video source, in pixels.
`maxBitrate`	integer	False	The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.
`scanType`	InputDeviceScanType	False	The scan type of the video source.
`width`	integer	False	The width of the video source, in pixels.

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

Updates an input device.

Property	Type	Required	Description
`availabilityZone`	string	False	The Availability Zone you want to associate with this input device.
`hdDeviceSettings`	InputDeviceConfigurableSettings	False	The settings that you want to apply to the HD input device.
`name`	string	False	The name that you assigned to this input device (not the unique ID).
`uhdDeviceSettings`	InputDeviceConfigurableSettings	False	The settings that you want to apply to the UHD input device.

ValidationError

Property	Type	Required	Description
`elementPath`	string	False	Path to the source of the error.
`errorMessage`	string	False	The error message.