Mediatailor

configure_logs_for_playback_configuration(percent_enabled, playback_configuration_name)
configure_logs_for_playback_configuration(percent_enabled, playback_configuration_name, params::Dict{String,<:Any})

Configures Amazon CloudWatch log settings for a playback configuration.

Arguments

• percent_enabled: 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
• playback_configuration_name: The name of the playback configuration.

create_channel(outputs, playback_mode, channel_name)
create_channel(outputs, playback_mode, channel_name, params::Dict{String,<:Any})

Creates a channel.

Arguments

• outputs: The channel's output properties.
• playback_mode: 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.
• channel_name: The identifier for the channel you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "FillerSlate": 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.
• "Tier": The tier of the channel.
• "tags": The tags to assign to the channel.

create_live_source(http_package_configurations, live_source_name, source_location_name)
create_live_source(http_package_configurations, live_source_name, source_location_name, params::Dict{String,<:Any})

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

Arguments

• http_package_configurations: A list of HTTP package configuration parameters for this live source.
• live_source_name: The identifier for the live source you are working on.
• source_location_name: The identifier for the source location you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": The tags to assign to the live source.

create_prefetch_schedule(consumption, name, playback_configuration_name, retrieval)
create_prefetch_schedule(consumption, name, playback_configuration_name, retrieval, params::Dict{String,<:Any})

Creates a new prefetch schedule for the specified playback configuration.

Arguments

• consumption: The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
• name: The identifier for the playback configuration.
• playback_configuration_name: The name of the playback configuration.
• retrieval: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "StreamId": 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.

create_program(schedule_configuration, source_location_name, channel_name, program_name)
create_program(schedule_configuration, source_location_name, channel_name, program_name, params::Dict{String,<:Any})

Creates a program.

Arguments

• schedule_configuration: The schedule configuration settings.
• source_location_name: The name of the source location.
• channel_name: The identifier for the channel you are working on.
• program_name: The identifier for the program you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AdBreaks": The ad break configuration settings.
• "LiveSourceName": The name of the LiveSource for this Program.
• "VodSourceName": The name that's used to refer to a VOD source.

create_source_location(http_configuration, source_location_name)
create_source_location(http_configuration, source_location_name, params::Dict{String,<:Any})

Creates a source location on a specific channel.

Arguments

• http_configuration: The source's HTTP package configurations.
• source_location_name: The identifier for the source location you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AccessConfiguration": Access configuration parameters. Configures the type of authentication used to access content from your source location.
• "DefaultSegmentDeliveryConfiguration": The optional configuration for the server that serves segments.
• "SegmentDeliveryConfigurations": A list of the segment delivery configurations associated with this resource.
• "tags": The tags to assign to the source location.

create_vod_source(http_package_configurations, source_location_name, vod_source_name)
create_vod_source(http_package_configurations, source_location_name, vod_source_name, params::Dict{String,<:Any})

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

Arguments

• http_package_configurations: A list of HTTP package configuration parameters for this VOD source.
• source_location_name: The identifier for the source location you are working on.
• vod_source_name: The identifier for the VOD source you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "tags": The tags to assign to the VOD source.

delete_channel(channel_name)
delete_channel(channel_name, params::Dict{String,<:Any})

Deletes a channel. You must stop the channel before it can be deleted.

Arguments

• channel_name: The identifier for the channel you are working on.

delete_channel_policy(channel_name)
delete_channel_policy(channel_name, params::Dict{String,<:Any})

Deletes a channel's IAM policy.

Arguments

• channel_name: The identifier for the channel you are working on.

delete_live_source(live_source_name, source_location_name)
delete_live_source(live_source_name, source_location_name, params::Dict{String,<:Any})

Deletes a specific live source in a specific source location.

Arguments

• live_source_name: The identifier for the live source you are working on.
• source_location_name: The identifier for the source location you are working on.

delete_playback_configuration(name)
delete_playback_configuration(name, params::Dict{String,<:Any})

Deletes the playback configuration for the specified name.

Arguments

• name: The identifier for the playback configuration.

delete_prefetch_schedule(name, playback_configuration_name)
delete_prefetch_schedule(name, playback_configuration_name, params::Dict{String,<:Any})

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.

Arguments

• name: The identifier for the playback configuration.
• playback_configuration_name: The name of the playback configuration.

delete_program(channel_name, program_name)
delete_program(channel_name, program_name, params::Dict{String,<:Any})

Deletes a specific program on a specific channel.

Arguments

• channel_name: The identifier for the channel you are working on.
• program_name: The identifier for the program you are working on.

delete_source_location(source_location_name)
delete_source_location(source_location_name, params::Dict{String,<:Any})

Deletes a source location on a specific channel.

Arguments

• source_location_name: The identifier for the source location you are working on.

delete_vod_source(source_location_name, vod_source_name)
delete_vod_source(source_location_name, vod_source_name, params::Dict{String,<:Any})

Deletes a specific VOD source in a specific source location.

Arguments

• source_location_name: The identifier for the source location you are working on.
• vod_source_name: The identifier for the VOD source you are working on.

describe_channel(channel_name)
describe_channel(channel_name, params::Dict{String,<:Any})

Describes the properties of a specific channel.

Arguments

• channel_name: The identifier for the channel you are working on.

describe_live_source(live_source_name, source_location_name)
describe_live_source(live_source_name, source_location_name, params::Dict{String,<:Any})

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

Arguments

• live_source_name: The identifier for the live source you are working on.
• source_location_name: The identifier for the source location you are working on.

describe_program(channel_name, program_name)
describe_program(channel_name, program_name, params::Dict{String,<:Any})

Retrieves the properties of the requested program.

Arguments

• channel_name: The identifier for the channel you are working on.
• program_name: The identifier for the program you are working on.

describe_source_location(source_location_name)
describe_source_location(source_location_name, params::Dict{String,<:Any})

Retrieves the properties of the requested source location.

Arguments

• source_location_name: The identifier for the source location you are working on.

describe_vod_source(source_location_name, vod_source_name)
describe_vod_source(source_location_name, vod_source_name, params::Dict{String,<:Any})

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

Arguments

• source_location_name: The identifier for the source location you are working on.
• vod_source_name: The identifier for the VOD source you are working on.

get_channel_policy(channel_name)
get_channel_policy(channel_name, params::Dict{String,<:Any})

Retrieves information about a channel's IAM policy.

Arguments

• channel_name: The identifier for the channel you are working on.

get_channel_schedule(channel_name)
get_channel_schedule(channel_name, params::Dict{String,<:Any})

Retrieves information about your channel's schedule.

Arguments

• channel_name: The identifier for the channel you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "durationMinutes": The schedule duration in minutes. The maximum duration is 4320 minutes (three days).
• "maxResults": Upper bound on number of records to return. The maximum number of results is 100.
• "nextToken": Pagination token from the GET list request. Use the token to fetch the next page of results.

get_playback_configuration(name)
get_playback_configuration(name, params::Dict{String,<:Any})

Returns the playback configuration for the specified name.

Arguments

• name: The identifier for the playback configuration.

get_prefetch_schedule(name, playback_configuration_name)
get_prefetch_schedule(name, playback_configuration_name, params::Dict{String,<:Any})

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.

Arguments

• name: The identifier for the playback configuration.
• playback_configuration_name: The name of the playback configuration.

list_alerts(resource_arn)
list_alerts(resource_arn, params::Dict{String,<:Any})

Returns a list of alerts for the given resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Upper bound on number of records to return. The maximum number of results is 100.
• "nextToken": Pagination token from the GET list request. Use the token to fetch the next page of results.

list_channels()
list_channels(params::Dict{String,<:Any})

Retrieves a list of channels that are associated with this account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Upper bound on number of records to return. The maximum number of results is 100.
• "nextToken": Pagination token from the GET list request. Use the token to fetch the next page of results.

list_live_sources(source_location_name)
list_live_sources(source_location_name, params::Dict{String,<:Any})

lists all the live sources in a source location.

Arguments

• source_location_name: The identifier for the source location you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Upper bound on number of records to return. The maximum number of results is 100.
• "nextToken": Pagination token from the GET list request. Use the token to fetch the next page of results.

