input_devices

Creates, updates, deletes, gets or lists an input_devices resource.

Overview

Name	input_devices
Type	Resource
Id	aws.medialive.input_devices

Fields

The following fields are returned by SELECT queries:

describe_input_device

Name	Datatype	Description
arn	string	Placeholder documentation for __string
availability_zone	string	Placeholder documentation for __string
connection_state	string	The state of the connection between the input device and AWS. (DISCONNECTED, CONNECTED)
device_settings_sync_state	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. (SYNCED, SYNCING)
device_update_status	string	The status of software on the input device. (UP_TO_DATE, NOT_UP_TO_DATE, UPDATING)
hd_device_settings	object	Settings that describe an input device that is type HD.
id	string	Placeholder documentation for __string
mac_address	string	Placeholder documentation for __string
medialive_input_arns	array	Placeholder documentation for __listOf__string
name	string	Placeholder documentation for __string
network_settings	object	The network settings for the input device.
output_type	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. (NONE, MEDIALIVE_INPUT, MEDIACONNECT_FLOW)
serial_number	string	Placeholder documentation for __string
tags	object	A collection of key-value pairs.
type	string	The type of the input device. (HD, UHD)
uhd_device_settings	object	Settings that describe an input device that is type UHD.

list_input_devices

Name	Datatype	Description
arn	string	Placeholder documentation for __string
availability_zone	string	Placeholder documentation for __string
connection_state	string	The state of the connection between the input device and AWS. (DISCONNECTED, CONNECTED)
device_settings_sync_state	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. (SYNCED, SYNCING)
device_update_status	string	The status of software on the input device. (UP_TO_DATE, NOT_UP_TO_DATE, UPDATING)
hd_device_settings	object	Settings that describe an input device that is type HD.
id	string	Placeholder documentation for __string
mac_address	string	Placeholder documentation for __string
medialive_input_arns	array	Placeholder documentation for __listOf__string
name	string	Placeholder documentation for __string
network_settings	object	Network settings for the input device.
output_type	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. (NONE, MEDIALIVE_INPUT, MEDIACONNECT_FLOW)
serial_number	string	Placeholder documentation for __string
tags	object	A collection of key-value pairs.
type	string	The type of the input device. (HD, UHD)
uhd_device_settings	object	Settings that describe an input device that is type UHD.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_input_device	select	input_device_id, region		Gets the details for the input device
list_input_devices	select	region	maxResults, nextToken	List input devices
update_input_device	update	input_device_id, region		Updates the parameters for the input device.
accept_input_device_transfer	exec	input_device_id, region		Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account.
cancel_input_device_transfer	exec	input_device_id, region		Cancel an input device transfer that you have requested.
reject_input_device_transfer	exec	input_device_id, region		Reject the transfer of the specified input device to your AWS account.
start_input_device_maintenance_window	exec	input_device_id, region		Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.
transfer_input_device	exec	input_device_id, region		Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
input_device_id	string	The unique ID of this input device. For example, hd-123456789abcdef.
region	string	AWS region (default: us-east-1)
maxResults	integer
nextToken	string

SELECT examples

describe_input_device

Gets the details for the input device

SELECT
arn,
availability_zone,
connection_state,
device_settings_sync_state,
device_update_status,
hd_device_settings,
id,
mac_address,
medialive_input_arns,
name,
network_settings,
output_type,
serial_number,
tags,
type,
uhd_device_settings
FROM aws.medialive.input_devices
WHERE input_device_id = '{{ input_device_id }}' -- required
AND region = '{{ region }}' -- required
;

list_input_devices

List input devices

SELECT
arn,
availability_zone,
connection_state,
device_settings_sync_state,
device_update_status,
hd_device_settings,
id,
mac_address,
medialive_input_arns,
name,
network_settings,
output_type,
serial_number,
tags,
type,
uhd_device_settings
FROM aws.medialive.input_devices
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_input_device

Updates the parameters for the input device.

UPDATE aws.medialive.input_devices
SET 
HdDeviceSettings = '{{ HdDeviceSettings }}',
Name = '{{ Name }}',
UhdDeviceSettings = '{{ UhdDeviceSettings }}',
AvailabilityZone = '{{ AvailabilityZone }}'
WHERE 
input_device_id = '{{ input_device_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
availability_zone,
connection_state,
device_settings_sync_state,
device_update_status,
hd_device_settings,
id,
mac_address,
medialive_input_arns,
name,
network_settings,
output_type,
serial_number,
tags,
type,
uhd_device_settings;

Lifecycle Methods

accept_input_device_transfer

Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account.

EXEC aws.medialive.input_devices.accept_input_device_transfer 
@input_device_id='{{ input_device_id }}' --required, 
@region='{{ region }}' --required
;

cancel_input_device_transfer

Cancel an input device transfer that you have requested.

EXEC aws.medialive.input_devices.cancel_input_device_transfer 
@input_device_id='{{ input_device_id }}' --required, 
@region='{{ region }}' --required
;

reject_input_device_transfer

Reject the transfer of the specified input device to your AWS account.

EXEC aws.medialive.input_devices.reject_input_device_transfer 
@input_device_id='{{ input_device_id }}' --required, 
@region='{{ region }}' --required
;

start_input_device_maintenance_window

Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.

EXEC aws.medialive.input_devices.start_input_device_maintenance_window 
@input_device_id='{{ input_device_id }}' --required, 
@region='{{ region }}' --required
;

transfer_input_device

Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.

EXEC aws.medialive.input_devices.transfer_input_device 
@input_device_id='{{ input_device_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"TargetCustomerId": "{{ TargetCustomerId }}", 
"TargetRegion": "{{ TargetRegion }}", 
"TransferMessage": "{{ TransferMessage }}"
}'
;