AWS Documentation » AWS Elemental MediaLive » API Reference » Resources » Inputs

Inputs

URI

/prod/inputs

HTTP Methods

GET

Operation ID: ListInputs

Produces list of inputs that have been created

Query Parameters

Name	Type	Required	Description
nextToken	String	False
maxResults	String	False

Responses

Status Code	Response Model	Description
200	ListInputsResultModel	An array of inputs
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.
504	GatewayTimeoutException	Gateway Timeout Error
429	LimitExceeded	Request limit exceeded on list channel calls to channel service.

POST

Operation ID: CreateInput

Create an input

Responses

Status Code	Response Model	Description
201	CreateInputResultModel	Creation of channel is started.
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.
504	GatewayTimeoutException	Gateway Timeout Error
429	LimitExceeded	Request limit exceeded on list channel calls to channel service.

Schemas

Request Bodies

Example POST

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

Response Bodies

Example ListInputsResultModel

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

Example CreateInputResultModel

{
  "input": {
    "attachedChannels": [
      "string"
    ],
    "sources": [
      {
        "passwordParam": "string",
        "url": "string",
        "username": "string"
      }
    ],
    "destinations": [
      {
        "port": "string",
        "ip": "string",
        "url": "string"
      }
    ],
    "name": "string",
    "securityGroups": [
      "string"
    ],
    "id": "string",
    "state": enum,
    "arn": "string",
    "type": 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
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	settings required for PULL-type inputs; one per redundancy group Only one of sources and destinations can be specified
requestId	string	False	Unique identifier of the request to ensure the request is handled exactly once in case of retries
destinations	Array of type InputDestinationRequest	False	settings required for PUSH-type inputs; one per redundancy group. Only one of sources and destinations can be specified. Note: there are currently no settings required for PUSH-type inputs
name	string	False	Name of the input.
type	string	False

CreateInputResultModel

Property	Type	Required	Description
input	Input	False

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.
id	string	False	generated ID of input (unique for user account, immutable)
state	string	False
arn	string	False	Unique ARN of input (generated, immutable)
type	string	False

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

ListInputsResultModel

Property	Type	Required	Description
inputs	Array of type Input	False
nextToken	string	False