Mediatailor

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

Configures Amazon CloudWatch log settings for a channel.

Arguments

• channel_name: The name of the channel.
• log_types: The types of logs to collect.

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

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(channel_name, outputs, playback_mode)
create_channel(channel_name, outputs, playback_mode, params::Dict{String,<:Any})

Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel.
• 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.

Optional Parameters

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

• "Audiences": The list of audiences defined in channel.
• "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.
• "TimeShiftConfiguration": The time-shifted viewing configuration you want to associate to the channel.
• "tags": 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.

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})

The live source configuration.

Arguments

• http_package_configurations: A list of HTTP package configuration parameters for this live source.
• live_source_name: The name of the live source.
• source_location_name: The name of the source location.

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. 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.

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

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.

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 name to assign to the schedule request.
• playback_configuration_name: The name to assign to 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(channel_name, program_name, schedule_configuration, source_location_name)
create_program(channel_name, program_name, schedule_configuration, source_location_name, params::Dict{String,<:Any})

Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel for this Program.
• program_name: The name of the Program.
• schedule_configuration: The schedule configuration settings.
• source_location_name: The name of the source location.

Optional Parameters

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

• "AdBreaks": The ad break configuration settings.
• "AudienceMedia": The list of AudienceMedia defined in program.
• "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. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

Arguments

• http_configuration: The source's HTTP package configurations.
• source_location_name: The name associated with the source location.

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. 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.

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})

The VOD source configuration parameters.

Arguments

• http_package_configurations: A list of HTTP package configuration parameters for this VOD source.
• source_location_name: The name of the source location for this VOD source.
• vod_source_name: The name associated with the VOD source.>

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. 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.

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

Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel.

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

The channel policy to delete.

Arguments

• channel_name: The name of the channel associated with this channel policy.

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

The live source to delete.

Arguments

• live_source_name: The name of the live source.
• source_location_name: The name of the source location associated with this Live Source.

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

Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Arguments

• name: The name of 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. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

Arguments

• name: The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
• playback_configuration_name: The name of the playback configuration for this prefetch schedule.

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

Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel.
• program_name: The name of the program.

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

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.

Arguments

• source_location_name: The name of the source location.

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

The video on demand (VOD) source to delete.

Arguments

• source_location_name: The name of the source location associated with this VOD Source.
• vod_source_name: The name of the VOD source.

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

Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel.

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

The live source to describe.

Arguments

• live_source_name: The name of the live source.
• source_location_name: The name of the source location associated with this Live Source.

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

Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel associated with this Program.
• program_name: The name of the program.

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

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.

Arguments

• source_location_name: The name of the source location.

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 video on demand (VOD) source in a specific source location.

Arguments

• source_location_name: The name of the source location associated with this VOD Source.
• vod_source_name: The name of the VOD Source.

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

Returns the channel's IAM policy. IAM policies are used to control access to your channel.

Arguments

• channel_name: The name of the channel associated with this Channel Policy.

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 name of the channel associated with this Channel Schedule.

Optional Parameters

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

• "audience": The single audience for GetChannelScheduleRequest.
• "durationMinutes": The duration in minutes of the channel schedule.
• "maxResults": The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel 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 channel schedules, use NextToken to get the second and subsequent pages of results. For the first GetChannelScheduleRequest 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 channel schedules to get.

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

Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

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})

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.

Arguments

• name: The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
• playback_configuration_name: 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.

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

Lists the alerts that are associated with a MediaTailor channel assembly 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": The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than MaxResults alerts, use the value of NextToken in the response to get the next page of results.
• "nextToken": Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

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

Retrieves information about the channels that are associated with the current AWS account.

Optional Parameters

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

• "maxResults": The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.
• "nextToken": Pagination token returned by the list request when results exceed the maximum allowed. 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 the live sources contained in a source location. A source represents a piece of content.

Arguments

• source_location_name: The name of the source location associated with this Live Sources list.

Optional Parameters

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

• "maxResults": The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, use the value of NextToken in the response to get the next page of results.
• "nextToken": Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

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

Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.

Optional Parameters

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

• "MaxResults": The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback configurations, use the value of NextToken in the response to get the next page of results.
• "NextToken": Pagination token returned by the 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})

Lists the prefetch schedules for a playback configuration.

Arguments

• playback_configuration_name: Retrieves the prefetch schedule(s) for a specific 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 there are 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})

Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.

Optional Parameters

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

• "maxResults": The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than MaxResults source locations, use the value of NextToken in the response to get the next page of results.
• "nextToken": Pagination token returned by the list request when results exceed the maximum allowed. 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})

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.

Arguments

• resource_arn: The Amazon Resource Name (ARN) associated with this resource.

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

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

Arguments

• source_location_name: The name of the source location associated with this VOD Source list.

Optional Parameters

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

• "maxResults": The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.
• "nextToken": Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

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

Creates an IAM policy for the channel. IAM policies are used to control access to your channel.

Arguments

• channel_name: The channel name associated with this Channel Policy.
• policy: Adds an IAM role that determines the permissions of your channel.

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

Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Arguments

• name: The identifier for the playback configuration.

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.
• "InsertionMode": The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHEDONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYERSELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
• "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.
• "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. 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.

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

Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel.

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

Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel.

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

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.

Arguments

• resource_arn: The Amazon Resource Name (ARN) associated with the resource.
• tags: The tags to assign to the 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.

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

The resource to untag.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to untag.
• tag_keys: The tag keys associated with the resource.

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

Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Arguments

• channel_name: The name of the channel.
• outputs: The channel's output properties.

Optional Parameters

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

• "Audiences": The list of audiences defined in channel.
• "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.
• "TimeShiftConfiguration": The time-shifted viewing configuration you want to associate to the channel.

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 live source's configuration.

Arguments

• http_package_configurations: A list of HTTP package configurations for the live source on this account.
• live_source_name: The name of the live source.
• source_location_name: The name of the source location associated with this Live Source.

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

Updates a program within a channel.

Arguments

• channel_name: The name of the channel for this Program.
• program_name: The name of the Program.
• schedule_configuration: The schedule configuration settings.

Optional Parameters

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

• "AdBreaks": The ad break configuration settings.
• "AudienceMedia": The list of AudienceMedia defined in program.

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

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.

Arguments

• http_configuration: The HTTP configuration for the source location.
• source_location_name: The name of the source location.

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 VOD source's configuration.

Arguments

• http_package_configurations: A list of HTTP package configurations for the VOD source on this account.
• source_location_name: The name of the source location associated with this VOD Source.
• vod_source_name: The name of the VOD source.