Menu
AWS Elemental MediaLive API Reference
API Reference

Inputs inputId

URI

/prod/inputs/ inputId

HTTP Methods

GET

Operation ID: DescribeInput

Produces details about an input

Path Parameters

Name Type Required Description
inputId String True

Unique ID of the input

Responses

Status Code Response Model Description
200 Input

Input details

400 InvalidRequest

This request was invalid.

500 InternalServiceError

Unexpected internal service error.

502 BadGatewayException

Bad Gateway Error

403 AccessDenied

You do not have permission to list channels.

404 ResourceNotFound

The channel you're requesting to describe does not exist.

504 GatewayTimeoutException

Gateway Timeout Error

429 LimitExceeded

Request limit exceeded on list channel calls to channel service.

PUT

Operation ID: UpdateInput

Updates an input.

Path Parameters

Name Type Required Description
inputId String True

Unique ID of the input

Responses

Status Code Response Model Description
200 UpdateInputResultModel

The input update is successfully initiated.

400 InvalidRequest

This request was invalid.

500 InternalServiceError

Unexpected internal service error.

502 BadGatewayException

Bad Gateway Error

403 AccessDenied

You do not have permission to list channels.

404 ResourceNotFound

The channel you're requesting to describe does not exist.

504 GatewayTimeoutException

Gateway Timeout Error

409 ResourceConflict

The channel is unable to create due to an issue with channel resources.

DELETE

Operation ID: DeleteInput

Deletes the input end point

Path Parameters

Name Type Required Description
inputId String True

Unique ID of the input

Responses

Status Code Response Model Description
200 Empty

Successful deletion

400 InvalidRequest

This request was invalid.

500 InternalServiceError

Unexpected internal service error.

502 BadGatewayException

Bad Gateway Error

403 AccessDenied

You do not have permission to list channels.

404 ResourceNotFound

The channel you're requesting to describe does not exist.

504 GatewayTimeoutException

Gateway Timeout Error

429 LimitExceeded

Request limit exceeded on list channel calls to channel service.

409 ResourceConflict

The channel is unable to create due to an issue with channel resources.

Schemas

Request Bodies

Example PUT

{ "inputSecurityGroups": [ "string" ], "sources": [ { "passwordParam": "string", "url": "string", "username": "string" } ], "destinations": [ { "streamName": "string" } ], "name": "string" }

Response Bodies

Example Input

{ "attachedChannels": [ "string" ], "sources": [ { "passwordParam": "string", "url": "string", "username": "string" } ], "destinations": [ { "port": "string", "ip": "string", "url": "string" } ], "name": "string", "securityGroups": [ "string" ], "state": enum, "id": "string", "type": enum, "arn": "string" }

Example UpdateInputResultModel

{ "input": { "attachedChannels": [ "string" ], "sources": [ { "passwordParam": "string", "url": "string", "username": "string" } ], "destinations": [ { "port": "string", "ip": "string", "url": "string" } ], "name": "string", "securityGroups": [ "string" ], "state": enum, "id": "string", "type": enum, "arn": "string" } }

Example Empty

{ }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example ResourceConflict

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

Empty

Property Type Required Description

GatewayTimeoutException

Property Type Required Description
message

string

False

Input

Property Type Required Description
attachedChannels

Array of type string

False

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

sources

Array of type InputSource

False

List of sources of input (PULL-type)

destinations

Array of type InputDestination

False

List of destinations of input (PULL-type)

name

string

False

user-assigned name (mutable)

securityGroups

Array of type string

False

List of IDs for all the security groups attached to the input.

state

string

False
id

string

False

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

type

string

False
arn

string

False

Unique ARN of input (generated, immutable)

InputDestination

Settings for a PUSH type input

Property Type Required Description
port

string

False

port for input

ip

string

False

system-generated static IP address of endpoint. Remains fixed for the lifetime of the input

url

string

False

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

InputDestinationRequest

Endpoint settings for a PUSH type input

Property Type Required Description
streamName

string

False

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

InputSource

Settings for a PULL type input

Property Type Required Description
passwordParam

string

False

key used to extract the password from EC2 Parameter store

url

string

False

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

username

string

False

username for input source

InputSourceRequest

Settings for for a PULL type input

Property Type Required Description
passwordParam

string

False

key used to extract the password from EC2 Parameter store

url

string

False

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

username

string

False

username for input source

InputState (enum)

  • CREATING

  • DETACHED

  • ATTACHED

  • DELETING

  • DELETED

InputType (enum)

  • UDP_PUSH

  • RTP_PUSH

  • RTMP_PUSH

  • RTMP_PULL

  • URL_PULL

InternalServiceError

Property Type Required Description
message

string

False

InvalidRequest

Property Type Required Description
message

string

False

LimitExceeded

Property Type Required Description
message

string

False

ResourceConflict

Property Type Required Description
message

string

False

ResourceNotFound

Property Type Required Description
message

string

False

UpdateInput

Property Type Required Description
inputSecurityGroups

Array of type string

False

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

sources

Array of type InputSourceRequest

False

The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.

destinations

Array of type InputDestinationRequest

False

Destination settings for PUSH type inputs.

name

string

False

Name of the input.

UpdateInputResultModel

Property Type Required Description
input

Input

False