inputs

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

Overview

Name	inputs
Type	Resource
Id	aws.medialive.inputs

Fields

The following fields are returned by SELECT queries:

describe_input

Name	Datatype	Description
arn	string	Placeholder documentation for __string
attached_channels	array	Placeholder documentation for __listOf__string
destinations	array	A list of the destinations of the input (PUSH-type).
id	string	Placeholder documentation for __string
input_class	string	STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. (STANDARD, SINGLE_PIPELINE)
input_devices	array	Placeholder documentation for __listOfInputDeviceSettings
input_network_location	string	With the introduction of MediaLive Anywhere, a MediaLive input can now exist in two different places: AWS or inside an on-premises datacenter. By default all inputs will continue to be AWS inputs. (AWS, ON_PREMISES)
input_partner_ids	array	Placeholder documentation for __listOf__string
input_source_type	string	Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs. (STATIC, DYNAMIC)
media_connect_flows	array	A list of MediaConnect Flows for this input.
multicast_settings	object	Multicast Input settings.
name	string	Placeholder documentation for __string
role_arn	string	Placeholder documentation for __string
router_settings	object	Information about any MediaConnect router association with this input.
sdi_sources	array	SDI Sources for this Input.
security_groups	array	Placeholder documentation for __listOf__string
smpte_2110_receiver_group_settings	object	Configures the sources for the SMPTE 2110 Receiver Group input.
sources	array	A list of the sources of the input (PULL-type).
srt_settings	object	The settings associated with an SRT input.
state	string	Placeholder documentation for InputState (CREATING, DETACHED, ATTACHED, DELETING, DELETED)
tags	object	A collection of key-value pairs.
type	string	The different types of inputs that AWS Elemental MediaLive supports. (UDP_PUSH, RTP_PUSH, RTMP_PUSH, RTMP_PULL, URL_PULL, MP4_FILE, MEDIACONNECT, INPUT_DEVICE, AWS_CDI, TS_FILE, SRT_CALLER, MULTICAST, SMPTE_2110_RECEIVER_GROUP, SDI, MEDIACONNECT_ROUTER, SRT_LISTENER)

list_inputs

