LiveSource - AWS Elemental MediaTailor

LiveSource

Manages live sources within a source location.

URI

/v1/sourceLocation/sourceLocationName/liveSource/liveSourceName

HTTP methods

GET

Operation ID: DescribeLiveSource

Provides details about a specific live source in a specific source location.

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

liveSourceNameStringTrue

The identifier for the live source you are working on.

Responses
Status codeResponse modelDescription
200DescribeLiveSourceResponse

Success.

POST

Operation ID: CreateLiveSource

Creates name for a specific live source in a source location.

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

liveSourceNameStringTrue

The identifier for the live source you are working on.

Responses
Status codeResponse modelDescription
200DescribeLiveSourceResponse

Success.

PUT

Operation ID: UpdateLiveSource

Updates a specific live source in a specific source location.

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

liveSourceNameStringTrue

The identifier for the live source you are working on.

Responses
Status codeResponse modelDescription
200DescribeLiveSourceResponse

Success.

DELETE

Operation ID: DeleteLiveSource

Deletes a specific live source in a specific source location.

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

liveSourceNameStringTrue

The identifier for the live source you are working on.

Responses
Status codeResponse modelDescription
200DeleteLiveSourceResponse

Success.

Schemas

Request bodies

{ "HttpPackageConfigurations": [ { "Path": "string", "Type": enum, "SourceGroup": "string" } ], "tags": { } }
{ "HttpPackageConfigurations": [ { "Path": "string", "Type": enum, "SourceGroup": "string" } ] }

Response bodies

{ "LiveSourceName": "string", "SourceLocationName": "string", "CreationTime": integer, "LastModifiedTime": integer, "HttpPackageConfigurations": [ { "Path": "string", "Type": enum, "SourceGroup": "string" } ], "Arn": "string", "tags": { } }
{ }

Properties

CreateLiveSourceRequest

The live source configuration parameters.

PropertyTypeRequiredDescription
HttpPackageConfigurations

Array of type HttpPackageConfiguration

True

A list of HTTP package configuration parameters for this live source.

tags

object

False

The tags to assign to the live source.

DeleteLiveSourceResponse

This response includes only the "type" : "object" property.

DescribeLiveSourceResponse

This response includes only the "type" : "object" property.

PropertyTypeRequiredDescription
Arn

string

True

The ARN of the live source.

CreationTime

integer

Format: date-time

False

The timestamp that indicates when the live source was created.

HttpPackageConfigurations

Array of type HttpPackageConfiguration

True

The HTTP package configurations.

LastModifiedTime

integer

Format: date-time

False

The timestamp that indicates when the live source was modified.

LiveSourceName

string

True

The name of the live source.

SourceLocationName

string

True

The name of the source location associated with the VOD source.

tags

object

False

The tags assigned to the live source.

HttpPackageConfiguration

The HTTP package configuration properties for the requested VOD source.

PropertyTypeRequiredDescription
Path

string

True

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

SourceGroup

string

True

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

Type

string

Values: DASH | HLS

True

The streaming protocol for this package configuration. Supported values are HLS and DASH.

UpdateLiveSourceRequest

Updates a live source's configuration.

PropertyTypeRequiredDescription
HttpPackageConfigurations

Array of type HttpPackageConfiguration

True

A list of HTTP package configurations for the live source on this account.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeLiveSource

CreateLiveSource

UpdateLiveSource

DeleteLiveSource