- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateInputCommand
Create an input
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MediaLiveClient, CreateInputCommand } from "@aws-sdk/client-medialive"; // ES Modules import
// const { MediaLiveClient, CreateInputCommand } = require("@aws-sdk/client-medialive"); // CommonJS import
const client = new MediaLiveClient(config);
const input = { // CreateInputRequest
Destinations: [ // __listOfInputDestinationRequest
{ // InputDestinationRequest
StreamName: "STRING_VALUE",
Network: "STRING_VALUE",
NetworkRoutes: [ // __listOfInputRequestDestinationRoute
{ // InputRequestDestinationRoute
Cidr: "STRING_VALUE",
Gateway: "STRING_VALUE",
},
],
StaticIpAddress: "STRING_VALUE",
},
],
InputDevices: [ // __listOfInputDeviceSettings
{ // InputDeviceSettings
Id: "STRING_VALUE",
},
],
InputSecurityGroups: [ // __listOf__string
"STRING_VALUE",
],
MediaConnectFlows: [ // __listOfMediaConnectFlowRequest
{ // MediaConnectFlowRequest
FlowArn: "STRING_VALUE",
},
],
Name: "STRING_VALUE",
RequestId: "STRING_VALUE",
RoleArn: "STRING_VALUE",
Sources: [ // __listOfInputSourceRequest
{ // InputSourceRequest
PasswordParam: "STRING_VALUE",
Url: "STRING_VALUE",
Username: "STRING_VALUE",
},
],
Tags: { // Tags
"<keys>": "STRING_VALUE",
},
Type: "UDP_PUSH" || "RTP_PUSH" || "RTMP_PUSH" || "RTMP_PULL" || "URL_PULL" || "MP4_FILE" || "MEDIACONNECT" || "INPUT_DEVICE" || "AWS_CDI" || "TS_FILE" || "SRT_CALLER" || "MULTICAST",
Vpc: { // InputVpcRequest
SecurityGroupIds: [
"STRING_VALUE",
],
SubnetIds: [ // required
"STRING_VALUE",
],
},
SrtSettings: { // SrtSettingsRequest
SrtCallerSources: [ // __listOfSrtCallerSourceRequest
{ // SrtCallerSourceRequest
Decryption: { // SrtCallerDecryptionRequest
Algorithm: "AES128" || "AES192" || "AES256",
PassphraseSecretArn: "STRING_VALUE",
},
MinimumLatency: Number("int"),
SrtListenerAddress: "STRING_VALUE",
SrtListenerPort: "STRING_VALUE",
StreamId: "STRING_VALUE",
},
],
},
InputNetworkLocation: "AWS" || "ON_PREMISES",
MulticastSettings: { // MulticastSettingsCreateRequest
Sources: [ // __listOfMulticastSourceCreateRequest
{ // MulticastSourceCreateRequest
SourceIp: "STRING_VALUE",
Url: "STRING_VALUE", // required
},
],
},
};
const command = new CreateInputCommand(input);
const response = await client.send(command);
// { // CreateInputResponse
// Input: { // Input
// Arn: "STRING_VALUE",
// AttachedChannels: [ // __listOf__string
// "STRING_VALUE",
// ],
// Destinations: [ // __listOfInputDestination
// { // InputDestination
// Ip: "STRING_VALUE",
// Port: "STRING_VALUE",
// Url: "STRING_VALUE",
// Vpc: { // InputDestinationVpc
// AvailabilityZone: "STRING_VALUE",
// NetworkInterfaceId: "STRING_VALUE",
// },
// Network: "STRING_VALUE",
// NetworkRoutes: [ // __listOfInputDestinationRoute
// { // InputDestinationRoute
// Cidr: "STRING_VALUE",
// Gateway: "STRING_VALUE",
// },
// ],
// },
// ],
// Id: "STRING_VALUE",
// InputClass: "STANDARD" || "SINGLE_PIPELINE",
// InputDevices: [ // __listOfInputDeviceSettings
// { // InputDeviceSettings
// Id: "STRING_VALUE",
// },
// ],
// InputPartnerIds: [
// "STRING_VALUE",
// ],
// InputSourceType: "STATIC" || "DYNAMIC",
// MediaConnectFlows: [ // __listOfMediaConnectFlow
// { // MediaConnectFlow
// FlowArn: "STRING_VALUE",
// },
// ],
// Name: "STRING_VALUE",
// RoleArn: "STRING_VALUE",
// SecurityGroups: [
// "STRING_VALUE",
// ],
// Sources: [ // __listOfInputSource
// { // InputSource
// PasswordParam: "STRING_VALUE",
// Url: "STRING_VALUE",
// Username: "STRING_VALUE",
// },
// ],
// State: "CREATING" || "DETACHED" || "ATTACHED" || "DELETING" || "DELETED",
// Tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// Type: "UDP_PUSH" || "RTP_PUSH" || "RTMP_PUSH" || "RTMP_PULL" || "URL_PULL" || "MP4_FILE" || "MEDIACONNECT" || "INPUT_DEVICE" || "AWS_CDI" || "TS_FILE" || "SRT_CALLER" || "MULTICAST",
// SrtSettings: { // SrtSettings
// SrtCallerSources: [ // __listOfSrtCallerSource
// { // SrtCallerSource
// Decryption: { // SrtCallerDecryption
// Algorithm: "AES128" || "AES192" || "AES256",
// PassphraseSecretArn: "STRING_VALUE",
// },
// MinimumLatency: Number("int"),
// SrtListenerAddress: "STRING_VALUE",
// SrtListenerPort: "STRING_VALUE",
// StreamId: "STRING_VALUE",
// },
// ],
// },
// InputNetworkLocation: "AWS" || "ON_PREMISES",
// MulticastSettings: { // MulticastSettings
// Sources: [ // __listOfMulticastSource
// { // MulticastSource
// SourceIp: "STRING_VALUE",
// Url: "STRING_VALUE", // required
// },
// ],
// },
// },
// };
CreateInputCommand Input
See CreateInputCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Destinations | InputDestinationRequest[] | undefined | Destination settings for PUSH type inputs. |
InputDevices | InputDeviceSettings[] | undefined | Settings for the devices. |
InputNetworkLocation | InputNetworkLocation | undefined | The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for an input in a customer network. |
InputSecurityGroups | string[] | undefined | A list of security groups referenced by IDs to attach to the input. |
MediaConnectFlows | MediaConnectFlowRequest[] | undefined | 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. |
MulticastSettings | MulticastSettingsCreateRequest | undefined | Multicast Input settings. |
Name | string | undefined | Name of the input. |
RequestId | string | undefined | Unique identifier of the request to ensure the request is handled exactly once in case of retries. |
RoleArn | string | undefined | The Amazon Resource Name (ARN) of the role this input assumes during and after creation. |
Sources | InputSourceRequest[] | undefined | 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. |
SrtSettings | SrtSettingsRequest | undefined | The settings associated with an SRT input. |
Tags | Record<string, string> | undefined | A collection of key-value pairs. |
Type | InputType | undefined | The different types of inputs that AWS Elemental MediaLive supports. |
Vpc | InputVpcRequest | undefined | 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. |
CreateInputCommand Output
See CreateInputCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Input | Input | undefined | Placeholder documentation for Input |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadGatewayException | server | Placeholder documentation for BadGatewayException |
BadRequestException | client | Placeholder documentation for BadRequestException |
ForbiddenException | client | Placeholder documentation for ForbiddenException |
GatewayTimeoutException | server | Placeholder documentation for GatewayTimeoutException |
InternalServerErrorException | server | Placeholder documentation for InternalServerErrorException |
TooManyRequestsException | client | Placeholder documentation for TooManyRequestsException |
MediaLiveServiceException | Base exception class for all service exceptions from MediaLive service. |