aws-sdk
Version:
AWS SDK for JavaScript
806 lines • 134 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class MediaTailor extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: MediaTailor.Types.ClientConfiguration)
config: Config & MediaTailor.Types.ClientConfiguration;
/**
* Configures Amazon CloudWatch log settings for a channel.
*/
configureLogsForChannel(params: MediaTailor.Types.ConfigureLogsForChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.ConfigureLogsForChannelResponse) => void): Request<MediaTailor.Types.ConfigureLogsForChannelResponse, AWSError>;
/**
* Configures Amazon CloudWatch log settings for a channel.
*/
configureLogsForChannel(callback?: (err: AWSError, data: MediaTailor.Types.ConfigureLogsForChannelResponse) => void): Request<MediaTailor.Types.ConfigureLogsForChannelResponse, AWSError>;
/**
* Amazon CloudWatch log settings for a playback configuration.
*/
configureLogsForPlaybackConfiguration(params: MediaTailor.Types.ConfigureLogsForPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.ConfigureLogsForPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.ConfigureLogsForPlaybackConfigurationResponse, AWSError>;
/**
* Amazon CloudWatch log settings for a playback configuration.
*/
configureLogsForPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.ConfigureLogsForPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.ConfigureLogsForPlaybackConfigurationResponse, AWSError>;
/**
* Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
createChannel(params: MediaTailor.Types.CreateChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateChannelResponse) => void): Request<MediaTailor.Types.CreateChannelResponse, AWSError>;
/**
* Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
createChannel(callback?: (err: AWSError, data: MediaTailor.Types.CreateChannelResponse) => void): Request<MediaTailor.Types.CreateChannelResponse, AWSError>;
/**
* The live source configuration.
*/
createLiveSource(params: MediaTailor.Types.CreateLiveSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateLiveSourceResponse) => void): Request<MediaTailor.Types.CreateLiveSourceResponse, AWSError>;
/**
* The live source configuration.
*/
createLiveSource(callback?: (err: AWSError, data: MediaTailor.Types.CreateLiveSourceResponse) => void): Request<MediaTailor.Types.CreateLiveSourceResponse, AWSError>;
/**
* Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
*/
createPrefetchSchedule(params: MediaTailor.Types.CreatePrefetchScheduleRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreatePrefetchScheduleResponse) => void): Request<MediaTailor.Types.CreatePrefetchScheduleResponse, AWSError>;
/**
* Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
*/
createPrefetchSchedule(callback?: (err: AWSError, data: MediaTailor.Types.CreatePrefetchScheduleResponse) => void): Request<MediaTailor.Types.CreatePrefetchScheduleResponse, AWSError>;
/**
* Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
*/
createProgram(params: MediaTailor.Types.CreateProgramRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateProgramResponse) => void): Request<MediaTailor.Types.CreateProgramResponse, AWSError>;
/**
* Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
*/
createProgram(callback?: (err: AWSError, data: MediaTailor.Types.CreateProgramResponse) => void): Request<MediaTailor.Types.CreateProgramResponse, AWSError>;
/**
* Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
*/
createSourceLocation(params: MediaTailor.Types.CreateSourceLocationRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateSourceLocationResponse) => void): Request<MediaTailor.Types.CreateSourceLocationResponse, AWSError>;
/**
* Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
*/
createSourceLocation(callback?: (err: AWSError, data: MediaTailor.Types.CreateSourceLocationResponse) => void): Request<MediaTailor.Types.CreateSourceLocationResponse, AWSError>;
/**
* The VOD source configuration parameters.
*/
createVodSource(params: MediaTailor.Types.CreateVodSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateVodSourceResponse) => void): Request<MediaTailor.Types.CreateVodSourceResponse, AWSError>;
/**
* The VOD source configuration parameters.
*/
createVodSource(callback?: (err: AWSError, data: MediaTailor.Types.CreateVodSourceResponse) => void): Request<MediaTailor.Types.CreateVodSourceResponse, AWSError>;
/**
* Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
deleteChannel(params: MediaTailor.Types.DeleteChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteChannelResponse) => void): Request<MediaTailor.Types.DeleteChannelResponse, AWSError>;
/**
* Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
deleteChannel(callback?: (err: AWSError, data: MediaTailor.Types.DeleteChannelResponse) => void): Request<MediaTailor.Types.DeleteChannelResponse, AWSError>;
/**
* The channel policy to delete.
*/
deleteChannelPolicy(params: MediaTailor.Types.DeleteChannelPolicyRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteChannelPolicyResponse) => void): Request<MediaTailor.Types.DeleteChannelPolicyResponse, AWSError>;
/**
* The channel policy to delete.
*/
deleteChannelPolicy(callback?: (err: AWSError, data: MediaTailor.Types.DeleteChannelPolicyResponse) => void): Request<MediaTailor.Types.DeleteChannelPolicyResponse, AWSError>;
/**
* The live source to delete.
*/
deleteLiveSource(params: MediaTailor.Types.DeleteLiveSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteLiveSourceResponse) => void): Request<MediaTailor.Types.DeleteLiveSourceResponse, AWSError>;
/**
* The live source to delete.
*/
deleteLiveSource(callback?: (err: AWSError, data: MediaTailor.Types.DeleteLiveSourceResponse) => void): Request<MediaTailor.Types.DeleteLiveSourceResponse, AWSError>;
/**
* Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
*/
deletePlaybackConfiguration(params: MediaTailor.Types.DeletePlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeletePlaybackConfigurationResponse) => void): Request<MediaTailor.Types.DeletePlaybackConfigurationResponse, AWSError>;
/**
* Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
*/
deletePlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.DeletePlaybackConfigurationResponse) => void): Request<MediaTailor.Types.DeletePlaybackConfigurationResponse, AWSError>;
/**
* 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. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
*/
deletePrefetchSchedule(params: MediaTailor.Types.DeletePrefetchScheduleRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeletePrefetchScheduleResponse) => void): Request<MediaTailor.Types.DeletePrefetchScheduleResponse, AWSError>;
/**
* 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. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
*/
deletePrefetchSchedule(callback?: (err: AWSError, data: MediaTailor.Types.DeletePrefetchScheduleResponse) => void): Request<MediaTailor.Types.DeletePrefetchScheduleResponse, AWSError>;
/**
* Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
*/
deleteProgram(params: MediaTailor.Types.DeleteProgramRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteProgramResponse) => void): Request<MediaTailor.Types.DeleteProgramResponse, AWSError>;
/**
* Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
*/
deleteProgram(callback?: (err: AWSError, data: MediaTailor.Types.DeleteProgramResponse) => void): Request<MediaTailor.Types.DeleteProgramResponse, AWSError>;
/**
* Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
*/
deleteSourceLocation(params: MediaTailor.Types.DeleteSourceLocationRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteSourceLocationResponse) => void): Request<MediaTailor.Types.DeleteSourceLocationResponse, AWSError>;
/**
* Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
*/
deleteSourceLocation(callback?: (err: AWSError, data: MediaTailor.Types.DeleteSourceLocationResponse) => void): Request<MediaTailor.Types.DeleteSourceLocationResponse, AWSError>;
/**
* The video on demand (VOD) source to delete.
*/
deleteVodSource(params: MediaTailor.Types.DeleteVodSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteVodSourceResponse) => void): Request<MediaTailor.Types.DeleteVodSourceResponse, AWSError>;
/**
* The video on demand (VOD) source to delete.
*/
deleteVodSource(callback?: (err: AWSError, data: MediaTailor.Types.DeleteVodSourceResponse) => void): Request<MediaTailor.Types.DeleteVodSourceResponse, AWSError>;
/**
* Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
describeChannel(params: MediaTailor.Types.DescribeChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.DescribeChannelResponse) => void): Request<MediaTailor.Types.DescribeChannelResponse, AWSError>;
/**
* Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
describeChannel(callback?: (err: AWSError, data: MediaTailor.Types.DescribeChannelResponse) => void): Request<MediaTailor.Types.DescribeChannelResponse, AWSError>;
/**
* The live source to describe.
*/
describeLiveSource(params: MediaTailor.Types.DescribeLiveSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.DescribeLiveSourceResponse) => void): Request<MediaTailor.Types.DescribeLiveSourceResponse, AWSError>;
/**
* The live source to describe.
*/
describeLiveSource(callback?: (err: AWSError, data: MediaTailor.Types.DescribeLiveSourceResponse) => void): Request<MediaTailor.Types.DescribeLiveSourceResponse, AWSError>;
/**
* Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
*/
describeProgram(params: MediaTailor.Types.DescribeProgramRequest, callback?: (err: AWSError, data: MediaTailor.Types.DescribeProgramResponse) => void): Request<MediaTailor.Types.DescribeProgramResponse, AWSError>;
/**
* Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
*/
describeProgram(callback?: (err: AWSError, data: MediaTailor.Types.DescribeProgramResponse) => void): Request<MediaTailor.Types.DescribeProgramResponse, AWSError>;
/**
* Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
*/
describeSourceLocation(params: MediaTailor.Types.DescribeSourceLocationRequest, callback?: (err: AWSError, data: MediaTailor.Types.DescribeSourceLocationResponse) => void): Request<MediaTailor.Types.DescribeSourceLocationResponse, AWSError>;
/**
* Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
*/
describeSourceLocation(callback?: (err: AWSError, data: MediaTailor.Types.DescribeSourceLocationResponse) => void): Request<MediaTailor.Types.DescribeSourceLocationResponse, AWSError>;
/**
* Provides details about a specific video on demand (VOD) source in a specific source location.
*/
describeVodSource(params: MediaTailor.Types.DescribeVodSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.DescribeVodSourceResponse) => void): Request<MediaTailor.Types.DescribeVodSourceResponse, AWSError>;
/**
* Provides details about a specific video on demand (VOD) source in a specific source location.
*/
describeVodSource(callback?: (err: AWSError, data: MediaTailor.Types.DescribeVodSourceResponse) => void): Request<MediaTailor.Types.DescribeVodSourceResponse, AWSError>;
/**
* Returns the channel's IAM policy. IAM policies are used to control access to your channel.
*/
getChannelPolicy(params: MediaTailor.Types.GetChannelPolicyRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetChannelPolicyResponse) => void): Request<MediaTailor.Types.GetChannelPolicyResponse, AWSError>;
/**
* Returns the channel's IAM policy. IAM policies are used to control access to your channel.
*/
getChannelPolicy(callback?: (err: AWSError, data: MediaTailor.Types.GetChannelPolicyResponse) => void): Request<MediaTailor.Types.GetChannelPolicyResponse, AWSError>;
/**
* Retrieves information about your channel's schedule.
*/
getChannelSchedule(params: MediaTailor.Types.GetChannelScheduleRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetChannelScheduleResponse) => void): Request<MediaTailor.Types.GetChannelScheduleResponse, AWSError>;
/**
* Retrieves information about your channel's schedule.
*/
getChannelSchedule(callback?: (err: AWSError, data: MediaTailor.Types.GetChannelScheduleResponse) => void): Request<MediaTailor.Types.GetChannelScheduleResponse, AWSError>;
/**
* Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
*/
getPlaybackConfiguration(params: MediaTailor.Types.GetPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.GetPlaybackConfigurationResponse, AWSError>;
/**
* Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
*/
getPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.GetPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.GetPlaybackConfigurationResponse, AWSError>;
/**
* Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
*/
getPrefetchSchedule(params: MediaTailor.Types.GetPrefetchScheduleRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetPrefetchScheduleResponse) => void): Request<MediaTailor.Types.GetPrefetchScheduleResponse, AWSError>;
/**
* Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
*/
getPrefetchSchedule(callback?: (err: AWSError, data: MediaTailor.Types.GetPrefetchScheduleResponse) => void): Request<MediaTailor.Types.GetPrefetchScheduleResponse, AWSError>;
/**
* Lists the alerts that are associated with a MediaTailor channel assembly resource.
*/
listAlerts(params: MediaTailor.Types.ListAlertsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListAlertsResponse) => void): Request<MediaTailor.Types.ListAlertsResponse, AWSError>;
/**
* Lists the alerts that are associated with a MediaTailor channel assembly resource.
*/
listAlerts(callback?: (err: AWSError, data: MediaTailor.Types.ListAlertsResponse) => void): Request<MediaTailor.Types.ListAlertsResponse, AWSError>;
/**
* Retrieves information about the channels that are associated with the current AWS account.
*/
listChannels(params: MediaTailor.Types.ListChannelsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListChannelsResponse) => void): Request<MediaTailor.Types.ListChannelsResponse, AWSError>;
/**
* Retrieves information about the channels that are associated with the current AWS account.
*/
listChannels(callback?: (err: AWSError, data: MediaTailor.Types.ListChannelsResponse) => void): Request<MediaTailor.Types.ListChannelsResponse, AWSError>;
/**
* Lists the live sources contained in a source location. A source represents a piece of content.
*/
listLiveSources(params: MediaTailor.Types.ListLiveSourcesRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListLiveSourcesResponse) => void): Request<MediaTailor.Types.ListLiveSourcesResponse, AWSError>;
/**
* Lists the live sources contained in a source location. A source represents a piece of content.
*/
listLiveSources(callback?: (err: AWSError, data: MediaTailor.Types.ListLiveSourcesResponse) => void): Request<MediaTailor.Types.ListLiveSourcesResponse, AWSError>;
/**
* Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.
*/
listPlaybackConfigurations(params: MediaTailor.Types.ListPlaybackConfigurationsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListPlaybackConfigurationsResponse) => void): Request<MediaTailor.Types.ListPlaybackConfigurationsResponse, AWSError>;
/**
* Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.
*/
listPlaybackConfigurations(callback?: (err: AWSError, data: MediaTailor.Types.ListPlaybackConfigurationsResponse) => void): Request<MediaTailor.Types.ListPlaybackConfigurationsResponse, AWSError>;
/**
* Lists the prefetch schedules for a playback configuration.
*/
listPrefetchSchedules(params: MediaTailor.Types.ListPrefetchSchedulesRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListPrefetchSchedulesResponse) => void): Request<MediaTailor.Types.ListPrefetchSchedulesResponse, AWSError>;
/**
* Lists the prefetch schedules for a playback configuration.
*/
listPrefetchSchedules(callback?: (err: AWSError, data: MediaTailor.Types.ListPrefetchSchedulesResponse) => void): Request<MediaTailor.Types.ListPrefetchSchedulesResponse, AWSError>;
/**
* Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.
*/
listSourceLocations(params: MediaTailor.Types.ListSourceLocationsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListSourceLocationsResponse) => void): Request<MediaTailor.Types.ListSourceLocationsResponse, AWSError>;
/**
* Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.
*/
listSourceLocations(callback?: (err: AWSError, data: MediaTailor.Types.ListSourceLocationsResponse) => void): Request<MediaTailor.Types.ListSourceLocationsResponse, AWSError>;
/**
* A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
listTagsForResource(params: MediaTailor.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListTagsForResourceResponse) => void): Request<MediaTailor.Types.ListTagsForResourceResponse, AWSError>;
/**
* A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
listTagsForResource(callback?: (err: AWSError, data: MediaTailor.Types.ListTagsForResourceResponse) => void): Request<MediaTailor.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the VOD sources contained in a source location. A source represents a piece of content.
*/
listVodSources(params: MediaTailor.Types.ListVodSourcesRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListVodSourcesResponse) => void): Request<MediaTailor.Types.ListVodSourcesResponse, AWSError>;
/**
* Lists the VOD sources contained in a source location. A source represents a piece of content.
*/
listVodSources(callback?: (err: AWSError, data: MediaTailor.Types.ListVodSourcesResponse) => void): Request<MediaTailor.Types.ListVodSourcesResponse, AWSError>;
/**
* Creates an IAM policy for the channel. IAM policies are used to control access to your channel.
*/
putChannelPolicy(params: MediaTailor.Types.PutChannelPolicyRequest, callback?: (err: AWSError, data: MediaTailor.Types.PutChannelPolicyResponse) => void): Request<MediaTailor.Types.PutChannelPolicyResponse, AWSError>;
/**
* Creates an IAM policy for the channel. IAM policies are used to control access to your channel.
*/
putChannelPolicy(callback?: (err: AWSError, data: MediaTailor.Types.PutChannelPolicyResponse) => void): Request<MediaTailor.Types.PutChannelPolicyResponse, AWSError>;
/**
* Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
*/
putPlaybackConfiguration(params: MediaTailor.Types.PutPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.PutPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.PutPlaybackConfigurationResponse, AWSError>;
/**
* Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
*/
putPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.PutPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.PutPlaybackConfigurationResponse, AWSError>;
/**
* Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
startChannel(params: MediaTailor.Types.StartChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.StartChannelResponse) => void): Request<MediaTailor.Types.StartChannelResponse, AWSError>;
/**
* Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
startChannel(callback?: (err: AWSError, data: MediaTailor.Types.StartChannelResponse) => void): Request<MediaTailor.Types.StartChannelResponse, AWSError>;
/**
* Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
stopChannel(params: MediaTailor.Types.StopChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.StopChannelResponse) => void): Request<MediaTailor.Types.StopChannelResponse, AWSError>;
/**
* Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
stopChannel(callback?: (err: AWSError, data: MediaTailor.Types.StopChannelResponse) => void): Request<MediaTailor.Types.StopChannelResponse, AWSError>;
/**
* The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
tagResource(params: MediaTailor.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* The resource to untag.
*/
untagResource(params: MediaTailor.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* The resource to untag.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
updateChannel(params: MediaTailor.Types.UpdateChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.UpdateChannelResponse) => void): Request<MediaTailor.Types.UpdateChannelResponse, AWSError>;
/**
* Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
*/
updateChannel(callback?: (err: AWSError, data: MediaTailor.Types.UpdateChannelResponse) => void): Request<MediaTailor.Types.UpdateChannelResponse, AWSError>;
/**
* Updates a live source's configuration.
*/
updateLiveSource(params: MediaTailor.Types.UpdateLiveSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.UpdateLiveSourceResponse) => void): Request<MediaTailor.Types.UpdateLiveSourceResponse, AWSError>;
/**
* Updates a live source's configuration.
*/
updateLiveSource(callback?: (err: AWSError, data: MediaTailor.Types.UpdateLiveSourceResponse) => void): Request<MediaTailor.Types.UpdateLiveSourceResponse, AWSError>;
/**
* Updates a program within a channel.
*/
updateProgram(params: MediaTailor.Types.UpdateProgramRequest, callback?: (err: AWSError, data: MediaTailor.Types.UpdateProgramResponse) => void): Request<MediaTailor.Types.UpdateProgramResponse, AWSError>;
/**
* Updates a program within a channel.
*/
updateProgram(callback?: (err: AWSError, data: MediaTailor.Types.UpdateProgramResponse) => void): Request<MediaTailor.Types.UpdateProgramResponse, AWSError>;
/**
* Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
*/
updateSourceLocation(params: MediaTailor.Types.UpdateSourceLocationRequest, callback?: (err: AWSError, data: MediaTailor.Types.UpdateSourceLocationResponse) => void): Request<MediaTailor.Types.UpdateSourceLocationResponse, AWSError>;
/**
* Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
*/
updateSourceLocation(callback?: (err: AWSError, data: MediaTailor.Types.UpdateSourceLocationResponse) => void): Request<MediaTailor.Types.UpdateSourceLocationResponse, AWSError>;
/**
* Updates a VOD source's configuration.
*/
updateVodSource(params: MediaTailor.Types.UpdateVodSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.UpdateVodSourceResponse) => void): Request<MediaTailor.Types.UpdateVodSourceResponse, AWSError>;
/**
* Updates a VOD source's configuration.
*/
updateVodSource(callback?: (err: AWSError, data: MediaTailor.Types.UpdateVodSourceResponse) => void): Request<MediaTailor.Types.UpdateVodSourceResponse, AWSError>;
}
declare namespace MediaTailor {
export interface AccessConfiguration {
/**
* The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. 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. AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored. Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you must meet these requirements: • You must grant MediaTailor access to your MediaPackage endpoint by granting mediatailor.amazonaws.com principal access in an Origin Access policy on the endpoint. • Your MediaTailor source location base URL must be a MediaPackage V2 endpoint. • The caller of the API must have mediapackagev2:GetObject IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations. Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet these requirements: • You must grant MediaTailor access to your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For more 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.
*/
AccessType?: AccessType;
/**
* AWS Secrets Manager access token configuration parameters.
*/
SecretsManagerAccessTokenConfiguration?: SecretsManagerAccessTokenConfiguration;
}
export type AccessType = "S3_SIGV4"|"SECRETS_MANAGER_ACCESS_TOKEN"|"AUTODETECT_SIGV4"|string;
export interface AdBreak {
/**
* Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
*/
AdBreakMetadata?: AdBreakMetadataList;
/**
* The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
*/
MessageType?: MessageType;
/**
* 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.
*/
OffsetMillis: __long;
/**
* Ad break slate configuration.
*/
Slate?: SlateSource;
/**
* 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.
*/
SpliceInsertMessage?: SpliceInsertMessage;
/**
* Defines the SCTE-35 time_signal message inserted around the ad. Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break. See section 9.7.4 of the 2022 SCTE-35 specification for more information.
*/
TimeSignalMessage?: TimeSignalMessage;
}
export type AdBreakMetadataList = KeyValuePair[];
export type AdBreakOpportunities = AdBreakOpportunity[];
export interface AdBreakOpportunity {
/**
* The offset in milliseconds from the start of the VOD source at which an ad marker was detected.
*/
OffsetMillis: __long;
}
export interface AdMarkerPassthrough {
/**
* Enables ad marker passthrough for your configuration.
*/
Enabled?: __boolean;
}
export type AdMarkupType = "DATERANGE"|"SCTE35_ENHANCED"|string;
export interface Alert {
/**
* The code for the alert. For example, NOT_PROCESSED.
*/
AlertCode: __string;
/**
* If an alert is generated for a resource, an explanation of the reason for the alert.
*/
AlertMessage: __string;
/**
* The category that MediaTailor assigns to the alert.
*/
Category?: AlertCategory;
/**
* The timestamp when the alert was last modified.
*/
LastModifiedTime: __timestampUnix;
/**
* The Amazon Resource Names (ARNs) related to this alert.
*/
RelatedResourceArns: __listOf__string;
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArn: __string;
}
export type AlertCategory = "SCHEDULING_ERROR"|"PLAYBACK_WARNING"|"INFO"|string;
export interface AlternateMedia {
/**
* Ad break configuration parameters defined in AlternateMedia.
*/
AdBreaks?: __listOfAdBreak;
ClipRange?: ClipRange;
/**
* The duration of the alternateMedia in milliseconds.
*/
DurationMillis?: __long;
/**
* The name of the live source for alternateMedia.
*/
LiveSourceName?: __string;
/**
* The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
*/
ScheduledStartTimeMillis?: __long;
/**
* The name of the source location for alternateMedia.
*/
SourceLocationName?: __string;
/**
* The name of the VOD source for alternateMedia.
*/
VodSourceName?: __string;
}
export interface AudienceMedia {
/**
* The list of AlternateMedia defined in AudienceMedia.
*/
AlternateMedia?: __listOfAlternateMedia;
/**
* The Audience defined in AudienceMedia.
*/
Audience?: __string;
}
export type Audiences = String[];
export interface AvailMatchingCriteria {
/**
* 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.
*/
DynamicVariable: __string;
/**
* For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
*/
Operator: Operator;
}
export interface AvailSuppression {
/**
* Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.
*/
FillPolicy?: FillPolicy;
/**
* 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. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.
*/
Mode?: Mode;
/**
* 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.
*/
Value?: __string;
}
export interface Bumper {
/**
* The URL for the end bumper asset.
*/
EndUrl?: __string;
/**
* The URL for the start bumper asset.
*/
StartUrl?: __string;
}
export interface CdnConfiguration {
/**
* 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.
*/
AdSegmentUrlPrefix?: __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.
*/
ContentSegmentUrlPrefix?: __string;
}
export interface Channel {
/**
* The ARN of the channel.
*/
Arn: __string;
/**
* The list of audiences defined in channel.
*/
Audiences?: Audiences;
/**
* The name of the channel.
*/
ChannelName: __string;
/**
* Returns the state whether the channel is running or not.
*/
ChannelState: __string;
/**
* The timestamp of when the channel was created.
*/
CreationTime?: __timestampUnix;
/**
* 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.
*/
FillerSlate?: SlateSource;
/**
* The timestamp of when the channel was last modified.
*/
LastModifiedTime?: __timestampUnix;
/**
* The log configuration.
*/
LogConfiguration: LogConfigurationForChannel;
/**
* The channel's output properties.
*/
Outputs: ResponseOutputs;
/**
* 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.
*/
PlaybackMode: __string;
/**
* The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
Tags?: __mapOf__string;
/**
* The tier for this channel. STANDARD tier channels can contain live programs.
*/
Tier: __string;
}
export type ChannelState = "RUNNING"|"STOPPED"|string;
export interface ClipRange {
/**
* The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
*/
EndOffsetMillis?: __long;
/**
* The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
*/
StartOffsetMillis?: __long;
}
export type ConfigurationAliasesRequest = {[key: string]: __mapOf__string};
export type ConfigurationAliasesResponse = {[key: string]: __mapOf__string};
export interface ConfigureLogsForChannelRequest {
/**
* The name of the channel.
*/
ChannelName: __string;
/**
* The types of logs to collect.
*/
LogTypes: LogTypes;
}
export interface ConfigureLogsForChannelResponse {
/**
* The name of the channel.
*/
ChannelName?: __string;
/**
* The types of logs collected.
*/
LogTypes?: LogTypes;
}
export interface ConfigureLogsForPlaybackConfigurationRequest {
/**
* 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
*/
PercentEnabled: __integer;
/**
* The name of the playback configuration.
*/
PlaybackConfigurationName: __string;
}
export interface ConfigureLogsForPlaybackConfigurationResponse {
/**
* The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.
*/
PercentEnabled: __integer;
/**
* The name of the playback configuration.
*/
PlaybackConfigurationName?: __string;
}
export interface CreateChannelRequest {
/**
* The list of audiences defined in channel.
*/
Audiences?: Audiences;
/**
* The name of the channel.
*/
ChannelName: __string;
/**
* 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.
*/
FillerSlate?: SlateSource;
/**
* The channel's output properties.
*/
Outputs: RequestOutputs;
/**
* 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.
*/
PlaybackMode: PlaybackMode;
/**
* The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
Tags?: __mapOf__string;
/**
* The tier of the channel.
*/
Tier?: Tier;
/**
* The time-shifted viewing configuration you want to associate to the channel.
*/
TimeShiftConfiguration?: TimeShiftConfiguration;
}
export interface CreateChannelResponse {
/**
* The Amazon Resource Name (ARN) to assign to the channel.
*/
Arn?: __string;
/**
* The list of audiences defined in channel.
*/
Audiences?: Audiences;
/**
* The name to assign to the channel.
*/
ChannelName?: __string;
/**
* Indicates whether the channel is in a running state or not.
*/
ChannelState?: ChannelState;
/**
* The timestamp of when the channel was created.
*/
CreationTime?: __timestampUnix;
/**
* Contains information about the slate used to fill gaps between programs in the schedule.
*/
FillerSlate?: SlateSource;
/**
* The timestamp of when the channel was last modified.
*/
LastModifiedTime?: __timestampUnix;
/**
* The output properties to assign to the channel.
*/
Outputs?: ResponseOutputs;
/**
* The playback mode to assign to the channel.
*/
PlaybackMode?: __string;
/**
* The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
Tags?: __mapOf__string;
/**
* The tier of the channel.
*/
Tier?: __string;
/**
* The time-shifted viewing configuration assigned to the channel.
*/
TimeShiftConfiguration?: TimeShiftConfiguration;
}
export interface CreateLiveSourceRequest {
/**
* A list of HTTP package configuration parameters for this live source.
*/
HttpPackageConfigurations: HttpPackageConfigurations;
/**
* The name of the live source.
*/
LiveSourceName: __string;
/**
* The name of the source location.
*/
SourceLocationName: __string;
/**
* The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
Tags?: __mapOf__string;
}
export interface CreateLiveSourceResponse {
/**
* The ARN to assign to the live source.
*/
Arn?: __string;
/**
* The time the live source was created.
*/
CreationTime?: __timestampUnix;
/**
* A list of HTTP package configuration parameters for this live source.
*/
HttpPackageConfigurations?: HttpPackageConfigurations;
/**
* The time the live source was last modified.
*/
LastModifiedTime?: __timestampUnix;
/**
* The name to assign to the live source.
*/
LiveSourceName?: __string;
/**
* The name to assign to the source location of the live source.
*/
SourceLocationName?: __string;
/**
* The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
*/
Tags?: __mapOf__string;
}
export interface CreatePrefetchScheduleRequest {
/**
* 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.
*/
Consumption: PrefetchConsumption;
/**
* The name to assign to the schedule request.
*/
Name: __string;
/**
* The name to assign to the playback configuration.
*/
PlaybackConfigurationName: __string;
/**
* 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.
*/
Retrieval: PrefetchRetrieval;
/**
* 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.
*/
StreamId?: __string;
}
export interface CreatePrefetchScheduleResponse {
/**
* The ARN to assign to the prefetch schedule.
*/
Arn?: __string;
/**
* 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.
*/
Consumption?: PrefetchConsumption;
/**
* The name to assign to the prefetch schedule.
*/
Name?: __string;
/**
* The name to assign to the playback configuration.
*/
PlaybackConfigurationName?: __string;
/**
* 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.
*/
Retrieva