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.
`403`	`AccessDenied`	You do not have permission to list channels.
`429`	`LimitExceeded`	Request limit exceeded on list channel calls to channel service.
`500`	`InternalServiceError`	Unexpected internal service error.
`502`	`BadGatewayException`	Bad Gateway Error
`504`	`GatewayTimeoutException`	Gateway Timeout Error

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.
`403`	`AccessDenied`	You do not have permission to list channels.
`429`	`LimitExceeded`	Request limit exceeded on list channel calls to channel service.
`500`	`InternalServiceError`	Unexpected internal service error.
`502`	`BadGatewayException`	Bad Gateway Error
`504`	`GatewayTimeoutException`	Gateway Timeout Error

Schemas

Request Bodies

Example POST


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

Response Bodies

Example ListInputsResultModel


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

Example CreateInputResultModel


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

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.
`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.
`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.
`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.
`destinations`	Array of type InputDestinationRequest	False	Destination settings for PUSH type inputs.
`name`	string	False	Name of the input.
`vpc`	InputVpcRequest	False
`type`	InputType	False
`tags`	Tags	False	A collection of key-value pairs.

CreateInputResultModel

Property	Type	Required	Description
`input`	Input	False

GatewayTimeoutException

Property	Type	Required	Description
`message`	string	False

Input

Property	Type	Required	Description
`sources`	Array of type InputSource	False	A list of the sources of the input (PULL-type).
`destinations`	Array of type InputDestination	False	A list of the destinations of the input (PUSH-type).
`type`	InputType	False
`tags`	Tags	False	A collection of key-value pairs.
`mediaConnectFlows`	Array of type MediaConnectFlow	False	A list of MediaConnect Flows for this input.
`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).
`roleArn`	string	False	The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
`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.
`name`	string	False	The user-assigned name (This is a mutable value).
`securityGroups`	Array of type string	False	A list of IDs for all the Input Security Groups attached to the input.
`id`	string	False	The generated ID of the input (unique for user account, immutable).
`state`	InputState	False
`arn`	string	False	The Unique ARN of the input (generated, immutable).

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
`port`	string	False	The port number for the input.
`ip`	string	False	The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.
`vpc`	InputDestinationVpc	False
`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.

InputDestinationVpc

The properties for a VPC type input destination.

Property	Type	Required	Description
`networkInterfaceId`	string	False	The network interface ID of the Input destination in the VPC.
`availabilityZone`	string	False	The availability zone of the Input destination.

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.

InputState

CREATING
DETACHED
ATTACHED
DELETING
DELETED

InputType

UDP_PUSH
RTP_PUSH
RTMP_PUSH
RTMP_PULL
URL_PULL
MP4_FILE
MEDIACONNECT

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