Name	Datatype	Description
arn	string	Placeholder documentation for __string
attached_channels	array	Placeholder documentation for __listOf__string
destinations	array	A list of the destinations of the input (PUSH-type).
id	string	Placeholder documentation for __string
input_class	string	STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. (STANDARD, SINGLE_PIPELINE)
input_devices	array	Placeholder documentation for __listOfInputDeviceSettings
input_network_location	string	With the introduction of MediaLive Anywhere, a MediaLive input can now exist in two different places: AWS or inside an on-premises datacenter. By default all inputs will continue to be AWS inputs. (AWS, ON_PREMISES)
input_partner_ids	array	Placeholder documentation for __listOf__string
input_source_type	string	Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs. (STATIC, DYNAMIC)
media_connect_flows	array	A list of MediaConnect Flows for this input.
multicast_settings	object	Multicast Input settings.
name	string	Placeholder documentation for __string
role_arn	string	Placeholder documentation for __string
router_settings	object	Information about any MediaConnect router association with this input.
sdi_sources	array	SDI Sources for this Input.
security_groups	array	Placeholder documentation for __listOf__string
smpte_2110_receiver_group_settings	object	Configures the sources for the SMPTE 2110 Receiver Group input.
sources	array	A list of the sources of the input (PULL-type).
srt_settings	object	The settings associated with an SRT input.
state	string	Placeholder documentation for InputState (CREATING, DETACHED, ATTACHED, DELETING, DELETED)
tags	object	A collection of key-value pairs.
type	string	The different types of inputs that AWS Elemental MediaLive supports. (UDP_PUSH, RTP_PUSH, RTMP_PUSH, RTMP_PULL, URL_PULL, MP4_FILE, MEDIACONNECT, INPUT_DEVICE, AWS_CDI, TS_FILE, SRT_CALLER, MULTICAST, SMPTE_2110_RECEIVER_GROUP, SDI, MEDIACONNECT_ROUTER, SRT_LISTENER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_input	select	input_id, region		Produces details about an input
list_inputs	select	region	maxResults, nextToken	Produces list of inputs that have been created
create_partner_input	insert	input_id, region		Create a partner input
create_input	insert	region		Create an input
update_input	update	input_id, region		Updates an input.
delete_input	delete	input_id, region		Deletes the input end point
reboot_input_device	exec	input_device_id, region		Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.
start_input_device	exec	input_device_id, region		Start an input device that is attached to a MediaConnect flow. (There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.)
stop_input_device	exec	input_device_id, region		Stop an input device that is attached to a MediaConnect flow. (There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.)

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 the input device to stop. For example, hd-123456789abcdef.
input_id	string	Unique ID of the input
region	string	AWS region (default: us-east-1)
maxResults	integer
nextToken	string

SELECT examples

describe_input

Produces details about an input

SELECT
arn,
attached_channels,
destinations,
id,
input_class,
input_devices,
input_network_location,
input_partner_ids,
input_source_type,
media_connect_flows,
multicast_settings,
name,
role_arn,
router_settings,
sdi_sources,
security_groups,
smpte_2110_receiver_group_settings,
sources,
srt_settings,
state,
tags,
type
FROM aws.medialive.inputs
WHERE input_id = '{{ input_id }}' -- required
AND region = '{{ region }}' -- required
;

list_inputs

Produces list of inputs that have been created

SELECT
arn,
attached_channels,
destinations,
id,
input_class,
input_devices,
input_network_location,
input_partner_ids,
input_source_type,
media_connect_flows,
multicast_settings,
name,
role_arn,
router_settings,
sdi_sources,
security_groups,
smpte_2110_receiver_group_settings,
sources,
srt_settings,
state,
tags,
type
FROM aws.medialive.inputs
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_partner_input

Create a partner input

INSERT INTO aws.medialive.inputs (
RequestId,
Tags,
input_id,
region
)
SELECT 
'{{ RequestId }}',
'{{ Tags }}',
'{{ input_id }}',
'{{ region }}'
RETURNING
input
;

create_input

Create an input

INSERT INTO aws.medialive.inputs (
Destinations,
InputDevices,
InputSecurityGroups,
MediaConnectFlows,
Name,
RequestId,
RoleArn,
Sources,
Tags,
Type,
Vpc,
SrtSettings,
InputNetworkLocation,
MulticastSettings,
Smpte2110ReceiverGroupSettings,
SdiSources,
RouterSettings,
region
)
SELECT 
'{{ Destinations }}',
'{{ InputDevices }}',
'{{ InputSecurityGroups }}',
'{{ MediaConnectFlows }}',
'{{ Name }}',
'{{ RequestId }}',
'{{ RoleArn }}',
'{{ Sources }}',
'{{ Tags }}',
'{{ Type }}',
'{{ Vpc }}',
'{{ SrtSettings }}',
'{{ InputNetworkLocation }}',
'{{ MulticastSettings }}',
'{{ Smpte2110ReceiverGroupSettings }}',
'{{ SdiSources }}',
'{{ RouterSettings }}',
'{{ region }}'
RETURNING
input
;

Manifest

# Description fields are for documentation purposes
- name: inputs
props:
  - name: input_id
    value: "{{ input_id }}"
    description: Required parameter for the inputs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the inputs resource.
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __string
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Placeholder documentation for Tags
  - name: Destinations
    description: |
      Placeholder documentation for __listOfInputDestinationRequest
    value:
      - StreamName: "{{ StreamName }}"
        Network: "{{ Network }}"
        NetworkRoutes: "{{ NetworkRoutes }}"
        StaticIpAddress: "{{ StaticIpAddress }}"
  - name: InputDevices
    description: |
      Placeholder documentation for __listOfInputDeviceSettings
    value:
      - Id: "{{ Id }}"
  - name: InputSecurityGroups
    value:
      - "{{ InputSecurityGroups }}"
    description: |
      Placeholder documentation for __listOf__string
  - name: MediaConnectFlows
    description: |
      Placeholder documentation for __listOfMediaConnectFlowRequest
    value:
      - FlowArn: "{{ FlowArn }}"
  - name: Name
    value: "{{ Name }}"
    description: |
      Placeholder documentation for __string
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      Placeholder documentation for __string
  - name: Sources
    description: |
      Placeholder documentation for __listOfInputSourceRequest
    value:
      - PasswordParam: "{{ PasswordParam }}"
        Url: "{{ Url }}"
        Username: "{{ Username }}"
  - name: Type
    value: "{{ Type }}"
    description: |
      The different types of inputs that AWS Elemental MediaLive supports.
    valid_values: ['UDP_PUSH', 'RTP_PUSH', 'RTMP_PUSH', 'RTMP_PULL', 'URL_PULL', 'MP4_FILE', 'MEDIACONNECT', 'INPUT_DEVICE', 'AWS_CDI', 'TS_FILE', 'SRT_CALLER', 'MULTICAST', 'SMPTE_2110_RECEIVER_GROUP', 'SDI', 'MEDIACONNECT_ROUTER', 'SRT_LISTENER']
  - name: Vpc
    description: |
      Settings for a private VPC Input. When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses. This property requires setting the roleArn property on Input creation. Not compatible with the inputSecurityGroups property.
    value:
      SecurityGroupIds:
        - "{{ SecurityGroupIds }}"
      SubnetIds:
        - "{{ SubnetIds }}"
  - name: SrtSettings
    description: |
      Configures the settings for SRT inputs. Provide either srtCallerSources (for SRT_CALLER type) OR srtListenerSettings (for SRT_LISTENER type), not both.
    value:
      SrtCallerSources:
        - Decryption:
            Algorithm: "{{ Algorithm }}"
            PassphraseSecretArn: "{{ PassphraseSecretArn }}"
          MinimumLatency: {{ MinimumLatency }}
          SrtListenerAddress: "{{ SrtListenerAddress }}"
          SrtListenerPort: "{{ SrtListenerPort }}"
          StreamId: "{{ StreamId }}"
      SrtListenerSettings:
        Decryption:
          Algorithm: "{{ Algorithm }}"
          PassphraseSecretArn: "{{ PassphraseSecretArn }}"
        MinimumLatency: {{ MinimumLatency }}
        StreamId: "{{ StreamId }}"
  - name: InputNetworkLocation
    value: "{{ InputNetworkLocation }}"
    description: |
      With the introduction of MediaLive Anywhere, a MediaLive input can now exist in two different places: AWS or inside an on-premises datacenter. By default all inputs will continue to be AWS inputs.
    valid_values: ['AWS', 'ON_PREMISES']
  - name: MulticastSettings
    description: |
      Settings for a Multicast input. Contains a list of multicast Urls and optional source ip addresses.
    value:
      Sources:
        - SourceIp: "{{ SourceIp }}"
          Url: "{{ Url }}"
  - name: Smpte2110ReceiverGroupSettings
    description: |
      Configures the sources for the SMPTE 2110 Receiver Group input.
    value:
      Smpte2110ReceiverGroups:
        - SdpSettings:
            AncillarySdps:
              - MediaIndex: {{ MediaIndex }}
                SdpUrl: "{{ SdpUrl }}"
            AudioSdps:
              - MediaIndex: {{ MediaIndex }}
                SdpUrl: "{{ SdpUrl }}"
            VideoSdp:
              MediaIndex: {{ MediaIndex }}
              SdpUrl: "{{ SdpUrl }}"
  - name: SdiSources
    value:
      - "{{ SdiSources }}"
    description: |
      SDI Sources for this Input.
  - name: RouterSettings
    description: |
      This is the collection of settings that are used during the creation of a MediaConnect router input.
    value:
      Destinations:
        - AvailabilityZoneName: "{{ AvailabilityZoneName }}"
      EncryptionType: "{{ EncryptionType }}"
      SecretArn: "{{ SecretArn }}"

UPDATE examples

update_input

Updates an input.

UPDATE aws.medialive.inputs
SET 
Destinations = '{{ Destinations }}',
InputDevices = '{{ InputDevices }}',
InputSecurityGroups = '{{ InputSecurityGroups }}',
MediaConnectFlows = '{{ MediaConnectFlows }}',
Name = '{{ Name }}',
RoleArn = '{{ RoleArn }}',
Sources = '{{ Sources }}',
SrtSettings = '{{ SrtSettings }}',
MulticastSettings = '{{ MulticastSettings }}',
Smpte2110ReceiverGroupSettings = '{{ Smpte2110ReceiverGroupSettings }}',
SdiSources = '{{ SdiSources }}',
SpecialRouterSettings = '{{ SpecialRouterSettings }}'
WHERE 
input_id = '{{ input_id }}' --required
AND region = '{{ region }}' --required
RETURNING
input;

DELETE examples

delete_input

Deletes the input end point

DELETE FROM aws.medialive.inputs
WHERE input_id = '{{ input_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

reboot_input_device

Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.

EXEC aws.medialive.inputs.reboot_input_device 
@input_device_id='{{ input_device_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Force": "{{ Force }}"
}'
;

start_input_device

Start an input device that is attached to a MediaConnect flow. (There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.)

EXEC aws.medialive.inputs.start_input_device 
@input_device_id='{{ input_device_id }}' --required, 
@region='{{ region }}' --required
;

stop_input_device

Stop an input device that is attached to a MediaConnect flow. (There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.)

EXEC aws.medialive.inputs.stop_input_device 
@input_device_id='{{ input_device_id }}' --required, 
@region='{{ region }}' --required
;