AWS MediaTailor 2018-04-23
- Client: Aws\MediaTailor\MediaTailorClient
- Service ID: mediatailor
- Version: 2018-04-23
This page describes the parameters and results for the operations of the AWS MediaTailor (2018-04-23), and shows how to use the Aws\MediaTailor\MediaTailorClient object to call the described operations. This documentation is specific to the 2018-04-23 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- ConfigureLogsForPlaybackConfiguration ( array $params = [] )
Configures Amazon CloudWatch log settings for a playback configuration.
- CreateChannel ( array $params = [] )
Creates a channel.
- CreateLiveSource ( array $params = [] )
Creates name for a specific live source in a source location.
- CreatePrefetchSchedule ( array $params = [] )
Creates a new prefetch schedule for the specified playback configuration.
- CreateProgram ( array $params = [] )
Creates a program.
- CreateSourceLocation ( array $params = [] )
Creates a source location on a specific channel.
- CreateVodSource ( array $params = [] )
Creates name for a specific VOD source in a source location.
- DeleteChannel ( array $params = [] )
Deletes a channel.
- DeleteChannelPolicy ( array $params = [] )
Deletes a channel's IAM policy.
- DeleteLiveSource ( array $params = [] )
Deletes a specific live source in a specific source location.
- DeletePlaybackConfiguration ( array $params = [] )
Deletes the playback configuration for the specified name.
- DeletePrefetchSchedule ( array $params = [] )
Deletes a prefetch schedule for a specific playback configuration.
- DeleteProgram ( array $params = [] )
Deletes a specific program on a specific channel.
- DeleteSourceLocation ( array $params = [] )
Deletes a source location on a specific channel.
- DeleteVodSource ( array $params = [] )
Deletes a specific VOD source in a specific source location.
- DescribeChannel ( array $params = [] )
Describes the properties of a specific channel.
- DescribeLiveSource ( array $params = [] )
Provides details about a specific live source in a specific source location.
- DescribeProgram ( array $params = [] )
Retrieves the properties of the requested program.
- DescribeSourceLocation ( array $params = [] )
Retrieves the properties of the requested source location.
- DescribeVodSource ( array $params = [] )
Provides details about a specific VOD source in a specific source location.
- GetChannelPolicy ( array $params = [] )
Retrieves information about a channel's IAM policy.
- GetChannelSchedule ( array $params = [] )
Retrieves information about your channel's schedule.
- GetPlaybackConfiguration ( array $params = [] )
Returns the playback configuration for the specified name.
- GetPrefetchSchedule ( array $params = [] )
Returns information about the prefetch schedule for a specific playback configuration.
- ListAlerts ( array $params = [] )
Returns a list of alerts for the given resource.
- ListChannels ( array $params = [] )
Retrieves a list of channels that are associated with this account.
- ListLiveSources ( array $params = [] )
lists all the live sources in a source location.
- ListPlaybackConfigurations ( array $params = [] )
Returns a list of the playback configurations defined in AWS Elemental MediaTailor.
- ListPrefetchSchedules ( array $params = [] )
Creates a new prefetch schedule.
- ListSourceLocations ( array $params = [] )
Retrieves a list of source locations.
- ListTagsForResource ( array $params = [] )
Returns a list of the tags assigned to the specified playback configuration resource.
- ListVodSources ( array $params = [] )
Lists all the VOD sources in a source location.
- PutChannelPolicy ( array $params = [] )
Creates an IAM policy for the channel.
- PutPlaybackConfiguration ( array $params = [] )
Adds a new playback configuration to AWS Elemental MediaTailor.
- StartChannel ( array $params = [] )
Starts a specific channel.
- StopChannel ( array $params = [] )
Stops a specific channel.
- TagResource ( array $params = [] )
Adds tags to the specified playback configuration resource.
- UntagResource ( array $params = [] )
Removes tags from the specified playback configuration resource.
- UpdateChannel ( array $params = [] )
Updates an existing channel.
- UpdateLiveSource ( array $params = [] )
Updates a specific live source in a specific source location.
- UpdateSourceLocation ( array $params = [] )
Updates a source location on a specific channel.
- UpdateVodSource ( array $params = [] )
Updates a specific VOD source in a specific source location.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
ConfigureLogsForPlaybackConfiguration
$result = $client->configureLogsForPlaybackConfiguration([/* ... */]); $promise = $client->configureLogsForPlaybackConfigurationAsync([/* ... */]);
Configures Amazon CloudWatch log settings for a playback configuration.
Parameter Syntax
$result = $client->configureLogsForPlaybackConfiguration([
'PercentEnabled' => <integer>, // REQUIRED
'PlaybackConfigurationName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- PercentEnabled
-
- Required: Yes
- Type: int
The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100
- PlaybackConfigurationName
-
- Required: Yes
- Type: string
The name of the playback configuration.
Result Syntax
[
'PercentEnabled' => <integer>,
'PlaybackConfigurationName' => '<string>',
]
Result Details
Members
Errors
There are no errors described for this operation.
CreateChannel
$result = $client->createChannel([/* ... */]); $promise = $client->createChannelAsync([/* ... */]);
Creates a channel.
Parameter Syntax
$result = $client->createChannel([
'ChannelName' => '<string>', // REQUIRED
'FillerSlate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'Outputs' => [ // REQUIRED
[
'DashPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
'MinBufferTimeSeconds' => <integer>,
'MinUpdatePeriodSeconds' => <integer>,
'SuggestedPresentationDelaySeconds' => <integer>,
],
'HlsPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
],
'ManifestName' => '<string>', // REQUIRED
'SourceGroup' => '<string>', // REQUIRED
],
// ...
],
'PlaybackMode' => 'LOOP|LINEAR', // REQUIRED
'Tags' => ['<string>', ...],
'Tier' => 'BASIC|STANDARD',
]);
Parameter Details
Members
- ChannelName
-
- Required: Yes
- Type: string
- FillerSlate
-
- Type: SlateSource structure
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
- Outputs
-
- Required: Yes
- Type: Array of RequestOutputItem structures
The channel's output properties.
- PlaybackMode
-
- Required: Yes
- Type: string
The type of playback mode to use for this channel.
LINEAR - The programs in the schedule play once back-to-back in the schedule.
LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags to assign to the channel.
- Tier
-
- Type: string
The tier of the channel.
Result Syntax
[
'Arn' => '<string>',
'ChannelName' => '<string>',
'ChannelState' => 'RUNNING|STOPPED',
'CreationTime' => <DateTime>,
'FillerSlate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'LastModifiedTime' => <DateTime>,
'Outputs' => [
[
'DashPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
'MinBufferTimeSeconds' => <integer>,
'MinUpdatePeriodSeconds' => <integer>,
'SuggestedPresentationDelaySeconds' => <integer>,
],
'HlsPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
],
'ManifestName' => '<string>',
'PlaybackUrl' => '<string>',
'SourceGroup' => '<string>',
],
// ...
],
'PlaybackMode' => '<string>',
'Tags' => ['<string>', ...],
'Tier' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelName
-
- Type: string
- ChannelState
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- FillerSlate
-
- Type: SlateSource structure
Slate VOD source configuration.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Outputs
-
- Type: Array of ResponseOutputItem structures
- PlaybackMode
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Tier
-
- Type: string
Errors
There are no errors described for this operation.
CreateLiveSource
$result = $client->createLiveSource([/* ... */]); $promise = $client->createLiveSourceAsync([/* ... */]);
Creates name for a specific live source in a source location.
Parameter Syntax
$result = $client->createLiveSource([
'HttpPackageConfigurations' => [ // REQUIRED
[
'Path' => '<string>', // REQUIRED
'SourceGroup' => '<string>', // REQUIRED
'Type' => 'DASH|HLS', // REQUIRED
],
// ...
],
'LiveSourceName' => '<string>', // REQUIRED
'SourceLocationName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- HttpPackageConfigurations
-
- Required: Yes
- Type: Array of HttpPackageConfiguration structures
A list of HTTP package configuration parameters for this live source.
- LiveSourceName
-
- Required: Yes
- Type: string
- SourceLocationName
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags to assign to the live source.
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'HttpPackageConfigurations' => [
[
'Path' => '<string>',
'SourceGroup' => '<string>',
'Type' => 'DASH|HLS',
],
// ...
],
'LastModifiedTime' => <DateTime>,
'LiveSourceName' => '<string>',
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- HttpPackageConfigurations
-
- Type: Array of HttpPackageConfiguration structures
The VOD source's HTTP package configuration settings.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LiveSourceName
-
- Type: string
- SourceLocationName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
There are no errors described for this operation.
CreatePrefetchSchedule
$result = $client->createPrefetchSchedule([/* ... */]); $promise = $client->createPrefetchScheduleAsync([/* ... */]);
Creates a new prefetch schedule for the specified playback configuration.
Parameter Syntax
$result = $client->createPrefetchSchedule([
'Consumption' => [ // REQUIRED
'AvailMatchingCriteria' => [
[
'DynamicVariable' => '<string>', // REQUIRED
'Operator' => 'EQUALS', // REQUIRED
],
// ...
],
'EndTime' => <integer || string || DateTime>, // REQUIRED
'StartTime' => <integer || string || DateTime>,
],
'Name' => '<string>', // REQUIRED
'PlaybackConfigurationName' => '<string>', // REQUIRED
'Retrieval' => [ // REQUIRED
'DynamicVariables' => ['<string>', ...],
'EndTime' => <integer || string || DateTime>, // REQUIRED
'StartTime' => <integer || string || DateTime>,
],
'StreamId' => '<string>',
]);
Parameter Details
Members
- Consumption
-
- Required: Yes
- Type: PrefetchConsumption structure
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
- Name
-
- Required: Yes
- Type: string
- PlaybackConfigurationName
-
- Required: Yes
- Type: string
- Retrieval
-
- Required: Yes
- Type: PrefetchRetrieval structure
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
- StreamId
-
- Type: string
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
Result Syntax
[
'Arn' => '<string>',
'Consumption' => [
'AvailMatchingCriteria' => [
[
'DynamicVariable' => '<string>',
'Operator' => 'EQUALS',
],
// ...
],
'EndTime' => <DateTime>,
'StartTime' => <DateTime>,
],
'Name' => '<string>',
'PlaybackConfigurationName' => '<string>',
'Retrieval' => [
'DynamicVariables' => ['<string>', ...],
'EndTime' => <DateTime>,
'StartTime' => <DateTime>,
],
'StreamId' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
- Consumption
-
- Type: PrefetchConsumption structure
A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
- Name
-
- Type: string
- PlaybackConfigurationName
-
- Type: string
- Retrieval
-
- Type: PrefetchRetrieval structure
A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
- StreamId
-
- Type: string
Errors
There are no errors described for this operation.
CreateProgram
$result = $client->createProgram([/* ... */]); $promise = $client->createProgramAsync([/* ... */]);
Creates a program.
Parameter Syntax
$result = $client->createProgram([
'AdBreaks' => [
[
'MessageType' => 'SPLICE_INSERT',
'OffsetMillis' => <integer>,
'Slate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'SpliceInsertMessage' => [
'AvailNum' => <integer>,
'AvailsExpected' => <integer>,
'SpliceEventId' => <integer>,
'UniqueProgramId' => <integer>,
],
],
// ...
],
'ChannelName' => '<string>', // REQUIRED
'LiveSourceName' => '<string>',
'ProgramName' => '<string>', // REQUIRED
'ScheduleConfiguration' => [ // REQUIRED
'Transition' => [ // REQUIRED
'DurationMillis' => <integer>,
'RelativePosition' => 'BEFORE_PROGRAM|AFTER_PROGRAM', // REQUIRED
'RelativeProgram' => '<string>',
'ScheduledStartTimeMillis' => <integer>,
'Type' => '<string>', // REQUIRED
],
],
'SourceLocationName' => '<string>', // REQUIRED
'VodSourceName' => '<string>',
]);
Parameter Details
Members
- AdBreaks
-
- Type: Array of AdBreak structures
The ad break configuration settings.
- ChannelName
-
- Required: Yes
- Type: string
- LiveSourceName
-
- Type: string
The name of the LiveSource for this Program.
- ProgramName
-
- Required: Yes
- Type: string
- ScheduleConfiguration
-
- Required: Yes
- Type: ScheduleConfiguration structure
The schedule configuration settings.
- SourceLocationName
-
- Required: Yes
- Type: string
The name of the source location.
- VodSourceName
-
- Type: string
The name that's used to refer to a VOD source.
Result Syntax
[
'AdBreaks' => [
[
'MessageType' => 'SPLICE_INSERT',
'OffsetMillis' => <integer>,
'Slate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'SpliceInsertMessage' => [
'AvailNum' => <integer>,
'AvailsExpected' => <integer>,
'SpliceEventId' => <integer>,
'UniqueProgramId' => <integer>,
],
],
// ...
],
'Arn' => '<string>',
'ChannelName' => '<string>',
'CreationTime' => <DateTime>,
'LiveSourceName' => '<string>',
'ProgramName' => '<string>',
'ScheduledStartTime' => <DateTime>,
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
]
Result Details
Members
- AdBreaks
-
- Type: Array of AdBreak structures
- Arn
-
- Type: string
- ChannelName
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LiveSourceName
-
- Type: string
- ProgramName
-
- Type: string
- ScheduledStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SourceLocationName
-
- Type: string
- VodSourceName
-
- Type: string
Errors
There are no errors described for this operation.
CreateSourceLocation
$result = $client->createSourceLocation([/* ... */]); $promise = $client->createSourceLocationAsync([/* ... */]);
Creates a source location on a specific channel.
Parameter Syntax
$result = $client->createSourceLocation([
'AccessConfiguration' => [
'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN',
'SecretsManagerAccessTokenConfiguration' => [
'HeaderName' => '<string>',
'SecretArn' => '<string>',
'SecretStringKey' => '<string>',
],
],
'DefaultSegmentDeliveryConfiguration' => [
'BaseUrl' => '<string>',
],
'HttpConfiguration' => [ // REQUIRED
'BaseUrl' => '<string>', // REQUIRED
],
'SegmentDeliveryConfigurations' => [
[
'BaseUrl' => '<string>',
'Name' => '<string>',
],
// ...
],
'SourceLocationName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- AccessConfiguration
-
- Type: AccessConfiguration structure
Access configuration parameters. Configures the type of authentication used to access content from your source location.
- DefaultSegmentDeliveryConfiguration
-
- Type: DefaultSegmentDeliveryConfiguration structure
The optional configuration for the server that serves segments.
- HttpConfiguration
-
- Required: Yes
- Type: HttpConfiguration structure
The source's HTTP package configurations.
- SegmentDeliveryConfigurations
-
- Type: Array of SegmentDeliveryConfiguration structures
A list of the segment delivery configurations associated with this resource.
- SourceLocationName
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags to assign to the source location.
Result Syntax
[
'AccessConfiguration' => [
'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN',
'SecretsManagerAccessTokenConfiguration' => [
'HeaderName' => '<string>',
'SecretArn' => '<string>',
'SecretStringKey' => '<string>',
],
],
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'DefaultSegmentDeliveryConfiguration' => [
'BaseUrl' => '<string>',
],
'HttpConfiguration' => [
'BaseUrl' => '<string>',
],
'LastModifiedTime' => <DateTime>,
'SegmentDeliveryConfigurations' => [
[
'BaseUrl' => '<string>',
'Name' => '<string>',
],
// ...
],
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- AccessConfiguration
-
- Type: AccessConfiguration structure
Access configuration parameters.
- Arn
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DefaultSegmentDeliveryConfiguration
-
- Type: DefaultSegmentDeliveryConfiguration structure
The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.
- HttpConfiguration
-
- Type: HttpConfiguration structure
The HTTP configuration for the source location.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SegmentDeliveryConfigurations
-
- Type: Array of SegmentDeliveryConfiguration structures
- SourceLocationName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
There are no errors described for this operation.
CreateVodSource
$result = $client->createVodSource([/* ... */]); $promise = $client->createVodSourceAsync([/* ... */]);
Creates name for a specific VOD source in a source location.
Parameter Syntax
$result = $client->createVodSource([
'HttpPackageConfigurations' => [ // REQUIRED
[
'Path' => '<string>', // REQUIRED
'SourceGroup' => '<string>', // REQUIRED
'Type' => 'DASH|HLS', // REQUIRED
],
// ...
],
'SourceLocationName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
'VodSourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- HttpPackageConfigurations
-
- Required: Yes
- Type: Array of HttpPackageConfiguration structures
A list of HTTP package configuration parameters for this VOD source.
- SourceLocationName
-
- Required: Yes
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags to assign to the VOD source.
- VodSourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'HttpPackageConfigurations' => [
[
'Path' => '<string>',
'SourceGroup' => '<string>',
'Type' => 'DASH|HLS',
],
// ...
],
'LastModifiedTime' => <DateTime>,
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
'VodSourceName' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- HttpPackageConfigurations
-
- Type: Array of HttpPackageConfiguration structures
The VOD source's HTTP package configuration settings.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SourceLocationName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- VodSourceName
-
- Type: string
Errors
There are no errors described for this operation.
DeleteChannel
$result = $client->deleteChannel([/* ... */]); $promise = $client->deleteChannelAsync([/* ... */]);
Deletes a channel. You must stop the channel before it can be deleted.
Parameter Syntax
$result = $client->deleteChannel([
'ChannelName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteChannelPolicy
$result = $client->deleteChannelPolicy([/* ... */]); $promise = $client->deleteChannelPolicyAsync([/* ... */]);
Deletes a channel's IAM policy.
Parameter Syntax
$result = $client->deleteChannelPolicy([
'ChannelName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteLiveSource
$result = $client->deleteLiveSource([/* ... */]); $promise = $client->deleteLiveSourceAsync([/* ... */]);
Deletes a specific live source in a specific source location.
Parameter Syntax
$result = $client->deleteLiveSource([
'LiveSourceName' => '<string>', // REQUIRED
'SourceLocationName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeletePlaybackConfiguration
$result = $client->deletePlaybackConfiguration([/* ... */]); $promise = $client->deletePlaybackConfigurationAsync([/* ... */]);
Deletes the playback configuration for the specified name.
Parameter Syntax
$result = $client->deletePlaybackConfiguration([
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeletePrefetchSchedule
$result = $client->deletePrefetchSchedule([/* ... */]); $promise = $client->deletePrefetchScheduleAsync([/* ... */]);
Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.
Parameter Syntax
$result = $client->deletePrefetchSchedule([
'Name' => '<string>', // REQUIRED
'PlaybackConfigurationName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteProgram
$result = $client->deleteProgram([/* ... */]); $promise = $client->deleteProgramAsync([/* ... */]);
Deletes a specific program on a specific channel.
Parameter Syntax
$result = $client->deleteProgram([
'ChannelName' => '<string>', // REQUIRED
'ProgramName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteSourceLocation
$result = $client->deleteSourceLocation([/* ... */]); $promise = $client->deleteSourceLocationAsync([/* ... */]);
Deletes a source location on a specific channel.
Parameter Syntax
$result = $client->deleteSourceLocation([
'SourceLocationName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteVodSource
$result = $client->deleteVodSource([/* ... */]); $promise = $client->deleteVodSourceAsync([/* ... */]);
Deletes a specific VOD source in a specific source location.
Parameter Syntax
$result = $client->deleteVodSource([
'SourceLocationName' => '<string>', // REQUIRED
'VodSourceName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DescribeChannel
$result = $client->describeChannel([/* ... */]); $promise = $client->describeChannelAsync([/* ... */]);
Describes the properties of a specific channel.
Parameter Syntax
$result = $client->describeChannel([
'ChannelName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'ChannelName' => '<string>',
'ChannelState' => 'RUNNING|STOPPED',
'CreationTime' => <DateTime>,
'FillerSlate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'LastModifiedTime' => <DateTime>,
'Outputs' => [
[
'DashPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
'MinBufferTimeSeconds' => <integer>,
'MinUpdatePeriodSeconds' => <integer>,
'SuggestedPresentationDelaySeconds' => <integer>,
],
'HlsPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
],
'ManifestName' => '<string>',
'PlaybackUrl' => '<string>',
'SourceGroup' => '<string>',
],
// ...
],
'PlaybackMode' => '<string>',
'Tags' => ['<string>', ...],
'Tier' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the channel.
- ChannelName
-
- Type: string
The name of the channel.
- ChannelState
-
- Type: string
Indicates whether the channel is in a running state or not.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the channel was created.
- FillerSlate
-
- Type: SlateSource structure
Contains information about the slate used to fill gaps between programs in the schedule.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the channel was last modified.
- Outputs
-
- Type: Array of ResponseOutputItem structures
The channel's output properties.
- PlaybackMode
-
- Type: string
The channel's playback mode.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags assigned to the channel.
- Tier
-
- Type: string
The channel's tier.
Errors
There are no errors described for this operation.
DescribeLiveSource
$result = $client->describeLiveSource([/* ... */]); $promise = $client->describeLiveSourceAsync([/* ... */]);
Provides details about a specific live source in a specific source location.
Parameter Syntax
$result = $client->describeLiveSource([
'LiveSourceName' => '<string>', // REQUIRED
'SourceLocationName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'HttpPackageConfigurations' => [
[
'Path' => '<string>',
'SourceGroup' => '<string>',
'Type' => 'DASH|HLS',
],
// ...
],
'LastModifiedTime' => <DateTime>,
'LiveSourceName' => '<string>',
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the live source.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the live source was created.
- HttpPackageConfigurations
-
- Type: Array of HttpPackageConfiguration structures
The HTTP package configurations.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the live source was modified.
- LiveSourceName
-
- Type: string
The name of the live source.
- SourceLocationName
-
- Type: string
The name of the source location associated with the VOD source.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags assigned to the live source.
Errors
There are no errors described for this operation.
DescribeProgram
$result = $client->describeProgram([/* ... */]); $promise = $client->describeProgramAsync([/* ... */]);
Retrieves the properties of the requested program.
Parameter Syntax
$result = $client->describeProgram([
'ChannelName' => '<string>', // REQUIRED
'ProgramName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AdBreaks' => [
[
'MessageType' => 'SPLICE_INSERT',
'OffsetMillis' => <integer>,
'Slate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'SpliceInsertMessage' => [
'AvailNum' => <integer>,
'AvailsExpected' => <integer>,
'SpliceEventId' => <integer>,
'UniqueProgramId' => <integer>,
],
],
// ...
],
'Arn' => '<string>',
'ChannelName' => '<string>',
'CreationTime' => <DateTime>,
'LiveSourceName' => '<string>',
'ProgramName' => '<string>',
'ScheduledStartTime' => <DateTime>,
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
]
Result Details
Members
- AdBreaks
-
- Type: Array of AdBreak structures
The ad break configuration settings.
- Arn
-
- Type: string
The ARN of the program.
- ChannelName
-
- Type: string
The name of the channel that the program belongs to.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the program was created.
- LiveSourceName
-
- Type: string
The name of the LiveSource for this Program.
- ProgramName
-
- Type: string
The name of the program.
- ScheduledStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
- SourceLocationName
-
- Type: string
The source location name.
- VodSourceName
-
- Type: string
The name that's used to refer to a VOD source.
Errors
There are no errors described for this operation.
DescribeSourceLocation
$result = $client->describeSourceLocation([/* ... */]); $promise = $client->describeSourceLocationAsync([/* ... */]);
Retrieves the properties of the requested source location.
Parameter Syntax
$result = $client->describeSourceLocation([
'SourceLocationName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AccessConfiguration' => [
'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN',
'SecretsManagerAccessTokenConfiguration' => [
'HeaderName' => '<string>',
'SecretArn' => '<string>',
'SecretStringKey' => '<string>',
],
],
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'DefaultSegmentDeliveryConfiguration' => [
'BaseUrl' => '<string>',
],
'HttpConfiguration' => [
'BaseUrl' => '<string>',
],
'LastModifiedTime' => <DateTime>,
'SegmentDeliveryConfigurations' => [
[
'BaseUrl' => '<string>',
'Name' => '<string>',
],
// ...
],
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- AccessConfiguration
-
- Type: AccessConfiguration structure
The access configuration for the source location.
- Arn
-
- Type: string
The ARN of the source location.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the source location was created.
- DefaultSegmentDeliveryConfiguration
-
- Type: DefaultSegmentDeliveryConfiguration structure
The default segment delivery configuration settings.
- HttpConfiguration
-
- Type: HttpConfiguration structure
The HTTP package configuration settings for the source location.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the source location was last modified.
- SegmentDeliveryConfigurations
-
- Type: Array of SegmentDeliveryConfiguration structures
A list of the segment delivery configurations associated with this resource.
- SourceLocationName
-
- Type: string
The name of the source location.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags assigned to the source location.
Errors
There are no errors described for this operation.
DescribeVodSource
$result = $client->describeVodSource([/* ... */]); $promise = $client->describeVodSourceAsync([/* ... */]);
Provides details about a specific VOD source in a specific source location.
Parameter Syntax
$result = $client->describeVodSource([
'SourceLocationName' => '<string>', // REQUIRED
'VodSourceName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'HttpPackageConfigurations' => [
[
'Path' => '<string>',
'SourceGroup' => '<string>',
'Type' => 'DASH|HLS',
],
// ...
],
'LastModifiedTime' => <DateTime>,
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
'VodSourceName' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the VOD source.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the VOD source was created.
- HttpPackageConfigurations
-
- Type: Array of HttpPackageConfiguration structures
The HTTP package configurations.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last modified time of the VOD source.
- SourceLocationName
-
- Type: string
The name of the source location associated with the VOD source.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags assigned to the VOD source.
- VodSourceName
-
- Type: string
The name of the VOD source.
Errors
There are no errors described for this operation.
GetChannelPolicy
$result = $client->getChannelPolicy([/* ... */]); $promise = $client->getChannelPolicyAsync([/* ... */]);
Retrieves information about a channel's IAM policy.
Parameter Syntax
$result = $client->getChannelPolicy([
'ChannelName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Policy' => '<string>',
]
Result Details
Errors
There are no errors described for this operation.
GetChannelSchedule
$result = $client->getChannelSchedule([/* ... */]); $promise = $client->getChannelScheduleAsync([/* ... */]);
Retrieves information about your channel's schedule.
Parameter Syntax
$result = $client->getChannelSchedule([
'ChannelName' => '<string>', // REQUIRED
'DurationMinutes' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Items' => [
[
'ApproximateDurationSeconds' => <integer>,
'ApproximateStartTime' => <DateTime>,
'Arn' => '<string>',
'ChannelName' => '<string>',
'LiveSourceName' => '<string>',
'ProgramName' => '<string>',
'ScheduleAdBreaks' => [
[
'ApproximateDurationSeconds' => <integer>,
'ApproximateStartTime' => <DateTime>,
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
// ...
],
'ScheduleEntryType' => 'PROGRAM|FILLER_SLATE',
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of ScheduleEntry structures
A list of schedule entries for the channel.
- NextToken
-
- Type: string
Pagination token from the GET list request. Use the token to fetch the next page of results.
Errors
There are no errors described for this operation.
GetPlaybackConfiguration
$result = $client->getPlaybackConfiguration([/* ... */]); $promise = $client->getPlaybackConfigurationAsync([/* ... */]);
Returns the playback configuration for the specified name.
Parameter Syntax
$result = $client->getPlaybackConfiguration([
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AdDecisionServerUrl' => '<string>',
'AvailSuppression' => [
'Mode' => 'OFF|BEHIND_LIVE_EDGE',
'Value' => '<string>',
],
'Bumper' => [
'EndUrl' => '<string>',
'StartUrl' => '<string>',
],
'CdnConfiguration' => [
'AdSegmentUrlPrefix' => '<string>',
'ContentSegmentUrlPrefix' => '<string>',
],
'ConfigurationAliases' => [
'<__string>' => ['<string>', ...],
// ...
],
'DashConfiguration' => [
'ManifestEndpointPrefix' => '<string>',
'MpdLocation' => '<string>',
'OriginManifestType' => 'SINGLE_PERIOD|MULTI_PERIOD',
],
'HlsConfiguration' => [
'ManifestEndpointPrefix' => '<string>',
],
'LivePreRollConfiguration' => [
'AdDecisionServerUrl' => '<string>',
'MaxDurationSeconds' => <integer>,
],
'LogConfiguration' => [
'PercentEnabled' => <integer>,
],
'ManifestProcessingRules' => [
'AdMarkerPassthrough' => [
'Enabled' => true || false,
],
],
'Name' => '<string>',
'PersonalizationThresholdSeconds' => <integer>,
'PlaybackConfigurationArn' => '<string>',
'PlaybackEndpointPrefix' => '<string>',
'SessionInitializationEndpointPrefix' => '<string>',
'SlateAdUrl' => '<string>',
'Tags' => ['<string>', ...],
'TranscodeProfileName' => '<string>',
'VideoContentSourceUrl' => '<string>',
]
Result Details
Members
- AdDecisionServerUrl
-
- Type: string
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
- AvailSuppression
-
- Type: AvailSuppression structure
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
- Bumper
-
- Type: Bumper structure
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
- CdnConfiguration
-
- Type: CdnConfiguration structure
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
- ConfigurationAliases
-
- Type: Associative array of custom strings keys (__string) to stringss
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
- DashConfiguration
-
- Type: DashConfiguration structure
The configuration for DASH content.
- HlsConfiguration
-
- Type: HlsConfiguration structure
The configuration for HLS content.
- LivePreRollConfiguration
-
- Type: LivePreRollConfiguration structure
The configuration for pre-roll ad insertion.
- LogConfiguration
-
- Type: LogConfiguration structure
The Amazon CloudWatch log settings for a playback configuration.
- ManifestProcessingRules
-
- Type: ManifestProcessingRules structure
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
- Name
-
- Type: string
The identifier for the playback configuration.
- PersonalizationThresholdSeconds
-
- Type: int
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
- PlaybackConfigurationArn
-
- Type: string
The Amazon Resource Name (ARN) for the playback configuration.
- PlaybackEndpointPrefix
-
- Type: string
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
- SessionInitializationEndpointPrefix
-
- Type: string
The URL that the player uses to initialize a session that uses client-side reporting.
- SlateAdUrl
-
- Type: string
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags assigned to the playback configuration.
- TranscodeProfileName
-
- Type: string
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
- VideoContentSourceUrl
-
- Type: string
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
Errors
There are no errors described for this operation.
GetPrefetchSchedule
$result = $client->getPrefetchSchedule([/* ... */]); $promise = $client->getPrefetchScheduleAsync([/* ... */]);
Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.
Parameter Syntax
$result = $client->getPrefetchSchedule([
'Name' => '<string>', // REQUIRED
'PlaybackConfigurationName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'Consumption' => [
'AvailMatchingCriteria' => [
[
'DynamicVariable' => '<string>',
'Operator' => 'EQUALS',
],
// ...
],
'EndTime' => <DateTime>,
'StartTime' => <DateTime>,
],
'Name' => '<string>',
'PlaybackConfigurationName' => '<string>',
'Retrieval' => [
'DynamicVariables' => ['<string>', ...],
'EndTime' => <DateTime>,
'StartTime' => <DateTime>,
],
'StreamId' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
- Consumption
-
- Type: PrefetchConsumption structure
A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
- Name
-
- Type: string
- PlaybackConfigurationName
-
- Type: string
- Retrieval
-
- Type: PrefetchRetrieval structure
A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
- StreamId
-
- Type: string
Errors
There are no errors described for this operation.
ListAlerts
$result = $client->listAlerts([/* ... */]); $promise = $client->listAlertsAsync([/* ... */]);
Returns a list of alerts for the given resource.
Parameter Syntax
$result = $client->listAlerts([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'AlertCode' => '<string>',
'AlertMessage' => '<string>',
'LastModifiedTime' => <DateTime>,
'RelatedResourceArns' => ['<string>', ...],
'ResourceArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Alert structures
A list of alerts that are associated with this resource.
- NextToken
-
- Type: string
Pagination token from the list request. Use the token to fetch the next page of results.
Errors
There are no errors described for this operation.
ListChannels
$result = $client->listChannels([/* ... */]); $promise = $client->listChannelsAsync([/* ... */]);
Retrieves a list of channels that are associated with this account.
Parameter Syntax
$result = $client->listChannels([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'Arn' => '<string>',
'ChannelName' => '<string>',
'ChannelState' => '<string>',
'CreationTime' => <DateTime>,
'FillerSlate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'LastModifiedTime' => <DateTime>,
'Outputs' => [
[
'DashPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
'MinBufferTimeSeconds' => <integer>,
'MinUpdatePeriodSeconds' => <integer>,
'SuggestedPresentationDelaySeconds' => <integer>,
],
'HlsPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
],
'ManifestName' => '<string>',
'PlaybackUrl' => '<string>',
'SourceGroup' => '<string>',
],
// ...
],
'PlaybackMode' => '<string>',
'Tags' => ['<string>', ...],
'Tier' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Channel structures
A list of channels that are associated with this account.
- NextToken
-
- Type: string
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
Errors
There are no errors described for this operation.
ListLiveSources
$result = $client->listLiveSources([/* ... */]); $promise = $client->listLiveSourcesAsync([/* ... */]);
lists all the live sources in a source location.
Parameter Syntax
$result = $client->listLiveSources([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SourceLocationName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'HttpPackageConfigurations' => [
[
'Path' => '<string>',
'SourceGroup' => '<string>',
'Type' => 'DASH|HLS',
],
// ...
],
'LastModifiedTime' => <DateTime>,
'LiveSourceName' => '<string>',
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of LiveSource structures
Lists the live sources.
- NextToken
-
- Type: string
Pagination token from the list request. Use the token to fetch the next page of results.
Errors
There are no errors described for this operation.
ListPlaybackConfigurations
$result = $client->listPlaybackConfigurations([/* ... */]); $promise = $client->listPlaybackConfigurationsAsync([/* ... */]);
Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.
Parameter Syntax
$result = $client->listPlaybackConfigurations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'AdDecisionServerUrl' => '<string>',
'AvailSuppression' => [
'Mode' => 'OFF|BEHIND_LIVE_EDGE',
'Value' => '<string>',
],
'Bumper' => [
'EndUrl' => '<string>',
'StartUrl' => '<string>',
],
'CdnConfiguration' => [
'AdSegmentUrlPrefix' => '<string>',
'ContentSegmentUrlPrefix' => '<string>',
],
'ConfigurationAliases' => [
'<__string>' => ['<string>', ...],
// ...
],
'DashConfiguration' => [
'ManifestEndpointPrefix' => '<string>',
'MpdLocation' => '<string>',
'OriginManifestType' => 'SINGLE_PERIOD|MULTI_PERIOD',
],
'HlsConfiguration' => [
'ManifestEndpointPrefix' => '<string>',
],
'LivePreRollConfiguration' => [
'AdDecisionServerUrl' => '<string>',
'MaxDurationSeconds' => <integer>,
],
'LogConfiguration' => [
'PercentEnabled' => <integer>,
],
'ManifestProcessingRules' => [
'AdMarkerPassthrough' => [
'Enabled' => true || false,
],
],
'Name' => '<string>',
'PersonalizationThresholdSeconds' => <integer>,
'PlaybackConfigurationArn' => '<string>',
'PlaybackEndpointPrefix' => '<string>',
'SessionInitializationEndpointPrefix' => '<string>',
'SlateAdUrl' => '<string>',
'Tags' => ['<string>', ...],
'TranscodeProfileName' => '<string>',
'VideoContentSourceUrl' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of PlaybackConfiguration structures
Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.
- NextToken
-
- Type: string
Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
Errors
There are no errors described for this operation.
ListPrefetchSchedules
$result = $client->listPrefetchSchedules([/* ... */]); $promise = $client->listPrefetchSchedulesAsync([/* ... */]);
Creates a new prefetch schedule.
Parameter Syntax
$result = $client->listPrefetchSchedules([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PlaybackConfigurationName' => '<string>', // REQUIRED
'StreamId' => '<string>',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If the playback configuration has more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.
- NextToken
-
- Type: string
(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.
For the first ListPrefetchSchedulesRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.
- PlaybackConfigurationName
-
- Required: Yes
- Type: string
- StreamId
-
- Type: string
An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
Result Syntax
[
'Items' => [
[
'Arn' => '<string>',
'Consumption' => [
'AvailMatchingCriteria' => [
[
'DynamicVariable' => '<string>',
'Operator' => 'EQUALS',
],
// ...
],
'EndTime' => <DateTime>,
'StartTime' => <DateTime>,
],
'Name' => '<string>',
'PlaybackConfigurationName' => '<string>',
'Retrieval' => [
'DynamicVariables' => ['<string>', ...],
'EndTime' => <DateTime>,
'StartTime' => <DateTime>,
],
'StreamId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of PrefetchSchedule structures
Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.
- NextToken
-
- Type: string
The value that you will use forNextToken in the next ListPrefetchSchedulesRequest request.
Errors
There are no errors described for this operation.
ListSourceLocations
$result = $client->listSourceLocations([/* ... */]); $promise = $client->listSourceLocationsAsync([/* ... */]);
Retrieves a list of source locations.
Parameter Syntax
$result = $client->listSourceLocations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'AccessConfiguration' => [
'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN',
'SecretsManagerAccessTokenConfiguration' => [
'HeaderName' => '<string>',
'SecretArn' => '<string>',
'SecretStringKey' => '<string>',
],
],
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'DefaultSegmentDeliveryConfiguration' => [
'BaseUrl' => '<string>',
],
'HttpConfiguration' => [
'BaseUrl' => '<string>',
],
'LastModifiedTime' => <DateTime>,
'SegmentDeliveryConfigurations' => [
[
'BaseUrl' => '<string>',
'Name' => '<string>',
],
// ...
],
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of SourceLocation structures
A list of source locations.
- NextToken
-
- Type: string
Pagination token from the list request. Use the token to fetch the next page of results.
Errors
There are no errors described for this operation.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Returns a list of the tags assigned to the specified playback configuration resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Errors
-
A request contains unexpected data.
ListVodSources
$result = $client->listVodSources([/* ... */]); $promise = $client->listVodSourcesAsync([/* ... */]);
Lists all the VOD sources in a source location.
Parameter Syntax
$result = $client->listVodSources([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SourceLocationName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'HttpPackageConfigurations' => [
[
'Path' => '<string>',
'SourceGroup' => '<string>',
'Type' => 'DASH|HLS',
],
// ...
],
'LastModifiedTime' => <DateTime>,
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
'VodSourceName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of VodSource structures
Lists the VOD sources.
- NextToken
-
- Type: string
Pagination token from the list request. Use the token to fetch the next page of results.
Errors
There are no errors described for this operation.
PutChannelPolicy
$result = $client->putChannelPolicy([/* ... */]); $promise = $client->putChannelPolicyAsync([/* ... */]);
Creates an IAM policy for the channel.
Parameter Syntax
$result = $client->putChannelPolicy([
'ChannelName' => '<string>', // REQUIRED
'Policy' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutPlaybackConfiguration
$result = $client->putPlaybackConfiguration([/* ... */]); $promise = $client->putPlaybackConfigurationAsync([/* ... */]);
Adds a new playback configuration to AWS Elemental MediaTailor.
Parameter Syntax
$result = $client->putPlaybackConfiguration([
'AdDecisionServerUrl' => '<string>',
'AvailSuppression' => [
'Mode' => 'OFF|BEHIND_LIVE_EDGE',
'Value' => '<string>',
],
'Bumper' => [
'EndUrl' => '<string>',
'StartUrl' => '<string>',
],
'CdnConfiguration' => [
'AdSegmentUrlPrefix' => '<string>',
'ContentSegmentUrlPrefix' => '<string>',
],
'ConfigurationAliases' => [
'<__string>' => ['<string>', ...],
// ...
],
'DashConfiguration' => [
'MpdLocation' => '<string>',
'OriginManifestType' => 'SINGLE_PERIOD|MULTI_PERIOD',
],
'LivePreRollConfiguration' => [
'AdDecisionServerUrl' => '<string>',
'MaxDurationSeconds' => <integer>,
],
'ManifestProcessingRules' => [
'AdMarkerPassthrough' => [
'Enabled' => true || false,
],
],
'Name' => '<string>',
'PersonalizationThresholdSeconds' => <integer>,
'SlateAdUrl' => '<string>',
'Tags' => ['<string>', ...],
'TranscodeProfileName' => '<string>',
'VideoContentSourceUrl' => '<string>',
]);
Parameter Details
Members
- AdDecisionServerUrl
-
- Type: string
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
- AvailSuppression
-
- Type: AvailSuppression structure
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
- Bumper
-
- Type: Bumper structure
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
- CdnConfiguration
-
- Type: CdnConfiguration structure
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
- ConfigurationAliases
-
- Type: Associative array of custom strings keys (__string) to stringss
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
- DashConfiguration
-
- Type: DashConfigurationForPut structure
The configuration for DASH content.
- LivePreRollConfiguration
-
- Type: LivePreRollConfiguration structure
The configuration for pre-roll ad insertion.
- ManifestProcessingRules
-
- Type: ManifestProcessingRules structure
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
- Name
-
- Type: string
The identifier for the playback configuration.
- PersonalizationThresholdSeconds
-
- Type: int
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
- SlateAdUrl
-
- Type: string
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags to assign to the playback configuration.
- TranscodeProfileName
-
- Type: string
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
- VideoContentSourceUrl
-
- Type: string
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
Result Syntax
[
'AdDecisionServerUrl' => '<string>',
'AvailSuppression' => [
'Mode' => 'OFF|BEHIND_LIVE_EDGE',
'Value' => '<string>',
],
'Bumper' => [
'EndUrl' => '<string>',
'StartUrl' => '<string>',
],
'CdnConfiguration' => [
'AdSegmentUrlPrefix' => '<string>',
'ContentSegmentUrlPrefix' => '<string>',
],
'ConfigurationAliases' => [
'<__string>' => ['<string>', ...],
// ...
],
'DashConfiguration' => [
'ManifestEndpointPrefix' => '<string>',
'MpdLocation' => '<string>',
'OriginManifestType' => 'SINGLE_PERIOD|MULTI_PERIOD',
],
'HlsConfiguration' => [
'ManifestEndpointPrefix' => '<string>',
],
'LivePreRollConfiguration' => [
'AdDecisionServerUrl' => '<string>',
'MaxDurationSeconds' => <integer>,
],
'LogConfiguration' => [
'PercentEnabled' => <integer>,
],
'ManifestProcessingRules' => [
'AdMarkerPassthrough' => [
'Enabled' => true || false,
],
],
'Name' => '<string>',
'PersonalizationThresholdSeconds' => <integer>,
'PlaybackConfigurationArn' => '<string>',
'PlaybackEndpointPrefix' => '<string>',
'SessionInitializationEndpointPrefix' => '<string>',
'SlateAdUrl' => '<string>',
'Tags' => ['<string>', ...],
'TranscodeProfileName' => '<string>',
'VideoContentSourceUrl' => '<string>',
]
Result Details
Members
- AdDecisionServerUrl
-
- Type: string
- AvailSuppression
-
- Type: AvailSuppression structure
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
- Bumper
-
- Type: Bumper structure
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
- CdnConfiguration
-
- Type: CdnConfiguration structure
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
- ConfigurationAliases
-
- Type: Associative array of custom strings keys (__string) to stringss
The predefined aliases for dynamic variables.
- DashConfiguration
-
- Type: DashConfiguration structure
The configuration for DASH content.
- HlsConfiguration
-
- Type: HlsConfiguration structure
The configuration for HLS content.
- LivePreRollConfiguration
-
- Type: LivePreRollConfiguration structure
The configuration for pre-roll ad insertion.
- LogConfiguration
-
- Type: LogConfiguration structure
Returns Amazon CloudWatch log settings for a playback configuration.
- ManifestProcessingRules
-
- Type: ManifestProcessingRules structure
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
- Name
-
- Type: string
- PersonalizationThresholdSeconds
-
- Type: int
- PlaybackConfigurationArn
-
- Type: string
- PlaybackEndpointPrefix
-
- Type: string
- SessionInitializationEndpointPrefix
-
- Type: string
- SlateAdUrl
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- TranscodeProfileName
-
- Type: string
- VideoContentSourceUrl
-
- Type: string
Errors
There are no errors described for this operation.
StartChannel
$result = $client->startChannel([/* ... */]); $promise = $client->startChannelAsync([/* ... */]);
Starts a specific channel.
Parameter Syntax
$result = $client->startChannel([
'ChannelName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
StopChannel
$result = $client->stopChannel([/* ... */]); $promise = $client->stopChannelAsync([/* ... */]);
Stops a specific channel.
Parameter Syntax
$result = $client->stopChannel([
'ChannelName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
A request contains unexpected data.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
A request contains unexpected data.
UpdateChannel
$result = $client->updateChannel([/* ... */]); $promise = $client->updateChannelAsync([/* ... */]);
Updates an existing channel.
Parameter Syntax
$result = $client->updateChannel([
'ChannelName' => '<string>', // REQUIRED
'FillerSlate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'Outputs' => [ // REQUIRED
[
'DashPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
'MinBufferTimeSeconds' => <integer>,
'MinUpdatePeriodSeconds' => <integer>,
'SuggestedPresentationDelaySeconds' => <integer>,
],
'HlsPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
],
'ManifestName' => '<string>', // REQUIRED
'SourceGroup' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ChannelName
-
- Required: Yes
- Type: string
- FillerSlate
-
- Type: SlateSource structure
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
- Outputs
-
- Required: Yes
- Type: Array of RequestOutputItem structures
The channel's output properties.
Result Syntax
[
'Arn' => '<string>',
'ChannelName' => '<string>',
'ChannelState' => 'RUNNING|STOPPED',
'CreationTime' => <DateTime>,
'FillerSlate' => [
'SourceLocationName' => '<string>',
'VodSourceName' => '<string>',
],
'LastModifiedTime' => <DateTime>,
'Outputs' => [
[
'DashPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
'MinBufferTimeSeconds' => <integer>,
'MinUpdatePeriodSeconds' => <integer>,
'SuggestedPresentationDelaySeconds' => <integer>,
],
'HlsPlaylistSettings' => [
'ManifestWindowSeconds' => <integer>,
],
'ManifestName' => '<string>',
'PlaybackUrl' => '<string>',
'SourceGroup' => '<string>',
],
// ...
],
'PlaybackMode' => '<string>',
'Tags' => ['<string>', ...],
'Tier' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
- ChannelName
-
- Type: string
- ChannelState
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- FillerSlate
-
- Type: SlateSource structure
Slate VOD source configuration.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Outputs
-
- Type: Array of ResponseOutputItem structures
- PlaybackMode
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- Tier
-
- Type: string
Errors
There are no errors described for this operation.
UpdateLiveSource
$result = $client->updateLiveSource([/* ... */]); $promise = $client->updateLiveSourceAsync([/* ... */]);
Updates a specific live source in a specific source location.
Parameter Syntax
$result = $client->updateLiveSource([
'HttpPackageConfigurations' => [ // REQUIRED
[
'Path' => '<string>', // REQUIRED
'SourceGroup' => '<string>', // REQUIRED
'Type' => 'DASH|HLS', // REQUIRED
],
// ...
],
'LiveSourceName' => '<string>', // REQUIRED
'SourceLocationName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- HttpPackageConfigurations
-
- Required: Yes
- Type: Array of HttpPackageConfiguration structures
A list of HTTP package configurations for the live source on this account.
- LiveSourceName
-
- Required: Yes
- Type: string
- SourceLocationName
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'HttpPackageConfigurations' => [
[
'Path' => '<string>',
'SourceGroup' => '<string>',
'Type' => 'DASH|HLS',
],
// ...
],
'LastModifiedTime' => <DateTime>,
'LiveSourceName' => '<string>',
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- Arn
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- HttpPackageConfigurations
-
- Type: Array of HttpPackageConfiguration structures
The VOD source's HTTP package configuration settings.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- LiveSourceName
-
- Type: string
- SourceLocationName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
There are no errors described for this operation.
UpdateSourceLocation
$result = $client->updateSourceLocation([/* ... */]); $promise = $client->updateSourceLocationAsync([/* ... */]);
Updates a source location on a specific channel.
Parameter Syntax
$result = $client->updateSourceLocation([
'AccessConfiguration' => [
'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN',
'SecretsManagerAccessTokenConfiguration' => [
'HeaderName' => '<string>',
'SecretArn' => '<string>',
'SecretStringKey' => '<string>',
],
],
'DefaultSegmentDeliveryConfiguration' => [
'BaseUrl' => '<string>',
],
'HttpConfiguration' => [ // REQUIRED
'BaseUrl' => '<string>', // REQUIRED
],
'SegmentDeliveryConfigurations' => [
[
'BaseUrl' => '<string>',
'Name' => '<string>',
],
// ...
],
'SourceLocationName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AccessConfiguration
-
- Type: AccessConfiguration structure
Access configuration parameters. Configures the type of authentication used to access content from your source location.
- DefaultSegmentDeliveryConfiguration
-
- Type: DefaultSegmentDeliveryConfiguration structure
The optional configuration for the host server that serves segments.
- HttpConfiguration
-
- Required: Yes
- Type: HttpConfiguration structure
The HTTP configuration for the source location.
- SegmentDeliveryConfigurations
-
- Type: Array of SegmentDeliveryConfiguration structures
A list of the segment delivery configurations associated with this resource.
- SourceLocationName
-
- Required: Yes
- Type: string
Result Syntax
[
'AccessConfiguration' => [
'AccessType' => 'S3_SIGV4|SECRETS_MANAGER_ACCESS_TOKEN',
'SecretsManagerAccessTokenConfiguration' => [
'HeaderName' => '<string>',
'SecretArn' => '<string>',
'SecretStringKey' => '<string>',
],
],
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'DefaultSegmentDeliveryConfiguration' => [
'BaseUrl' => '<string>',
],
'HttpConfiguration' => [
'BaseUrl' => '<string>',
],
'LastModifiedTime' => <DateTime>,
'SegmentDeliveryConfigurations' => [
[
'BaseUrl' => '<string>',
'Name' => '<string>',
],
// ...
],
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
- AccessConfiguration
-
- Type: AccessConfiguration structure
Access configuration parameters.
- Arn
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DefaultSegmentDeliveryConfiguration
-
- Type: DefaultSegmentDeliveryConfiguration structure
The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.
- HttpConfiguration
-
- Type: HttpConfiguration structure
The HTTP configuration for the source location.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SegmentDeliveryConfigurations
-
- Type: Array of SegmentDeliveryConfiguration structures
- SourceLocationName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Errors
There are no errors described for this operation.
UpdateVodSource
$result = $client->updateVodSource([/* ... */]); $promise = $client->updateVodSourceAsync([/* ... */]);
Updates a specific VOD source in a specific source location.
Parameter Syntax
$result = $client->updateVodSource([
'HttpPackageConfigurations' => [ // REQUIRED
[
'Path' => '<string>', // REQUIRED
'SourceGroup' => '<string>', // REQUIRED
'Type' => 'DASH|HLS', // REQUIRED
],
// ...
],
'SourceLocationName' => '<string>', // REQUIRED
'VodSourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- HttpPackageConfigurations
-
- Required: Yes
- Type: Array of HttpPackageConfiguration structures
A list of HTTP package configurations for the VOD source on this account.
- SourceLocationName
-
- Required: Yes
- Type: string
- VodSourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreationTime' => <DateTime>,
'HttpPackageConfigurations' => [
[
'Path' => '<string>',
'SourceGroup' => '<string>',
'Type' => 'DASH|HLS',
],
// ...
],
'LastModifiedTime' => <DateTime>,
'SourceLocationName' => '<string>',
'Tags' => ['<string>', ...],
'VodSourceName' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- HttpPackageConfigurations
-
- Type: Array of HttpPackageConfiguration structures
The VOD source's HTTP package configuration settings.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- SourceLocationName
-
- Type: string
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
- VodSourceName
-
- Type: string
Errors
There are no errors described for this operation.
Shapes
AccessConfiguration
Description
Access configuration parameters.
Members
- AccessType
-
- Type: string
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
- SecretsManagerAccessTokenConfiguration
-
- Type: SecretsManagerAccessTokenConfiguration structure
AWS Secrets Manager access token configuration parameters.
AdBreak
Description
Ad break configuration parameters.
Members
- MessageType
-
- Type: string
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.
- OffsetMillis
-
- Type: long (int|float)
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
- Slate
-
- Type: SlateSource structure
Ad break slate configuration.
- SpliceInsertMessage
-
- Type: SpliceInsertMessage structure
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AdMarkerPassthrough
Description
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
Members
Alert
Description
Alert configuration parameters.
Members
- AlertCode
-
- Required: Yes
- Type: string
The code for the alert. For example, NOT_PROCESSED.
- AlertMessage
-
- Required: Yes
- Type: string
If an alert is generated for a resource, an explanation of the reason for the alert.
- LastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the alert was last modified.
- RelatedResourceArns
-
- Required: Yes
- Type: Array of strings
The Amazon Resource Names (ARNs) related to this alert.
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
AvailMatchingCriteria
Description
MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.
Members
- DynamicVariable
-
- Required: Yes
- Type: string
The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
You can include up to 100 dynamic variables.
- Operator
-
- Required: Yes
- Type: string
For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
AvailSuppression
Description
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Members
- Mode
-
- Type: string
Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
- Value
-
- Type: string
A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.
BadRequestException
Description
A request contains unexpected data.
Members
Bumper
Description
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
Members
CdnConfiguration
Description
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Members
- AdSegmentUrlPrefix
-
- Type: string
A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
- ContentSegmentUrlPrefix
-
- Type: string
A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.
Channel
Description
The configuration parameters for a channel.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChannelName
-
- Required: Yes
- Type: string
The name of the channel.
- ChannelState
-
- Required: Yes
- Type: string
Returns the state whether the channel is running or not.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the channel was created.
- FillerSlate
-
- Type: SlateSource structure
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of when the channel was last modified.
- Outputs
-
- Required: Yes
- Type: Array of ResponseOutputItem structures
The channel's output properties.
- PlaybackMode
-
- Required: Yes
- Type: string
The type of playback mode for this channel.
LINEAR - Programs play back-to-back only once.
LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags to assign to the channel.
- Tier
-
- Required: Yes
- Type: string
The tier for this channel. STANDARD tier channels can contain live programs.
DashConfiguration
Description
The configuration for DASH content.
Members
- ManifestEndpointPrefix
-
- Type: string
The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
- MpdLocation
-
- Type: string
The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
- OriginManifestType
-
- Type: string
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
DashConfigurationForPut
Description
The configuration for DASH PUT operations.
Members
- MpdLocation
-
- Type: string
The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
- OriginManifestType
-
- Type: string
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
DashPlaylistSettings
Description
Dash manifest configuration parameters.
Members
- ManifestWindowSeconds
-
- Type: int
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
- MinBufferTimeSeconds
-
- Type: int
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
- MinUpdatePeriodSeconds
-
- Type: int
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
- SuggestedPresentationDelaySeconds
-
- Type: int
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
DefaultSegmentDeliveryConfiguration
Description
The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.
Members
HlsConfiguration
Description
The configuration for HLS content.
Members
HlsPlaylistSettings
Description
HLS playlist configuration parameters.
Members
HttpConfiguration
Description
The HTTP configuration for the source location.
Members
HttpPackageConfiguration
Description
The HTTP package configuration properties for the requested VOD source.
Members
- Path
-
- Required: Yes
- Type: string
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
- SourceGroup
-
- Required: Yes
- Type: string
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
- Type
-
- Required: Yes
- Type: string
The streaming protocol for this package configuration. Supported values are HLS and DASH.
LivePreRollConfiguration
Description
The configuration for pre-roll ad insertion.
Members
- AdDecisionServerUrl
-
- Type: string
The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
- MaxDurationSeconds
-
- Type: int
The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
LiveSource
Description
Live source configuration parameters.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN for the live source.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the live source was created.
- HttpPackageConfigurations
-
- Required: Yes
- Type: Array of HttpPackageConfiguration structures
The HTTP package configurations for the live source.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the live source was last modified.
- LiveSourceName
-
- Required: Yes
- Type: string
The name that's used to refer to a live source.
- SourceLocationName
-
- Required: Yes
- Type: string
The name of the source location.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags assigned to the live source.
LogConfiguration
Description
Returns Amazon CloudWatch log settings for a playback configuration.
Members
- PercentEnabled
-
- Required: Yes
- Type: int
The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100
ManifestProcessingRules
Description
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
Members
- AdMarkerPassthrough
-
- Type: AdMarkerPassthrough structure
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
PlaybackConfiguration
Description
Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
Members
- AdDecisionServerUrl
-
- Type: string
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
- AvailSuppression
-
- Type: AvailSuppression structure
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
- Bumper
-
- Type: Bumper structure
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
- CdnConfiguration
-
- Type: CdnConfiguration structure
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
- ConfigurationAliases
-
- Type: Associative array of custom strings keys (__string) to stringss
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
- DashConfiguration
-
- Type: DashConfiguration structure
The configuration for a DASH source.
- HlsConfiguration
-
- Type: HlsConfiguration structure
The configuration for HLS content.
- LivePreRollConfiguration
-
- Type: LivePreRollConfiguration structure
The configuration for pre-roll ad insertion.
- LogConfiguration
-
- Type: LogConfiguration structure
The Amazon CloudWatch log settings for a playback configuration.
- ManifestProcessingRules
-
- Type: ManifestProcessingRules structure
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
- Name
-
- Type: string
The identifier for the playback configuration.
- PersonalizationThresholdSeconds
-
- Type: int
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
- PlaybackConfigurationArn
-
- Type: string
The Amazon Resource Name (ARN) for the playback configuration.
- PlaybackEndpointPrefix
-
- Type: string
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
- SessionInitializationEndpointPrefix
-
- Type: string
The URL that the player uses to initialize a session that uses client-side reporting.
- SlateAdUrl
-
- Type: string
The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags to assign to the playback configuration.
- TranscodeProfileName
-
- Type: string
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
- VideoContentSourceUrl
-
- Type: string
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
PrefetchConsumption
Description
A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
Members
- AvailMatchingCriteria
-
- Type: Array of AvailMatchingCriteria structures
If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
PrefetchRetrieval
Description
A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
Members
- DynamicVariables
-
- Type: Associative array of custom strings keys (__string) to strings
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
PrefetchSchedule
Description
A complex type that contains prefetch schedule information.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the prefetch schedule.
- Consumption
-
- Required: Yes
- Type: PrefetchConsumption structure
Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
- Name
-
- Required: Yes
- Type: string
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
- PlaybackConfigurationName
-
- Required: Yes
- Type: string
The name of the playback configuration to create the prefetch schedule for.
- Retrieval
-
- Required: Yes
- Type: PrefetchRetrieval structure
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
- StreamId
-
- Type: string
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
RequestOutputItem
Description
The output configuration for this channel.
Members
- DashPlaylistSettings
-
- Type: DashPlaylistSettings structure
DASH manifest configuration parameters.
- HlsPlaylistSettings
-
- Type: HlsPlaylistSettings structure
HLS playlist configuration parameters.
- ManifestName
-
- Required: Yes
- Type: string
The name of the manifest for the channel. The name appears in the PlaybackUrl.
- SourceGroup
-
- Required: Yes
- Type: string
A string used to match which HttpPackageConfiguration is used for each VodSource.
ResponseOutputItem
Description
This response includes only the "property" : "type" property.
Members
- DashPlaylistSettings
-
- Type: DashPlaylistSettings structure
DASH manifest configuration settings.
- HlsPlaylistSettings
-
- Type: HlsPlaylistSettings structure
HLS manifest configuration settings.
- ManifestName
-
- Required: Yes
- Type: string
The name of the manifest for the channel that will appear in the channel output's playback URL.
- PlaybackUrl
-
- Required: Yes
- Type: string
The URL used for playback by content players.
- SourceGroup
-
- Required: Yes
- Type: string
A string used to associate a package configuration source group with a channel output.
ScheduleAdBreak
Description
The schedule's ad break properties.
Members
- ApproximateDurationSeconds
-
- Type: long (int|float)
The approximate duration of the ad break, in seconds.
- ApproximateStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The approximate time that the ad will start playing.
- SourceLocationName
-
- Type: string
The name of the source location containing the VOD source used for the ad break.
- VodSourceName
-
- Type: string
The name of the VOD source used for the ad break.
ScheduleConfiguration
Description
Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
Members
- Transition
-
- Required: Yes
- Type: Transition structure
Program transition configurations.
ScheduleEntry
Description
The properties for a schedule.
Members
- ApproximateDurationSeconds
-
- Type: long (int|float)
The approximate duration of this program, in seconds.
- ApproximateStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The approximate time that the program will start playing.
- Arn
-
- Required: Yes
- Type: string
The ARN of the program.
- ChannelName
-
- Required: Yes
- Type: string
The name of the channel that uses this schedule.
- LiveSourceName
-
- Type: string
The name of the live source used for the program.
- ProgramName
-
- Required: Yes
- Type: string
The name of the program.
- ScheduleAdBreaks
-
- Type: Array of ScheduleAdBreak structures
The schedule's ad break properties.
- ScheduleEntryType
-
- Type: string
The type of schedule entry.
Valid values: PROGRAM or FILLER_SLATE.
- SourceLocationName
-
- Required: Yes
- Type: string
The name of the source location.
- VodSourceName
-
- Type: string
The name of the VOD source.
SecretsManagerAccessTokenConfiguration
Description
AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.
Members
- HeaderName
-
- Type: string
The name of the HTTP header used to supply the access token in requests to the source location.
- SecretArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.
- SecretStringKey
-
- Type: string
The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.
SegmentDeliveryConfiguration
Description
The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.
Members
- BaseUrl
-
- Type: string
The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.
- Name
-
- Type: string
A unique identifier used to distinguish between multiple segment delivery configurations in a source location.
SlateSource
Description
Slate VOD source configuration.
Members
SourceLocation
Description
This response includes only the "type" : "object" property.
Members
- AccessConfiguration
-
- Type: AccessConfiguration structure
The access configuration for the source location.
- Arn
-
- Required: Yes
- Type: string
The ARN of the SourceLocation.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the source location was created.
- DefaultSegmentDeliveryConfiguration
-
- Type: DefaultSegmentDeliveryConfiguration structure
The default segment delivery configuration.
- HttpConfiguration
-
- Required: Yes
- Type: HttpConfiguration structure
The HTTP configuration for the source location.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the source location was last modified.
- SegmentDeliveryConfigurations
-
- Type: Array of SegmentDeliveryConfiguration structures
The segment delivery configurations for the source location.
- SourceLocationName
-
- Required: Yes
- Type: string
The name of the source location.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags assigned to the source location.
SpliceInsertMessage
Description
Splice insert message configuration.
Members
- AvailNum
-
- Type: int
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
- AvailsExpected
-
- Type: int
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
- SpliceEventId
-
- Type: int
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
- UniqueProgramId
-
- Type: int
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
Transition
Description
Program transition configuration.
Members
- DurationMillis
-
- Type: long (int|float)
The duration of the live program in seconds.
- RelativePosition
-
- Required: Yes
- Type: string
The position where this program will be inserted relative to the RelativePosition.
- RelativeProgram
-
- Type: string
The name of the program that this program will be inserted next to, as defined by RelativePosition.
- ScheduledStartTimeMillis
-
- Type: long (int|float)
The date and time that the program is scheduled to start, in epoch milliseconds.
- Type
-
- Required: Yes
- Type: string
Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
VodSource
Description
VOD source configuration parameters.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN for the VOD source.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the VOD source was created.
- HttpPackageConfigurations
-
- Required: Yes
- Type: Array of HttpPackageConfiguration structures
The HTTP package configurations for the VOD source.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that indicates when the VOD source was last modified.
- SourceLocationName
-
- Required: Yes
- Type: string
The name of the source location that the VOD source is associated with.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags assigned to the VOD source.
- VodSourceName
-
- Required: Yes
- Type: string
The name of the VOD source.