Inputs - AWS Elemental MediaLive API Reference

Inputs

URI

/prod/inputs

HTTP Methods

GET

Operation ID: ListInputs

List all the existing inputs.

Query Parameters
Name Type Required Description
nextToken String False

Get the next token.

maxResults String False

Set the maximum number of results to include in one response.

Responses
Status Code Response Model Description
200 ListInputsResultModel

200 response.

400 InvalidRequest

400 response.

403 AccessDenied

403 response.

429 LimitExceeded

429 response.

500 InternalServiceError

500 response.

502 BadGatewayException

502 response.

504 GatewayTimeoutException

504 response.

POST

Operation ID: CreateInput

Create one input.

Responses
Status Code Response Model Description
201 CreateInputResultModel

201 response.

400 InvalidRequest

400 response.

403 AccessDenied

403 response.

429 LimitExceeded

429 response.

500 InternalServiceError

500 response.

502 BadGatewayException

502 response.

504 GatewayTimeoutException

504 response.

Schemas

Request Bodies

Example POST

{ "requestId": "string", "name": "string", "sources": [ { "url": "string", "username": "string", "passwordParam": "string" } ], "destinations": [ { "streamName": "string" } ], "type": enum, "inputSecurityGroups": [ "string" ], "mediaConnectFlows": [ { "flowArn": "string" } ], "inputDevices": [ { "id": "string" } ], "roleArn": "string", "tags": { }, "vpc": { "subnetIds": [ "string" ], "securityGroupIds": [ "string" ] } }

Response Bodies

Example ListInputsResultModel

{ "inputs": [ { "arn": "string", "id": "string", "name": "string", "type": enum, "sources": [ { "url": "string", "username": "string", "passwordParam": "string" } ], "inputSourceType": enum, "destinations": [ { "url": "string", "ip": "string", "port": "string", "vpc": { "availabilityZone": "string", "networkInterfaceId": "string" } } ], "mediaConnectFlows": [ { "flowArn": "string" } ], "inputDevices": [ { "id": "string" } ], "state": enum, "attachedChannels": [ "string" ], "securityGroups": [ "string" ], "roleArn": "string", "tags": { }, "inputClass": enum } ], "nextToken": "string" }

Example CreateInputResultModel

{ "input": { "arn": "string", "id": "string", "name": "string", "type": enum, "sources": [ { "url": "string", "username": "string", "passwordParam": "string" } ], "inputSourceType": enum, "destinations": [ { "url": "string", "ip": "string", "port": "string", "vpc": { "availabilityZone": "string", "networkInterfaceId": "string" } } ], "mediaConnectFlows": [ { "flowArn": "string" } ], "inputDevices": [ { "id": "string" } ], "state": enum, "attachedChannels": [ "string" ], "securityGroups": [ "string" ], "roleArn": "string", "tags": { }, "inputClass": enum } }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "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

CreateInput

Property Type Required Description
requestId

string

False

Unique identifier of the request to ensure the request is handled exactly once in case of retries.

name

string

False

Name of the input. Required.

sources

Array of type InputSourceRequest

False

Include this element only if the input is a pull input. Specifies the source URLs for the input.

destinations

Array of type InputDestinationRequest

False

Read-only. Specifies the URLs for a push input. The input is pushing to these addresses in order to deliver to MediaLive. You don't set these values.

type

InputType

False

You must include this element. It sets the type of the input, which then determines which other elements you must include in this CreateInput element.

inputSecurityGroups

Array of type string

False

A list of security groups referenced by IDs to attach to the input.

mediaConnectFlows

Array of type MediaConnectFlowRequest

False

Include this element only for a MEDIACONNECT type of input. A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.

inputDevices

Array of type InputDeviceSettings

False

Include this element only for an INPUT_DEVICE type of input. Settings for the devices.

roleArn

string

False

The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

tags

Tags

False

A collection of key-value pairs.

vpc

InputVpcRequest

False

Include this element only for a VPC type of input.

CreateInputResultModel

Property Type Required Description
input

Input

False

GatewayTimeoutException

Property Type Required Description
message

string

False

Input

Create a new input.

Property Type Required Description
arn

string

False

The Unique ARN of the input (generated, immutable).

id

string

False

The generated ID of the input (unique for user account, immutable).

name

