prowler-sdk-poc
Version:
1,078 lines • 93.4 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 playback configuration.
*/
configureLogsForPlaybackConfiguration(params: MediaTailor.Types.ConfigureLogsForPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.ConfigureLogsForPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.ConfigureLogsForPlaybackConfigurationResponse, AWSError>;
/**
* Configures 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.
*/
createChannel(params: MediaTailor.Types.CreateChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateChannelResponse) => void): Request<MediaTailor.Types.CreateChannelResponse, AWSError>;
/**
* Creates a channel.
*/
createChannel(callback?: (err: AWSError, data: MediaTailor.Types.CreateChannelResponse) => void): Request<MediaTailor.Types.CreateChannelResponse, AWSError>;
/**
* Creates a new prefetch schedule for the specified playback configuration.
*/
createPrefetchSchedule(params: MediaTailor.Types.CreatePrefetchScheduleRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreatePrefetchScheduleResponse) => void): Request<MediaTailor.Types.CreatePrefetchScheduleResponse, AWSError>;
/**
* Creates a new prefetch schedule for the specified playback configuration.
*/
createPrefetchSchedule(callback?: (err: AWSError, data: MediaTailor.Types.CreatePrefetchScheduleResponse) => void): Request<MediaTailor.Types.CreatePrefetchScheduleResponse, AWSError>;
/**
* Creates a program.
*/
createProgram(params: MediaTailor.Types.CreateProgramRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateProgramResponse) => void): Request<MediaTailor.Types.CreateProgramResponse, AWSError>;
/**
* Creates a program.
*/
createProgram(callback?: (err: AWSError, data: MediaTailor.Types.CreateProgramResponse) => void): Request<MediaTailor.Types.CreateProgramResponse, AWSError>;
/**
* Creates a source location on a specific channel.
*/
createSourceLocation(params: MediaTailor.Types.CreateSourceLocationRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateSourceLocationResponse) => void): Request<MediaTailor.Types.CreateSourceLocationResponse, AWSError>;
/**
* Creates a source location on a specific channel.
*/
createSourceLocation(callback?: (err: AWSError, data: MediaTailor.Types.CreateSourceLocationResponse) => void): Request<MediaTailor.Types.CreateSourceLocationResponse, AWSError>;
/**
* Creates name for a specific VOD source in a source location.
*/
createVodSource(params: MediaTailor.Types.CreateVodSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.CreateVodSourceResponse) => void): Request<MediaTailor.Types.CreateVodSourceResponse, AWSError>;
/**
* Creates name for a specific VOD source in a source location.
*/
createVodSource(callback?: (err: AWSError, data: MediaTailor.Types.CreateVodSourceResponse) => void): Request<MediaTailor.Types.CreateVodSourceResponse, AWSError>;
/**
* Deletes a channel. You must stop the channel before it can be deleted.
*/
deleteChannel(params: MediaTailor.Types.DeleteChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteChannelResponse) => void): Request<MediaTailor.Types.DeleteChannelResponse, AWSError>;
/**
* Deletes a channel. You must stop the channel before it can be deleted.
*/
deleteChannel(callback?: (err: AWSError, data: MediaTailor.Types.DeleteChannelResponse) => void): Request<MediaTailor.Types.DeleteChannelResponse, AWSError>;
/**
* Deletes a channel's IAM policy.
*/
deleteChannelPolicy(params: MediaTailor.Types.DeleteChannelPolicyRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteChannelPolicyResponse) => void): Request<MediaTailor.Types.DeleteChannelPolicyResponse, AWSError>;
/**
* Deletes a channel's IAM policy.
*/
deleteChannelPolicy(callback?: (err: AWSError, data: MediaTailor.Types.DeleteChannelPolicyResponse) => void): Request<MediaTailor.Types.DeleteChannelPolicyResponse, AWSError>;
/**
* Deletes the playback configuration for the specified name.
*/
deletePlaybackConfiguration(params: MediaTailor.Types.DeletePlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeletePlaybackConfigurationResponse) => void): Request<MediaTailor.Types.DeletePlaybackConfigurationResponse, AWSError>;
/**
* Deletes the playback configuration for the specified name.
*/
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.
*/
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.
*/
deletePrefetchSchedule(callback?: (err: AWSError, data: MediaTailor.Types.DeletePrefetchScheduleResponse) => void): Request<MediaTailor.Types.DeletePrefetchScheduleResponse, AWSError>;
/**
* Deletes a specific program on a specific channel.
*/
deleteProgram(params: MediaTailor.Types.DeleteProgramRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteProgramResponse) => void): Request<MediaTailor.Types.DeleteProgramResponse, AWSError>;
/**
* Deletes a specific program on a specific channel.
*/
deleteProgram(callback?: (err: AWSError, data: MediaTailor.Types.DeleteProgramResponse) => void): Request<MediaTailor.Types.DeleteProgramResponse, AWSError>;
/**
* Deletes a source location on a specific channel.
*/
deleteSourceLocation(params: MediaTailor.Types.DeleteSourceLocationRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteSourceLocationResponse) => void): Request<MediaTailor.Types.DeleteSourceLocationResponse, AWSError>;
/**
* Deletes a source location on a specific channel.
*/
deleteSourceLocation(callback?: (err: AWSError, data: MediaTailor.Types.DeleteSourceLocationResponse) => void): Request<MediaTailor.Types.DeleteSourceLocationResponse, AWSError>;
/**
* Deletes a specific VOD source in a specific source location.
*/
deleteVodSource(params: MediaTailor.Types.DeleteVodSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeleteVodSourceResponse) => void): Request<MediaTailor.Types.DeleteVodSourceResponse, AWSError>;
/**
* Deletes a specific VOD source in a specific source location.
*/
deleteVodSource(callback?: (err: AWSError, data: MediaTailor.Types.DeleteVodSourceResponse) => void): Request<MediaTailor.Types.DeleteVodSourceResponse, AWSError>;
/**
* Describes the properties of a specific channel.
*/
describeChannel(params: MediaTailor.Types.DescribeChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.DescribeChannelResponse) => void): Request<MediaTailor.Types.DescribeChannelResponse, AWSError>;
/**
* Describes the properties of a specific channel.
*/
describeChannel(callback?: (err: AWSError, data: MediaTailor.Types.DescribeChannelResponse) => void): Request<MediaTailor.Types.DescribeChannelResponse, AWSError>;
/**
* Retrieves the properties of the requested program.
*/
describeProgram(params: MediaTailor.Types.DescribeProgramRequest, callback?: (err: AWSError, data: MediaTailor.Types.DescribeProgramResponse) => void): Request<MediaTailor.Types.DescribeProgramResponse, AWSError>;
/**
* Retrieves the properties of the requested program.
*/
describeProgram(callback?: (err: AWSError, data: MediaTailor.Types.DescribeProgramResponse) => void): Request<MediaTailor.Types.DescribeProgramResponse, AWSError>;
/**
* Retrieves the properties of the requested source location.
*/
describeSourceLocation(params: MediaTailor.Types.DescribeSourceLocationRequest, callback?: (err: AWSError, data: MediaTailor.Types.DescribeSourceLocationResponse) => void): Request<MediaTailor.Types.DescribeSourceLocationResponse, AWSError>;
/**
* Retrieves the properties of the requested source location.
*/
describeSourceLocation(callback?: (err: AWSError, data: MediaTailor.Types.DescribeSourceLocationResponse) => void): Request<MediaTailor.Types.DescribeSourceLocationResponse, AWSError>;
/**
* Provides details about a specific 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 VOD source in a specific source location.
*/
describeVodSource(callback?: (err: AWSError, data: MediaTailor.Types.DescribeVodSourceResponse) => void): Request<MediaTailor.Types.DescribeVodSourceResponse, AWSError>;
/**
* Retrieves information about a channel's IAM policy.
*/
getChannelPolicy(params: MediaTailor.Types.GetChannelPolicyRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetChannelPolicyResponse) => void): Request<MediaTailor.Types.GetChannelPolicyResponse, AWSError>;
/**
* Retrieves information about a channel's IAM policy.
*/
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>;
/**
* Returns the playback configuration for the specified name.
*/
getPlaybackConfiguration(params: MediaTailor.Types.GetPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.GetPlaybackConfigurationResponse, AWSError>;
/**
* Returns the playback configuration for the specified name.
*/
getPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.GetPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.GetPlaybackConfigurationResponse, AWSError>;
/**
* 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.
*/
getPrefetchSchedule(params: MediaTailor.Types.GetPrefetchScheduleRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetPrefetchScheduleResponse) => void): Request<MediaTailor.Types.GetPrefetchScheduleResponse, AWSError>;
/**
* 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.
*/
getPrefetchSchedule(callback?: (err: AWSError, data: MediaTailor.Types.GetPrefetchScheduleResponse) => void): Request<MediaTailor.Types.GetPrefetchScheduleResponse, AWSError>;
/**
* Returns a list of alerts for the given resource.
*/
listAlerts(params: MediaTailor.Types.ListAlertsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListAlertsResponse) => void): Request<MediaTailor.Types.ListAlertsResponse, AWSError>;
/**
* Returns a list of alerts for the given resource.
*/
listAlerts(callback?: (err: AWSError, data: MediaTailor.Types.ListAlertsResponse) => void): Request<MediaTailor.Types.ListAlertsResponse, AWSError>;
/**
* Retrieves a list of channels that are associated with this account.
*/
listChannels(params: MediaTailor.Types.ListChannelsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListChannelsResponse) => void): Request<MediaTailor.Types.ListChannelsResponse, AWSError>;
/**
* Retrieves a list of channels that are associated with this account.
*/
listChannels(callback?: (err: AWSError, data: MediaTailor.Types.ListChannelsResponse) => void): Request<MediaTailor.Types.ListChannelsResponse, AWSError>;
/**
* 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.
*/
listPlaybackConfigurations(params: MediaTailor.Types.ListPlaybackConfigurationsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListPlaybackConfigurationsResponse) => void): Request<MediaTailor.Types.ListPlaybackConfigurationsResponse, AWSError>;
/**
* 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.
*/
listPlaybackConfigurations(callback?: (err: AWSError, data: MediaTailor.Types.ListPlaybackConfigurationsResponse) => void): Request<MediaTailor.Types.ListPlaybackConfigurationsResponse, AWSError>;
/**
* Creates a new prefetch schedule.
*/
listPrefetchSchedules(params: MediaTailor.Types.ListPrefetchSchedulesRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListPrefetchSchedulesResponse) => void): Request<MediaTailor.Types.ListPrefetchSchedulesResponse, AWSError>;
/**
* Creates a new prefetch schedule.
*/
listPrefetchSchedules(callback?: (err: AWSError, data: MediaTailor.Types.ListPrefetchSchedulesResponse) => void): Request<MediaTailor.Types.ListPrefetchSchedulesResponse, AWSError>;
/**
* Retrieves a list of source locations.
*/
listSourceLocations(params: MediaTailor.Types.ListSourceLocationsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListSourceLocationsResponse) => void): Request<MediaTailor.Types.ListSourceLocationsResponse, AWSError>;
/**
* Retrieves a list of source locations.
*/
listSourceLocations(callback?: (err: AWSError, data: MediaTailor.Types.ListSourceLocationsResponse) => void): Request<MediaTailor.Types.ListSourceLocationsResponse, AWSError>;
/**
* Returns a list of the tags assigned to the specified playback configuration resource.
*/
listTagsForResource(params: MediaTailor.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListTagsForResourceResponse) => void): Request<MediaTailor.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of the tags assigned to the specified playback configuration resource.
*/
listTagsForResource(callback?: (err: AWSError, data: MediaTailor.Types.ListTagsForResourceResponse) => void): Request<MediaTailor.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all the VOD sources in a source location.
*/
listVodSources(params: MediaTailor.Types.ListVodSourcesRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListVodSourcesResponse) => void): Request<MediaTailor.Types.ListVodSourcesResponse, AWSError>;
/**
* Lists all the VOD sources in a source location.
*/
listVodSources(callback?: (err: AWSError, data: MediaTailor.Types.ListVodSourcesResponse) => void): Request<MediaTailor.Types.ListVodSourcesResponse, AWSError>;
/**
* Creates an IAM policy for the 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.
*/
putChannelPolicy(callback?: (err: AWSError, data: MediaTailor.Types.PutChannelPolicyResponse) => void): Request<MediaTailor.Types.PutChannelPolicyResponse, AWSError>;
/**
* Adds a new playback configuration to AWS Elemental MediaTailor.
*/
putPlaybackConfiguration(params: MediaTailor.Types.PutPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.PutPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.PutPlaybackConfigurationResponse, AWSError>;
/**
* Adds a new playback configuration to AWS Elemental MediaTailor.
*/
putPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.PutPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.PutPlaybackConfigurationResponse, AWSError>;
/**
* Starts a specific channel.
*/
startChannel(params: MediaTailor.Types.StartChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.StartChannelResponse) => void): Request<MediaTailor.Types.StartChannelResponse, AWSError>;
/**
* Starts a specific channel.
*/
startChannel(callback?: (err: AWSError, data: MediaTailor.Types.StartChannelResponse) => void): Request<MediaTailor.Types.StartChannelResponse, AWSError>;
/**
* Stops a specific channel.
*/
stopChannel(params: MediaTailor.Types.StopChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.StopChannelResponse) => void): Request<MediaTailor.Types.StopChannelResponse, AWSError>;
/**
* Stops a specific channel.
*/
stopChannel(callback?: (err: AWSError, data: MediaTailor.Types.StopChannelResponse) => void): Request<MediaTailor.Types.StopChannelResponse, AWSError>;
/**
* Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
*/
tagResource(params: MediaTailor.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
*/
untagResource(params: MediaTailor.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates an existing channel.
*/
updateChannel(params: MediaTailor.Types.UpdateChannelRequest, callback?: (err: AWSError, data: MediaTailor.Types.UpdateChannelResponse) => void): Request<MediaTailor.Types.UpdateChannelResponse, AWSError>;
/**
* Updates an existing channel.
*/
updateChannel(callback?: (err: AWSError, data: MediaTailor.Types.UpdateChannelResponse) => void): Request<MediaTailor.Types.UpdateChannelResponse, AWSError>;
/**
* Updates a source location on a specific channel.
*/
updateSourceLocation(params: MediaTailor.Types.UpdateSourceLocationRequest, callback?: (err: AWSError, data: MediaTailor.Types.UpdateSourceLocationResponse) => void): Request<MediaTailor.Types.UpdateSourceLocationResponse, AWSError>;
/**
* Updates a source location on a specific channel.
*/
updateSourceLocation(callback?: (err: AWSError, data: MediaTailor.Types.UpdateSourceLocationResponse) => void): Request<MediaTailor.Types.UpdateSourceLocationResponse, AWSError>;
/**
* Updates a specific VOD source in a specific source location.
*/
updateVodSource(params: MediaTailor.Types.UpdateVodSourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.UpdateVodSourceResponse) => void): Request<MediaTailor.Types.UpdateVodSourceResponse, AWSError>;
/**
* Updates a specific VOD source in a specific source location.
*/
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. 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.
*/
AccessType?: AccessType;
/**
* AWS Secrets Manager access token configuration parameters.
*/
SecretsManagerAccessTokenConfiguration?: SecretsManagerAccessTokenConfiguration;
}
export type AccessType = "S3_SIGV4"|"SECRETS_MANAGER_ACCESS_TOKEN"|string;
export interface AdBreak {
/**
* The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.
*/
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;
}
export interface AdMarkerPassthrough {
/**
* Enables ad marker passthrough for your configuration.
*/
Enabled?: __boolean;
}
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 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 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 {
/**
* 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.
*/
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.&lt;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 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;
/**
* Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.
*/
FillerSlate?: SlateSource;
/**
* The timestamp of when the channel was last modified.
*/
LastModifiedTime?: __timestampUnix;
/**
* 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?: __mapOf__string;
}
export type ChannelState = "RUNNING"|"STOPPED"|string;
export type ConfigurationAliasesRequest = {[key: string]: __mapOf__string};
export type ConfigurationAliasesResponse = {[key: string]: __mapOf__string};
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 identifier for the channel you are working on.
*/
ChannelName: __string;
/**
* The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses a LINEAR 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?: __mapOf__string;
}
export interface CreateChannelResponse {
/**
* The ARN of the channel.
*/
Arn?: __string;
/**
* The name of 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 channel's output properties.
*/
Outputs?: ResponseOutputs;
/**
* The channel's playback mode.
*/
PlaybackMode?: __string;
/**
* The tags assigned to the channel.
*/
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 identifier for the playback configuration.
*/
Name: __string;
/**
* The name of 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 Amazon Resource Name (ARN) of the prefetch schedule.
*/
Arn?: __string;
/**
* 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.
*/
Consumption?: PrefetchConsumption;
/**
* The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
*/
Name?: __string;
/**
* The name of the playback configuration to create the prefetch schedule for.
*/
PlaybackConfigurationName?: __string;
/**
* A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
*/
Retrieval?: PrefetchRetrieval;
/**
* An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
*/
StreamId?: __string;
}
export interface CreateProgramRequest {
/**
* The ad break configuration settings.
*/
AdBreaks?: __listOfAdBreak;
/**
* The identifier for the channel you are working on.
*/
ChannelName: __string;
/**
* The identifier for the program you are working on.
*/
ProgramName: __string;
/**
* The schedule configuration settings.
*/
ScheduleConfiguration: ScheduleConfiguration;
/**
* The name of the source location.
*/
SourceLocationName: __string;
/**
* The name that's used to refer to a VOD source.
*/
VodSourceName: __string;
}
export interface CreateProgramResponse {
/**
* The ad break configuration settings.
*/
AdBreaks?: __listOfAdBreak;
/**
* The ARN of the program.
*/
Arn?: __string;
/**
* The name of the channel that the program belongs to.
*/
ChannelName?: __string;
/**
* The timestamp of when the program was created.
*/
CreationTime?: __timestampUnix;
/**
* The name of the program.
*/
ProgramName?: __string;
/**
* 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.
*/
ScheduledStartTime?: __timestampUnix;
/**
* The source location name.
*/
SourceLocationName?: __string;
/**
* The name that's used to refer to a VOD source.
*/
VodSourceName?: __string;
}
export interface CreateSourceLocationRequest {
/**
* Access configuration parameters. Configures the type of authentication used to access content from your source location.
*/
AccessConfiguration?: AccessConfiguration;
/**
* The optional configuration for the server that serves segments.
*/
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
/**
* The source's HTTP package configurations.
*/
HttpConfiguration: HttpConfiguration;
/**
* The identifier for the source location you are working on.
*/
SourceLocationName: __string;
/**
* The tags to assign to the source location.
*/
Tags?: __mapOf__string;
}
export interface CreateSourceLocationResponse {
/**
* The access configuration for the source location.
*/
AccessConfiguration?: AccessConfiguration;
/**
* The ARN of the source location.
*/
Arn?: __string;
/**
* The timestamp that indicates when the source location was created.
*/
CreationTime?: __timestampUnix;
/**
* The default segment delivery configuration settings.
*/
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
/**
* The HTTP package configuration settings for the source location.
*/
HttpConfiguration?: HttpConfiguration;
/**
* The timestamp that indicates when the source location was last modified.
*/
LastModifiedTime?: __timestampUnix;
/**
* The name of the source location.
*/
SourceLocationName?: __string;
/**
* The tags assigned to the source location.
*/
Tags?: __mapOf__string;
}
export interface CreateVodSourceRequest {
/**
* An array of HTTP package configuration parameters for this VOD source.
*/
HttpPackageConfigurations: HttpPackageConfigurations;
/**
* The identifier for the source location you are working on.
*/
SourceLocationName: __string;
/**
* The tags to assign to the VOD source.
*/
Tags?: __mapOf__string;
/**
* The identifier for the VOD source you are working on.
*/
VodSourceName: __string;
}
export interface CreateVodSourceResponse {
/**
* The ARN of the VOD source.
*/
Arn?: __string;
/**
* The timestamp that indicates when the VOD source was created.
*/
CreationTime?: __timestampUnix;
/**
* The HTTP package configurations.
*/
HttpPackageConfigurations?: HttpPackageConfigurations;
/**
* The ARN for the VOD source.
*/
LastModifiedTime?: __timestampUnix;
/**
* The name of the source location associated with the VOD source.
*/
SourceLocationName?: __string;
/**
* The tags assigned to the VOD source.
*/
Tags?: __mapOf__string;
/**
* The name of the VOD source.
*/
VodSourceName?: __string;
}
export interface DashConfiguration {
/**
* The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
*/
ManifestEndpointPrefix?: __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.
*/
MpdLocation?: __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.
*/
OriginManifestType?: OriginManifestType;
}
export interface DashConfigurationForPut {
/**
* 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.
*/
MpdLocation?: __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.
*/
OriginManifestType?: OriginManifestType;
}
export interface DashPlaylistSettings {
/**
* The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
*/
ManifestWindowSeconds?: __integer;
/**
* Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
*/
MinBufferTimeSeconds?: __integer;
/**
* 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.
*/
MinUpdatePeriodSeconds?: __integer;
/**
* 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.
*/
SuggestedPresentationDelaySeconds?: __integer;
}
export interface DefaultSegmentDeliveryConfiguration {
/**
* The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.
*/
BaseUrl?: __string;
}
export interface DeleteChannelPolicyRequest {
/**
* The identifier for the channel you are working on.
*/
ChannelName: __string;
}
export interface DeleteChannelPolicyResponse {
}
export interface DeleteChannelRequest {
/**
* The identifier for the channel you are working on.
*/
ChannelName: __string;
}
export interface DeleteChannelResponse {
}
export interface DeletePlaybackConfigurationRequest {
/**
* The identifier for the playback configuration.
*/
Name: __string;
}
export interface DeletePlaybackConfigurationResponse {
}
export interface DeletePrefetchScheduleRequest {
/**
* The identifier for the playback configuration.
*/
Name: __string;
/**
* The name of the playback configuration.
*/
PlaybackConfigurationName: __string;
}
export interface DeletePrefetchScheduleResponse {
}
export interface DeleteProgramRequest {
/**
* The identifier for the channel you are working on.
*/
ChannelName: __string;
/**
* The identifier for the program you are working on.
*/
ProgramName: __string;
}
export interface DeleteProgramResponse {
}
export interface DeleteSourceLocationRequest {
/**
* The identifier for the source location you are working on.
*/
SourceLocationName: __string;
}
export interface DeleteSourceLocationResponse {
}
export interface DeleteVodSourceRequest {
/**
* The identifier for the source location you are working on.
*/
SourceLocationName: __string;
/**
* The identifier for the VOD source you are working on.
*/
VodSourceName: __string;
}
export interface DeleteVodSourceResponse {
}
export interface DescribeChannelRequest {
/**
* The identifier for the channel you are working on.
*/
ChannelName: __string;
}
export interface DescribeChannelResponse {
/**
* The ARN of the channel.
*/
Arn?: __string;
/**
* The name of 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 channel's output properties.
*/
Outputs?: ResponseOutputs;
/**
* The channel's playback mode.
*/
PlaybackMode?: __string;
/**
* The tags assigned to the channel.
*/
Tags?: __mapOf__string;
}
export interface DescribeProgramRequest {
/**
* The identifier for the channel you are working on.
*/
ChannelName: __string;
/**
* The identifier for the program you are working on.
*/
ProgramName: __string;
}
export interface DescribeProgramResponse {
/**
* The ad break configuration settings.
*/
AdBreaks?: __listOfAdBreak;
/**
* The ARN of the program.
*/
Arn?: __string;
/**
* The name of the channel that the program belongs to.
*/
ChannelName?: __string;
/**
* The timestamp of when the program was created.
*/
CreationTime?: __timestampUnix;
/**
* The name of the program.
*/
ProgramName?: __string;
/**
* 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.
*/
ScheduledStartTime?: __timestampUnix;
/**
* The source location name.
*/
SourceLocationName?: __string;
/**
* The name that's used to refer to a VOD source.
*/
VodSourceName?: __string;
}
export interface DescribeSourceLocationRequest {
/**
* The identifier for the source location you are working on.
*/
SourceLocationName: __string;
}
export interface DescribeSourceLocationResponse {
/**
* The access configuration for the source location.
*/
AccessConfiguration?: AccessConfiguration;
/**
* The ARN of the source location.
*/
Arn?: __string;
/**
* The timestamp that indicates when the source location was created.
*/
CreationTime?: __timestampUnix;
/**
* The default segment delivery configuration settings.
*/
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
/**
* The HTTP package configuration settings for the source location.
*/
HttpConfiguration?: HttpConfiguration;
/**
* The timestamp that indicates when the source location was last modified.
*/
LastModifiedTime?: __timestampUnix;
/**
* The name of the source location.
*/
SourceLocationName?: __string;
/**
* The tags assigned to the source location.
*/
Tags?: __mapOf__string;
}
export interface DescribeVodSourceRequest {
/**
* The identifier for the source location you are working on.
*/
SourceLocationName: __string;
/**
* The identifier for the VOD source you are working on.
*/
VodSourceName: __string;
}
export interface DescribeVodSourceResponse {
/**
* The ARN of the VOD source.
*/
Arn?: __string;
/**
* The timestamp that indicates when the VOD source was created.
*/
CreationTime?: __timestampUnix;
/**
* The HTTP package configurations.
*/
HttpPackageConfigurations?: HttpPackageConfigurations;
/**
* The ARN for the VOD source.
*/
LastModifiedTime?: __timestampUnix;
/**
* The name of the source location associated with the VOD source.
*/
SourceLocationName?: __string;
/**
* The tags assigned to the VOD source.
*/
Tags?: __mapOf__string;
/**
* The name of the VOD source.
*/
VodSourceName?: __string;
}
export interface GetChannelPolicyRequest {
/**
* The identifier for the channel you are working on.
*/
ChannelName: __string;
}
export interface GetChannelPolicyResponse {
/**
* The IAM policy for the channel.
*/
Policy?: __string;
}
export interface GetChannelScheduleRequest {
/**
* The identifier for the channel you are working on.
*/
ChannelName: __string;
/**
* The schedule duration in minutes. The maximum duration is 4320 minutes (three days).
*/
DurationMinutes?: __string;
/**
* Upper bound on number of records to return. The maximum number of results is 100.
*/
MaxResults?: MaxResults;
/**
* Pagination token from the GET list request. Use the token to fetch the next page of results.
*/
NextToken?: __string;
}
export interface GetChannelScheduleResponse {
/**
* An array of schedule entries for the channel.
*/
Items?: __listOfScheduleEntry;
/**
* Pagination token from the GET list request. Use the token to fetch the next page of results.
*/
NextToken?: __string;
}
export interface GetPlaybackConfigurationRequest {
/**
* The identifier for the playback configuration.
*/
Name: __string;
}
export interface GetPlaybackConfigurationResponse {
/**
* 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.
*/
AdDecisionServerUrl?: __string;
/**
* The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppres