Module Awso_mediatailor.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule Integer : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule SegmentationDescriptor : sig ... end

The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data. segmentation_descriptor messages must be sent with the time_signal message type. See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.

Sourcemodule KeyValuePair : sig ... end

For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the EXT-X-ASSETtag.

Sourcemodule AdBreakMetadataList : sig ... end
Sourcemodule MessageType : sig ... end
Sourcemodule SlateSource : sig ... end

Slate VOD source configuration.

Sourcemodule SpliceInsertMessage : sig ... end

Splice insert message configuration.

Sourcemodule TimeSignalMessage : sig ... end

The SCTE-35 time_signal message can be sent with one or more segmentation_descriptor messages. A time_signal message can be sent only if a single segmentation_descriptor message is sent. The time_signal message contains only the splice_time field which is constructed using a given presentation timestamp. When sending a time_signal message, the splice_command_type field in the splice_info_section message is set to 6 (0x06). See the time_signal() table of the 2022 SCTE-35 specification for more information.

Sourcemodule Operator : sig ... end
Sourcemodule AdMarkupType : sig ... end
Sourcemodule AdBreak : sig ... end

Ad break configuration parameters.

Sourcemodule AvailMatchingCriteria : sig ... end

MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into. As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS. You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.

Sourcemodule AdMarkupTypes : sig ... end
Sourcemodule ClipRange : sig ... end

Clip range configuration for the VOD source associated with the program.

Sourcemodule Type : sig ... end

The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.

The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.

Sourcemodule TrafficShapingType : sig ... end
Sourcemodule CompressionMethod : sig ... end
Sourcemodule Method : sig ... end
Sourcemodule StringMap : sig ... end
Sourcemodule LoggingStrategy : sig ... end
Sourcemodule FunctionRef : sig ... end

A reference to a child function within a SEQUENTIAL_EXECUTOR function.

Sourcemodule LogType : sig ... end
Sourcemodule DashPlaylistSettings : sig ... end

Dash manifest configuration parameters.

Sourcemodule HlsPlaylistSettings : sig ... end

HLS playlist configuration parameters.

Sourcemodule AlternateMedia : sig ... end

A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.

Sourcemodule HttpPackageConfiguration : sig ... end

The HTTP package configuration properties for the requested VOD source.

Sourcemodule AccessType : sig ... end

AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.

The segment delivery configuration settings.

Sourcemodule RecurringConsumption : sig ... end

The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.

Sourcemodule RecurringRetrieval : sig ... end

With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following configurations describe the MediaTailor behavior when prefetching ads for a live event.

Sourcemodule HttpRequest : sig ... end

HTTP request configuration parameters that define how MediaTailor communicates with the ad decision server.

Sourcemodule FillPolicy : sig ... end
Sourcemodule Mode : sig ... end
Sourcemodule OriginManifestType : sig ... end
Sourcemodule EventName : sig ... end
Sourcemodule AdsInteractionLog : sig ... end

Settings for customizing what events are included in logs for interactions with the ad decision server (ADS). For more information about ADS logs, inlcuding descriptions of the event types, see MediaTailor ADS logs description and event types in Elemental MediaTailor User Guide.

Settings for customizing what events are included in logs for interactions with the origin server. For more information about manifest service logs, including descriptions of the event types, see MediaTailor manifest logs description and event types in Elemental MediaTailor User Guide.

Sourcemodule AdMarkerPassthrough : sig ... end

For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest. No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.

Sourcemodule RuntimeType : sig ... end
Sourcemodule MethodType : sig ... end
Sourcemodule LogTypes : sig ... end
Sourcemodule ResponseOutputItem : sig ... end

The output item response.

Sourcemodule ScheduleAdBreak : sig ... end

The schedule's ad break properties.

Sourcemodule HttpPackageConfigurations : sig ... end
Sourcemodule AccessConfiguration : sig ... end

Access configuration parameters.

The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.

Sourcemodule HttpConfiguration : sig ... end

The HTTP configuration for the source location.

Sourcemodule PrefetchConsumption : sig ... end

For single prefetch, describes how and when that MediaTailor places prefetched ads into upcoming ad breaks.

Sourcemodule PrefetchRetrieval : sig ... end

A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.

Sourcemodule PrefetchScheduleType : sig ... end

The configuration that defines how MediaTailor performs recurring prefetch.

The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.

Configuration parameters for customizing HTTP requests sent to the ad decision server (ADS). This allows you to specify the HTTP method, headers, request body, and compression settings for ADS requests.

Sourcemodule AvailSuppression : sig ... end

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

Sourcemodule Bumper : sig ... end

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.