string

False

Name for the input. Required.

type

InputType

False
sources

Array of type InputSource

False

A list of the sources of the input (PULL-type).

inputSourceType

InputSourceType

False

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

destinations

Array of type InputDestination

False

A list of the destinations of the input (PUSH-type).

mediaConnectFlows

Array of type MediaConnectFlow

False

A list of MediaConnect Flows for this input.

inputDevices

Array of type InputDeviceSettings

False

Settings for the input devices.

state

InputState

False
attachedChannels

Array of type string

False

A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).

securityGroups

Array of type string

False

A list of IDs for all the Input Security Groups attached to the input.

roleArn

string

False

The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

tags

Tags

False

A collection of key-value pairs.

inputClass

InputClass

False

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.

InputClass

A standard input has two sources and a single pipeline input only has one.

  • STANDARD

  • SINGLE_PIPELINE

InputDestination

The settings for a PUSH type input.

Property Type Required Description
url

string

False

This represents the endpoint that the customer stream will be pushed to.

ip

string

False

The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.

port

string

False

The port number for the input.

vpc

InputDestinationVpc

False

InputDestinationRequest

Endpoint settings for a PUSH type input. This element belongs to CreateInput, UpdateInput, and Input.

Property Type Required Description
streamName

string

False

A unique name for the location the RTMP stream is being pushed to.

InputDestinationVpc

The properties for a VPC type input destination.

Property Type Required Description
availabilityZone

string

False

The availability zone of the Input destination.

networkInterfaceId

string

False

The network interface ID of the Input destination in the VPC.

InputDeviceSettings

Settings for an input device. This element belongs to Input.

Property Type Required Description
id

string

False

The unique ID for the device.

InputSource

The settings for a PULL type input.

Property Type Required Description
url

string

False

This represents the customer's source URL where stream is pulled from.

username

string

False

The username for the input source.

passwordParam

string

False

The key used to extract the password from EC2 Parameter store.

InputSourceRequest

Settings for an input that is a pull input. This element belongs to CreateInput, UpdateInput, and Input.

Property Type Required Description
url

string

False

This represents the customer's source URL where stream is pulled from.

username

string

False

The username for the input source.

passwordParam

string

False

The key used to extract the password from EC2 Parameter store.

InputSourceType

There are two types of input sources, static and dynamic. If an input source is dynamic you can change the source url of the input dynamically using an input switch action. However, the only input type to support a dynamic url at this time is MP4_FILE. By default all input sources are static.

  • STATIC

  • DYNAMIC

InputState

  • CREATING

  • DETACHED

  • ATTACHED

  • DELETING

  • DELETED

InputType

Sets the type of the input, which then determines which other elements you must include in this CreateInput element. This element belongs to CreateInput.

  • UDP_PUSH

  • RTP_PUSH

  • RTMP_PUSH

  • RTMP_PULL

  • URL_PULL

  • MP4_FILE

  • MEDIACONNECT

  • RTP_SMPTE_2022_7

  • INPUT_DEVICE

  • AMAZON_RMT

InputVpcRequest

Configures a VPC input. This element belongs to CreateInput, UpdateInput, and Input.

Property Type Required Description
subnetIds

Array of type string

True

A list of 2 VPC subnet IDs from the same VPC. Subnet IDs must be mapped to two unique availability zones (AZ).

securityGroupIds

Array of type string

False

A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces. Requires subnetIds. If none are specified then the VPC default security group will be used.

InternalServiceError

Property Type Required Description
message

string

False

InvalidRequest

Property Type Required Description
message

string

False

LimitExceeded

Property Type Required Description
message

string

False

ListInputsResultModel

Property Type Required Description
inputs

Array of type Input

False
nextToken

string

False

MediaConnectFlow

The settings for a MediaConnect Flow.

Property Type Required Description
flowArn

string

False

The unique ARN of the MediaConnect Flow being used as a source.

MediaConnectFlowRequest

The settings for a MediaConnect Flow. This element belongs to CreateInput, UpdateInput, and Input.

Property Type Required Description
flowArn

string

False

The ARN of the MediaConnect Flow that you want to use as a source.

Tags

Tags for the resource. This element belongs to many resources belon.

Property Type Required Description

*

string

False

See Also

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

ListInputs

CreateInput