list_playback_configurations()
list_playback_configurations(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": Maximum number of records to return.
• "NextToken": Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

list_prefetch_schedules(playback_configuration_name)
list_prefetch_schedules(playback_configuration_name, params::Dict{String,<:Any})

Creates a new prefetch schedule.

Arguments

• playback_configuration_name: The name of the playback configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If the playback configuration has more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.
• "NextToken": (Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results. For the first ListPrefetchSchedulesRequest request, omit this value. For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.
• "StreamId": An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

list_source_locations()
list_source_locations(params::Dict{String,<:Any})

Retrieves a list of source locations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Upper bound on number of records to return. The maximum number of results is 100.
• "nextToken": Pagination token from the GET list request. Use the token to fetch the next page of results.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Returns a list of the tags assigned to the specified playback configuration resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

list_vod_sources(source_location_name)
list_vod_sources(source_location_name, params::Dict{String,<:Any})

Lists all the VOD sources in a source location.

Arguments

• source_location_name: The identifier for the source location you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Upper bound on number of records to return. The maximum number of results is 100.
• "nextToken": Pagination token from the GET list request. Use the token to fetch the next page of results.

put_channel_policy(policy, channel_name)
put_channel_policy(policy, channel_name, params::Dict{String,<:Any})

Creates an IAM policy for the channel.

Arguments

• policy: Adds an IAM role that determines the permissions of your channel.
• channel_name: The identifier for the channel you are working on.

put_playback_configuration()
put_playback_configuration(params::Dict{String,<:Any})

Adds a new playback configuration to AWS Elemental MediaTailor.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AdDecisionServerUrl": The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
• "AvailSuppression": The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
• "Bumper": The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
• "CdnConfiguration": The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
• "ConfigurationAliases": The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
• "DashConfiguration": The configuration for DASH content.
• "LivePreRollConfiguration": The configuration for pre-roll ad insertion.
• "ManifestProcessingRules": The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
• "Name": The identifier for the playback configuration.
• "PersonalizationThresholdSeconds": Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
• "SlateAdUrl": The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
• "TranscodeProfileName": The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
• "VideoContentSourceUrl": The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
• "tags": The tags to assign to the playback configuration.

start_channel(channel_name)
start_channel(channel_name, params::Dict{String,<:Any})

Starts a specific channel.

Arguments

• channel_name: The identifier for the channel you are working on.

stop_channel(channel_name)
stop_channel(channel_name, params::Dict{String,<:Any})

Stops a specific channel.

Arguments

• channel_name: The identifier for the channel you are working on.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

Arguments

• resource_arn: The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.
• tags: A comma-separated list of tag key:value pairs.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

Arguments

• resource_arn: The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.
• tag_keys: A comma-separated list of the tag keys to remove from the playback configuration.

update_channel(outputs, channel_name)
update_channel(outputs, channel_name, params::Dict{String,<:Any})

Updates an existing channel.

Arguments

• outputs: The channel's output properties.
• channel_name: The identifier for the channel you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "FillerSlate": 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.

update_live_source(http_package_configurations, live_source_name, source_location_name)
update_live_source(http_package_configurations, live_source_name, source_location_name, params::Dict{String,<:Any})

Updates a specific live source in a specific source location.

Arguments

• http_package_configurations: A list of HTTP package configurations for the live source on this account.
• live_source_name: The identifier for the live source you are working on.
• source_location_name: The identifier for the source location you are working on.

update_source_location(http_configuration, source_location_name)
update_source_location(http_configuration, source_location_name, params::Dict{String,<:Any})

Updates a source location on a specific channel.

Arguments

• http_configuration: The HTTP configuration for the source location.
• source_location_name: The identifier for the source location you are working on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AccessConfiguration": Access configuration parameters. Configures the type of authentication used to access content from your source location.
• "DefaultSegmentDeliveryConfiguration": The optional configuration for the host server that serves segments.
• "SegmentDeliveryConfigurations": A list of the segment delivery configurations associated with this resource.

update_vod_source(http_package_configurations, source_location_name, vod_source_name)
update_vod_source(http_package_configurations, source_location_name, vod_source_name, params::Dict{String,<:Any})

Updates a specific VOD source in a specific source location.

Arguments

• http_package_configurations: A list of HTTP package configurations for the VOD source on this account.
• source_location_name: The identifier for the source location you are working on.
• vod_source_name: The identifier for the VOD source you are working on.