VodSource - AWS Elemental MediaTailor

VodSource

Manages VOD sources within a source location.

URI

/v1/sourceLocation/sourceLocationName/vodSource/vodSourceName

HTTP methods

GET

Operation ID: DescribeVodSource

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

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

vodSourceNameStringTrue

The identifier for the VOD source you are working on.

Responses
Status codeResponse modelDescription
200DescribeVodSourceResponse

Success.

POST

Operation ID: CreateVodSource

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

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

vodSourceNameStringTrue

The identifier for the VOD source you are working on.

Responses
Status codeResponse modelDescription
200DescribeVodSourceResponse

Success.

PUT

Operation ID: UpdateVodSource

Updates a specific VOD source in a specific source location.

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

vodSourceNameStringTrue

The identifier for the VOD source you are working on.

Responses
Status codeResponse modelDescription
200DescribeVodSourceResponse

Success.

DELETE

Operation ID: DeleteVodSource

Deletes a specific VOD source in a specific source location.

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

vodSourceNameStringTrue

The identifier for the VOD source you are working on.

Responses
Status codeResponse modelDescription
200DeleteVodSourceResponse

Success.

OPTIONS

Enable CORS by returning the correct headers

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

vodSourceNameStringTrue

The identifier for the VOD source you are working on.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

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

Response bodies

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

Properties

CreateVodSourceRequest

The VOD source configuration parameters.

PropertyTypeRequiredDescription
HttpPackageConfigurations

Array of type HttpPackageConfiguration

True

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

tags

object

False

The tags to assign to the VOD source.

DeleteVodSourceResponse

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

DescribeVodSourceResponse

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

PropertyTypeRequiredDescription
Arn

string

True

The ARN of the VOD source.

CreationTime

integer

Format: date-time

False

The timestamp that indicates when the VOD source was created.

HttpPackageConfigurations

Array of type HttpPackageConfiguration

True

The HTTP package configurations.

LastModifiedTime

integer

Format: date-time

False

The last modified time of the VOD source.

SourceLocationName

string

True

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

tags

object

False

The tags assigned to the VOD source.

VodSourceName

string

True

The name of the VOD 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.

UpdateVodSourceRequest

Updates a VOD source's configuration.

PropertyTypeRequiredDescription
HttpPackageConfigurations

Array of type HttpPackageConfiguration

True

A list of HTTP package configurations for the VOD 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:

DescribeVodSource

CreateVodSource

UpdateVodSource

DeleteVodSource