ListVodSources - AWS Elemental MediaTailor

ListVodSources

Lists the VOD sources contained in a source location. A source represents a piece of content.

URI

/v1/sourceLocation/sourceLocationName/vodSources

HTTP methods

GET

Operation ID: ListVodSources

Lists all the VOD sources in a source location.

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

Pagination token from the GET list request. Use the token to fetch the next page of results.

maxResultsStringFalse

Upper bound on number of records to return. The maximum number of results is 100.

Responses
Status codeResponse modelDescription
200ListVodSourcesResponse

Success.

OPTIONS

Enable CORS by returning the correct headers

Path parameters
NameTypeRequiredDescription
sourceLocationNameStringTrue

The identifier for the source location you are working on.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Response bodies

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

Properties

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.

ListVodSourcesResponse

A list of VOD sources.

PropertyTypeRequiredDescription
Items

Array of type VodSource

False

Lists the VOD sources.

NextToken

string

False

Pagination token from the list request. Use the token to fetch the next page of results.

VodSource

VOD source configuration parameters.

PropertyTypeRequiredDescription
Arn

string

True

The ARN for 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 for the VOD source.

LastModifiedTime

integer

Format: date-time

False

The timestamp that indicates when the VOD source was last modified.

SourceLocationName

string

True

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

tags

object

False

The tags assigned to the VOD source.

VodSourceName

string

True

The name of the VOD source.

See also

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

ListVodSources