Inputs
URI
/prod/inputs
HTTP methods
GET
Operation ID: ListInputs
Query parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextToken | String | False | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxResults | String | False |
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
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
{ "destinations": [ { "streamName": "string" } ], "inputDevices": [ { "id": "string" } ], "inputSecurityGroups": [ "string" ], "mediaConnectFlows": [ { "flowArn": "string" } ], "name": "string", "requestId": "string", "roleArn": "string", "sources": [ { "passwordParam": "string", "url": "string", "username": "string" } ], "tags": { }, "type": enum, "vpc": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } }
Response bodies
{ "inputs": [ { "arn": "string", "attachedChannels": [ "string" ], "destinations": [ { "ip": "string", "port": "string", "url": "string", "vpc": { "availabilityZone": "string", "networkInterfaceId": "string" } } ], "id": "string", "inputClass": enum, "inputDevices": [ { "id": "string" } ], "inputPartnerIds": [ "string" ], "inputSourceType": enum, "mediaConnectFlows": [ { "flowArn": "string" } ], "name": "string", "roleArn": "string", "securityGroups": [ "string" ], "sources": [ { "passwordParam": "string", "url": "string", "username": "string" } ], "state": enum, "tags": { }, "type": enum } ], "nextToken": "string" }
{ "input": { "arn": "string", "attachedChannels": [ "string" ], "destinations": [ { "ip": "string", "port": "string", "url": "string", "vpc": { "availabilityZone": "string", "networkInterfaceId": "string" } } ], "id": "string", "inputClass": enum, "inputDevices": [ { "id": "string" } ], "inputPartnerIds": [ "string" ], "inputSourceType": enum, "mediaConnectFlows": [ { "flowArn": "string" } ], "name": "string", "roleArn": "string", "securityGroups": [ "string" ], "sources": [ { "passwordParam": "string", "url": "string", "username": "string" } ], "state": enum, "tags": { }, "type": enum } }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
Properties
AccessDenied
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
BadGatewayException
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
CreateInput
Property | Type | Required | Description |
---|---|---|---|
destinations | Array of type InputDestinationRequest | False | Destination settings for PUSH type inputs. |
inputDevices | Array of type InputDeviceSettings | False | Settings for the devices. |
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 | 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. |
name | string | False | Name of the input. |
requestId | string | False | Unique identifier of the request to ensure the request is handled exactly once in case of retries. |
roleArn | string | False | The Amazon Resource Name (ARN) of the role this input assumes during and after creation. |
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. |
tags | False | A collection of key-value pairs. | |
type | False | ||
vpc | False |
CreateInputResultModel
Property | Type | Required | Description |
---|---|---|---|
input | False |
GatewayTimeoutException
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
Input
Property | Type | Required | Description |
---|---|---|---|
arn | string | False | The Unique ARN of the input (generated, immutable). |
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). |
destinations | Array of type InputDestination | False | A list of the destinations of the input (PUSH-type). |
id | string | False | Read-only ID for the input. Unique in the AWS account. |
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. | |
inputDevices | Array of type InputDeviceSettings | False | Settings for the input devices. |
inputPartnerIds | Array of type string | False | A list of IDs for all Inputs which are partners of this one. |
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 and TS_FILE inputs. | |
mediaConnectFlows | Array of type MediaConnectFlow | False | A list of MediaConnect Flows for this input. |
name | string | False | A modifiable ID for the input. |
roleArn | string | False | The Amazon Resource Name (ARN) of the role this input assumes during and after creation. |
securityGroups | Array of type string | False | A list of IDs for all the Input Security Groups attached to the input. |
sources | Array of type InputSource | False | A list of the sources of the input (PULL-type). |
state | False | ||
tags | False | A collection of key-value pairs. | |
type | False |
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 |
---|---|---|---|
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. |
url | string | False | This represents the endpoint that the customer stream will be pushed to. |
vpc | False |
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. |
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.
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 |
---|---|---|---|
passwordParam | string | False | The 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 | The username for the input source. |
InputSourceRequest
Settings for for a PULL type input.
Property | Type | Required | Description |
---|---|---|---|
passwordParam | string | False | The 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 | The username for the input source. |
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. Currently, two input types support a dynamic url at this time, MP4_FILE and TS_FILE. By default all input sources are static.
STATIC
DYNAMIC
InputState
CREATING
DETACHED
ATTACHED
DELETING
DELETED
InputType
The different types of inputs that AWS Elemental MediaLive supports.
UDP_PUSH
RTP_PUSH
RTMP_PUSH
RTMP_PULL
URL_PULL
MP4_FILE
MEDIACONNECT
MULTICAST
INPUT_DEVICE
AWS_CDI
TS_FILE
SRT_CALLER
SDI
InputVpcRequest
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.
Property | Type | Required | Description |
---|---|---|---|
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. |
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). |
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.
Property | Type | Required | Description |
---|---|---|---|
flowArn | string | False | The ARN of the MediaConnect Flow that you want to use as a source. |
Tags
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: