Inputs inputId Partners - AWS Elemental MediaLive API Reference

Inputs inputId Partners

URI

/prod/inputs/inputId/partners

HTTP methods

POST

Operation ID: CreatePartnerInput

Path parameters
Name Type Required Description
inputId String True
Responses
Status code Response model Description
201 CreatePartnerInputResultModel

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

{ "requestId": "string", "tags": { } }

Response bodies

{ "input": { "arn": "string", "id": "string", "name": "string", "type": enum, "sources": [ { "url": "string", "username": "string", "passwordParam": "string" } ], "inputSourceType": enum, "destinations": [ { "url": "string", "ip": "string", "port": "string", "vpc": { "availabilityZone": "string", "networkInterfaceId": "string" } } ], "mediaConnectFlows": [ { "flowArn": "string" } ], "inputDevices": [ { "id": "string" } ], "state": enum, "attachedChannels": [ "string" ], "securityGroups": [ "string" ], "roleArn": "string", "tags": { }, "inputClass": enum, "inputPartnerIds": [ "string" ] } }
{ "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

CreatePartnerInput

Property Type Required Description
requestId

string

False

Unique identifier of the request to ensure the request is handled exactly once in case of retries.

tags

Tags

False

A collection of key-value pairs.

CreatePartnerInputResultModel

Property Type Required Description
input

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).

id

string

False

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

name

string

False

The user-assigned name (This is a mutable value).

type

InputType

False
sources

Array of type InputSource

False

A list of the sources of the input (PULL-type).

inputSourceType

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 inputs.

destinations

Array of type InputDestination

False

A list of the destinations of the input (PUSH-type).

mediaConnectFlows

Array of type MediaConnectFlow

False

A list of MediaConnect Flows for this input.

inputDevices

Array of type InputDeviceSettings

False

Settings for the input devices.

state

InputState

False
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).

securityGroups

Array of type string

False

A list of IDs for all the Input Security Groups attached to the input.

roleArn

string

False

The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

tags

Tags

False

A collection of key-value pairs.

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.

inputPartnerIds

Array of type string

False

A list of IDs for all Inputs which are partners of this one.

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
url

string

False

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

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.

vpc

InputDestinationVpc

False

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
url

string

False

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

username

string

False

The username for the input source.

passwordParam

string

False

The key used to extract the password from EC2 Parameter store.

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. However, the only input type to support a dynamic url at this time is MP4_FILE. By default all input sources are static.

  • STATIC

  • DYNAMIC

InputState

  • CREATING

  • DETACHED

  • ATTACHED

  • DELETING

  • DELETED

InputType

  • UDP_PUSH

  • RTP_PUSH

  • RTMP_PUSH

  • RTMP_PULL

  • URL_PULL

  • MP4_FILE

  • MEDIACONNECT

  • INPUT_DEVICE

  • AWS_CDI

InternalServiceError

Property Type Required Description
message

string

False

InvalidRequest

Property Type Required Description
message

string

False

LimitExceeded

Property Type Required Description
message

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.

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:

CreatePartnerInput