Sourcemodule CdnConfiguration : sig ... end

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

Sourcemodule DashConfiguration : sig ... end

The configuration for DASH content.

Sourcemodule FunctionMapping : sig ... end
Sourcemodule HlsConfiguration : sig ... end

The configuration for HLS content.

Sourcemodule InsertionMode : sig ... end
Sourcemodule LivePreRollConfiguration : sig ... end

The configuration for pre-roll ad insertion.

Sourcemodule LogConfiguration : sig ... end

Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

Sourcemodule ManifestProcessingRules : sig ... end

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Sourcemodule CustomOutputConfiguration : sig ... end

The configuration for a CUSTOM_OUTPUT function. MediaTailor evaluates the output expressions against the current session state and commits the results as output bindings. CUSTOM_OUTPUT functions do not make external calls. For more information, see CUSTOM_OUTPUT in the MediaTailor User Guide.

Sourcemodule FunctionType : sig ... end
Sourcemodule HttpRequestConfiguration : sig ... end

-- Function Configuration DataStructure

The configuration for a SEQUENTIAL_EXECUTOR function. A SEQUENTIAL_EXECUTOR runs a sequence of child functions in order, passing data between steps through temporary data. For more information, see SEQUENTIAL_EXECUTOR in the MediaTailor User Guide.

Sourcemodule Audiences : sig ... end

The log configuration for the channel.

Sourcemodule ResponseOutputs : sig ... end
Sourcemodule AlertCategory : sig ... end
Sourcemodule ScheduleEntryType : sig ... end
Sourcemodule RelativePosition : sig ... end
Sourcemodule AudienceMedia : sig ... end

An AudienceMedia object contains an Audience and a list of AlternateMedia.

Sourcemodule UpdateProgramTransition : sig ... end

Program transition configuration.

Sourcemodule RequestOutputItem : sig ... end

The output configuration for this channel.

Sourcemodule VodSource : sig ... end

VOD source configuration parameters.

Sourcemodule SourceLocation : sig ... end

A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

Sourcemodule PrefetchSchedule : sig ... end

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.

Sourcemodule PlaybackConfiguration : sig ... end

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

Sourcemodule LiveSource : sig ... end

Live source configuration parameters.

Sourcemodule Function : sig ... end

-- Define Mixin --

Sourcemodule Channel : sig ... end

The configuration parameters for a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Sourcemodule Alert : sig ... end

Alert configuration parameters.

Sourcemodule ScheduleEntry : sig ... end

The properties for a schedule.

Sourcemodule AdBreakOpportunity : sig ... end

A location at which a zero-duration ad marker was detected in a VOD source manifest.

Sourcemodule Transition : sig ... end

Program transition configuration.

Schedule configuration parameters.

Sourcemodule ChannelState : sig ... end
Sourcemodule TimeShiftConfiguration : sig ... end

The configuration for time-shifted viewing.

Sourcemodule RequestOutputs : sig ... end
Sourcemodule DashConfigurationForPut : sig ... end

The configuration for DASH PUT operations.

Sourcemodule MaxResults : sig ... end
Sourcemodule BadRequestException : sig ... end

A request contains unexpected data.

Sourcemodule ListPrefetchScheduleType : sig ... end
Sourcemodule AdBreakOpportunities : sig ... end
Sourcemodule Long : sig ... end
Sourcemodule ScheduleConfiguration : sig ... end

Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.

Sourcemodule PlaybackMode : sig ... end
Sourcemodule Tier : sig ... end
Sourcemodule UpdateVodSourceResponse : sig ... end

Updates a VOD source's configuration.

Sourcemodule UpdateVodSourceRequest : sig ... end

Updates a VOD source's configuration.

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.

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.

Sourcemodule UpdateProgramResponse : sig ... end

Updates a program within a channel.

Sourcemodule UpdateProgramRequest : sig ... end

Updates a program within a channel.

Sourcemodule UpdateLiveSourceResponse : sig ... end

Updates a live source's configuration.

Sourcemodule UpdateLiveSourceRequest : sig ... end

Updates a live source's configuration.

Sourcemodule UpdateChannelResponse : sig ... end

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

Sourcemodule UpdateChannelRequest : sig ... end

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

Sourcemodule UntagResourceRequest : sig ... end

The resource to untag.

Sourcemodule TagResourceRequest : sig ... end

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.

Sourcemodule StopChannelResponse : sig ... end

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

Sourcemodule StopChannelRequest : sig ... end

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

Sourcemodule StartChannelResponse : sig ... end

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

Sourcemodule StartChannelRequest : sig ... end

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

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

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

Sourcemodule PutFunctionResponse : sig ... end

-- Define Mixin --

Sourcemodule PutFunctionRequest : sig ... end

-- Define Mixin --

Sourcemodule PutChannelPolicyResponse : sig ... end

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

Sourcemodule PutChannelPolicyRequest : sig ... end

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

Sourcemodule ListVodSourcesResponse : sig ... end

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

Sourcemodule ListVodSourcesRequest : sig ... end

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

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.

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.

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

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

Lists the prefetch schedules for a playback configuration.

Lists the prefetch schedules for a playback configuration.

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

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

Sourcemodule ListLiveSourcesResponse : sig ... end

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

Sourcemodule ListLiveSourcesRequest : sig ... end

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

Sourcemodule ListFunctionsResponse : sig ... end

Retrieves all functions associated with your AWS account in the current Region. For more information about functions, see Working with functions in the MediaTailor User Guide.

Sourcemodule ListFunctionsRequest : sig ... end

Retrieves all functions associated with your AWS account in the current Region. For more information about functions, see Working with functions in the MediaTailor User Guide.

Sourcemodule ListChannelsResponse : sig ... end

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

Sourcemodule ListChannelsRequest : sig ... end

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

Sourcemodule ListAlertsResponse : sig ... end

Lists the alerts that are associated with a MediaTailor channel assembly resource.

Sourcemodule ListAlertsRequest : sig ... end

Lists the alerts that are associated with a MediaTailor channel assembly resource.

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.

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.

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

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

Sourcemodule GetFunctionResponse : sig ... end

-- Define Mixin --

Sourcemodule GetFunctionRequest : sig ... end

-- Request/Response DataStructures --

Retrieves information about your channel's schedule.

Sourcemodule GetChannelScheduleRequest : sig ... end

Retrieves information about your channel's schedule.

Sourcemodule GetChannelPolicyResponse : sig ... end

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

Sourcemodule GetChannelPolicyRequest : sig ... end

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

Sourcemodule DescribeVodSourceResponse : sig ... end

Provides details about a specific video on demand (VOD) source in a specific source location.

Sourcemodule DescribeVodSourceRequest : sig ... end

Provides details about a specific video on demand (VOD) source in a specific source location.

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.

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.

Sourcemodule DescribeProgramResponse : sig ... end

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

Sourcemodule DescribeProgramRequest : sig ... end

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

The live source to describe.

Sourcemodule DescribeLiveSourceRequest : sig ... end

The live source to describe.

Sourcemodule DescribeChannelResponse : sig ... end

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

Sourcemodule DescribeChannelRequest : sig ... end

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

Sourcemodule DeleteVodSourceResponse : sig ... end

The video on demand (VOD) source to delete.

Sourcemodule DeleteVodSourceRequest : sig ... end

The video on demand (VOD) source to delete.

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.

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.

Sourcemodule DeleteProgramResponse : sig ... end

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

Sourcemodule DeleteProgramRequest : sig ... end

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

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.

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.

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

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

Sourcemodule DeleteLiveSourceResponse : sig ... end

The live source to delete.

Sourcemodule DeleteLiveSourceRequest : sig ... end

The live source to delete.

Sourcemodule DeleteFunctionResponse : sig ... end

Deletes a function. MediaTailor prevents deletion of a function that is still referenced by a playback configuration or by another function. Remove all references before deleting. For more information about functions, see Working with functions in the MediaTailor User Guide.

Sourcemodule DeleteFunctionRequest : sig ... end

Deletes a function. MediaTailor prevents deletion of a function that is still referenced by a playback configuration or by another function. Remove all references before deleting. For more information about functions, see Working with functions in the MediaTailor User Guide.

Sourcemodule DeleteChannelResponse : sig ... end

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

Sourcemodule DeleteChannelRequest : sig ... end

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

The channel policy to delete.

The channel policy to delete.

Sourcemodule CreateVodSourceResponse : sig ... end

The VOD source configuration parameters.

Sourcemodule CreateVodSourceRequest : sig ... end

The VOD source configuration parameters.

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.

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.

Sourcemodule CreateProgramResponse : sig ... end

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

Sourcemodule CreateProgramRequest : sig ... end

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

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.

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.

Sourcemodule CreateLiveSourceResponse : sig ... end

The live source configuration.

Sourcemodule CreateLiveSourceRequest : sig ... end

The live source configuration.

Sourcemodule CreateChannelResponse : sig ... end

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

Sourcemodule CreateChannelRequest : sig ... end

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

Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

Configures Amazon CloudWatch log settings for a playback configuration.

Configures Amazon CloudWatch log settings for a channel.

Configures Amazon CloudWatch log settings for a channel.