types

package
v1.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 21, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessConfiguration added in v1.2.0 

type AccessConfiguration struct {

	// 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
	// contains filtered or unexported fields
}

Access configuration parameters.

type AccessType added in v1.2.0 

type AccessType string
const (
	AccessTypeS3Sigv4                   AccessType = "S3_SIGV4"
	AccessTypeSecretsManagerAccessToken AccessType = "SECRETS_MANAGER_ACCESS_TOKEN"
)

Enum values for AccessType

func (AccessType) Values added in v1.2.0 

func (AccessType) Values() []AccessType

Values returns all known values for AccessType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AdBreak added in v1.2.0 

type AdBreak struct {

	// 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 int64

	// 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
	// contains filtered or unexported fields
}

Ad break configuration parameters.

type AdMarkerPassthrough added in v0.29.0 

type AdMarkerPassthrough struct {

	// Enables ad marker passthrough for your configuration.
	Enabled bool
	// contains filtered or unexported fields
}

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.

type Alert added in v1.5.0 

type Alert struct {

	// The code for the alert. For example, NOT_PROCESSED.
	//
	// This member is required.
	AlertCode *string

	// If an alert is generated for a resource, an explanation of the reason for the
	// alert.
	//
	// This member is required.
	AlertMessage *string

	// The timestamp when the alert was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The Amazon Resource Names (ARNs) related to this alert.
	//
	// This member is required.
	RelatedResourceArns []string

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

Alert configuration parameters.

type AvailMatchingCriteria added in v1.9.0 

type AvailMatchingCriteria struct {

	// 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
	// (https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html) in the
	// MediaTailor User Guide. You can include up to 100 dynamic variables.
	//
	// This member is required.
	DynamicVariable *string

	// For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is
	// used for the comparison.
	//
	// This member is required.
	Operator Operator
	// contains filtered or unexported fields
}

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.

type AvailSuppression 

type AvailSuppression struct {

	// 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
	// contains filtered or unexported fields
}

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).

type BadRequestException 

type BadRequestException struct {
	Message *string
	// contains filtered or unexported fields
}

Invalid request parameters.

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type Bumper 

type Bumper struct {

	// The URL for the end bumper asset.
	EndUrl *string

	// The URL for the start bumper asset.
	StartUrl *string
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).

type CdnConfiguration 

type CdnConfiguration struct {

	// A non-default content delivery network (CDN) to serve ad segments. By default,
	// AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as
	// its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN
	// for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the
	// rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a
	// manifest, it reports your CDN as the source for ad segments.
	AdSegmentUrlPrefix *string

	// A content delivery network (CDN) to cache content segments, so that content
	// requests don’t always have to go to the origin server. First, create a rule in
	// your CDN for the content segment origin server. Then specify the rule's name in
	// this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest,
	// it reports your CDN as the source for content segments.
	ContentSegmentUrlPrefix *string
	// contains filtered or unexported fields
}

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

type Channel added in v1.2.0 

type Channel struct {

	// The ARN of the channel.
	//
	// This member is required.
	Arn *string

	// The name of the channel.
	//
	// This member is required.
	ChannelName *string

	// Returns the state whether the channel is running or not.
	//
	// This member is required.
	ChannelState *string

	// The channel's output properties.
	//
	// This member is required.
	Outputs []ResponseOutputItem

	// 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.
	//
	// This member is required.
	PlaybackMode *string

	// The timestamp of when the channel was created.
	CreationTime *time.Time

	// 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 *time.Time

	// The tags to assign to the channel.
	Tags map[string]string
	// contains filtered or unexported fields
}

The configuration parameters for a channel.

type ChannelState added in v1.2.0 

type ChannelState string
const (
	ChannelStateRunning ChannelState = "RUNNING"
	ChannelStateStopped ChannelState = "STOPPED"
)

Enum values for ChannelState

func (ChannelState) Values added in v1.2.0 

func (ChannelState) Values() []ChannelState

Values returns all known values for ChannelState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DashConfiguration 

type DashConfiguration struct {

	// 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
	// contains filtered or unexported fields
}

The configuration for DASH content.

type DashConfigurationForPut 

type DashConfigurationForPut struct {

	// 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
	// contains filtered or unexported fields
}

The configuration for DASH PUT operations.

type DashPlaylistSettings added in v1.2.0 

type DashPlaylistSettings struct {

	// The total duration (in seconds) of each manifest. Minimum value: 30 seconds.
	// Maximum value: 3600 seconds.
	ManifestWindowSeconds int32

	// 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 int32

	// 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 int32

	// 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 int32
	// contains filtered or unexported fields
}

Dash manifest configuration parameters.

type DefaultSegmentDeliveryConfiguration added in v1.2.0 

type DefaultSegmentDeliveryConfiguration struct {

	// The hostname of the server that will be used to serve segments. This string must
	// include the protocol, such as https://.
	BaseUrl *string
	// contains filtered or unexported fields
}

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.

type HlsConfiguration 

type HlsConfiguration struct {

	// The URL that is used to initiate a playback session for devices that support
	// Apple HLS. The session uses server-side reporting.
	ManifestEndpointPrefix *string
	// contains filtered or unexported fields
}

The configuration for HLS content.

type HlsPlaylistSettings added in v1.2.0 

type HlsPlaylistSettings struct {

	// The total duration (in seconds) of each manifest. Minimum value: 30 seconds.
	// Maximum value: 3600 seconds.
	ManifestWindowSeconds int32
	// contains filtered or unexported fields
}

HLS playlist configuration parameters.

type HttpConfiguration added in v1.2.0 

type HttpConfiguration struct {

	// The base URL for the source location host server. This string must include the
	// protocol, such as https://.
	//
	// This member is required.
	BaseUrl *string
	// contains filtered or unexported fields
}

The HTTP configuration for the source location.

type HttpPackageConfiguration added in v1.2.0 

type HttpPackageConfiguration struct {

	// The relative path to the URL for this VOD source. This is combined with
	// SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
	//
	// This member is required.
	Path *string

	// The name of the source group. This has to match one of the
	// Channel::Outputs::SourceGroup.
	//
	// This member is required.
	SourceGroup *string

	// The streaming protocol for this package configuration. Supported values are HLS
	// and DASH.
	//
	// This member is required.
	Type Type
	// contains filtered or unexported fields
}

The HTTP package configuration properties for the requested VOD source.

type LivePreRollConfiguration 

type LivePreRollConfiguration struct {

	// The URL for the ad decision server (ADS) for pre-roll 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 maximum allowed duration for the pre-roll ad avail. AWS Elemental
	// MediaTailor won't play pre-roll ads to exceed this duration, regardless of the
	// total duration of ads that the ADS returns.
	MaxDurationSeconds int32
	// contains filtered or unexported fields
}

The configuration for pre-roll ad insertion.

type LogConfiguration added in v1.8.0 

type LogConfiguration struct {

	// 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
	// (https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html). Valid
	// values: 0 - 100
	//
	// This member is required.
	PercentEnabled int32
	// contains filtered or unexported fields
}

Returns Amazon CloudWatch log settings for a playback configuration.

type ManifestProcessingRules added in v0.29.0 

type ManifestProcessingRules struct {

	// 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.
	AdMarkerPassthrough *AdMarkerPassthrough
	// contains filtered or unexported fields
}

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

type MessageType added in v1.2.0 

type MessageType string
const (
	MessageTypeSpliceInsert MessageType = "SPLICE_INSERT"
)

Enum values for MessageType

func (MessageType) Values added in v1.2.0 

func (MessageType) Values() []MessageType

Values returns all known values for MessageType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Mode 

type Mode string
const (
	ModeOff            Mode = "OFF"
	ModeBehindLiveEdge Mode = "BEHIND_LIVE_EDGE"
)

Enum values for Mode

func (Mode) Values added in v0.29.0 

func (Mode) Values() []Mode

Values returns all known values for Mode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Operator added in v1.9.0 

type Operator string
const (
	OperatorEquals Operator = "EQUALS"
)

Enum values for Operator

func (Operator) Values added in v1.9.0 

func (Operator) Values() []Operator

Values returns all known values for Operator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OriginManifestType 

type OriginManifestType string
const (
	OriginManifestTypeSinglePeriod OriginManifestType = "SINGLE_PERIOD"
	OriginManifestTypeMultiPeriod  OriginManifestType = "MULTI_PERIOD"
)

Enum values for OriginManifestType

func (OriginManifestType) Values added in v0.29.0 

func (OriginManifestType) Values() []OriginManifestType

Values returns all known values for OriginManifestType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PlaybackConfiguration 

type PlaybackConfiguration struct {

	// 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 Suppression
	// (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
	AvailSuppression *AvailSuppression

	// 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 (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
	Bumper *Bumper

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

	// The player parameters and aliases used as dynamic variables during session
	// initialization. For more information, see Domain Variables
	// (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html).
	ConfigurationAliases map[string]map[string]string

	// The configuration for a DASH source.
	DashConfiguration *DashConfiguration

	// The configuration for HLS content.
	HlsConfiguration *HlsConfiguration

	// The configuration for pre-roll ad insertion.
	LivePreRollConfiguration *LivePreRollConfiguration

	// The Amazon CloudWatch log settings for a playback configuration.
	LogConfiguration *LogConfiguration

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

	// The identifier for the playback configuration.
	Name *string

	// 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
	// (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
	PersonalizationThresholdSeconds int32

	// The Amazon Resource Name (ARN) for the playback configuration.
	PlaybackConfigurationArn *string

	// The URL that the player accesses to get a manifest from AWS Elemental
	// MediaTailor.
	PlaybackEndpointPrefix *string

	// The URL that the player uses to initialize a session that uses client-side
	// reporting.
	SessionInitializationEndpointPrefix *string

	// The URL for a 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 playback
	// configurations. For VPAID, the slate is required because MediaTailor provides it
	// in the slots designated for dynamic ad content. The slate must be a high-quality
	// asset that contains both audio and video.
	SlateAdUrl *string

	// The tags to assign to the playback configuration.
	Tags map[string]string

	// 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.
	TranscodeProfileName *string

	// The URL prefix for the parent manifest for the stream, minus the asset ID. The
	// maximum length is 512 characters.
	VideoContentSourceUrl *string
	// contains filtered or unexported fields
}

Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html).

type PlaybackMode added in v1.2.0 

type PlaybackMode string
const (
	PlaybackModeLoop   PlaybackMode = "LOOP"
	PlaybackModeLinear PlaybackMode = "LINEAR"
)

Enum values for PlaybackMode

func (PlaybackMode) Values added in v1.2.0 

func (PlaybackMode) Values() []PlaybackMode

Values returns all known values for PlaybackMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PrefetchConsumption added in v1.9.0 

type PrefetchConsumption struct {

	// The time when MediaTailor no longer considers the prefetched ads for use in an
	// ad break. MediaTailor automatically deletes prefetch schedules no less than
	// seven days after the end time. If you'd like to manually delete the prefetch
	// schedule, you can call DeletePrefetchSchedule.
	//
	// This member is required.
	EndTime *time.Time

	// If you only want MediaTailor to insert prefetched ads into avails (ad breaks)
	// that match specific dynamic variables, such as scte.event_id, set the avail
	// matching criteria.
	AvailMatchingCriteria []AvailMatchingCriteria

	// The time when prefetched ads are considered for use in an ad break. If you don't
	// specify StartTime, the prefetched ads are available after MediaTailor retrives
	// them from the ad decision server.
	StartTime *time.Time
	// contains filtered or unexported fields
}

A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.

type PrefetchRetrieval added in v1.9.0 

type PrefetchRetrieval struct {

	// The time when prefetch retrieval ends for the ad break. Prefetching will be
	// attempted for manifest requests that occur at or before this time.
	//
	// This member is required.
	EndTime *time.Time

	// The dynamic variables to use for substitution during prefetch requests to the ad
	// decision server (ADS). You intially configure dynamic variables
	// (https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html) for the ADS
	// URL when you set up your playback configuration. When you specify
	// DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic
	// variables in the request to the ADS.
	DynamicVariables map[string]string

	// The time when prefetch retrievals can start for this break. Ad prefetching will
	// be attempted for manifest requests that occur at or after this time. Defaults to
	// the current time. If not specified, the prefetch retrieval starts as soon as
	// possible.
	StartTime *time.Time
	// contains filtered or unexported fields
}

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.

type PrefetchSchedule added in v1.9.0 

type PrefetchSchedule struct {

	// The Amazon Resource Name (ARN) of the prefetch schedule.
	//
	// This member is required.
	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.
	//
	// This member is required.
	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.
	//
	// This member is required.
	Name *string

	// The name of the playback configuration to create the prefetch schedule for.
	//
	// This member is required.
	PlaybackConfigurationName *string

	// A complex type that contains settings for prefetch retrieval from the ad
	// decision server (ADS).
	//
	// This member is required.
	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
	// contains filtered or unexported fields
}

A complex type that contains prefetch schedule information.

type RelativePosition added in v1.2.0 

type RelativePosition string
const (
	RelativePositionBeforeProgram RelativePosition = "BEFORE_PROGRAM"
	RelativePositionAfterProgram  RelativePosition = "AFTER_PROGRAM"
)

Enum values for RelativePosition

func (RelativePosition) Values added in v1.2.0 

func (RelativePosition) Values() []RelativePosition

Values returns all known values for RelativePosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RequestOutputItem added in v1.2.0 

type RequestOutputItem struct {

	// The name of the manifest for the channel. The name appears in the PlaybackUrl.
	//
	// This member is required.
	ManifestName *string

	// A string used to match which HttpPackageConfiguration is used for each
	// VodSource.
	//
	// This member is required.
	SourceGroup *string

	// DASH manifest configuration parameters.
	DashPlaylistSettings *DashPlaylistSettings

	// HLS playlist configuration parameters.
	HlsPlaylistSettings *HlsPlaylistSettings
	// contains filtered or unexported fields
}

The output configuration for this channel.

type ResponseOutputItem added in v1.2.0 

type ResponseOutputItem struct {

	// The name of the manifest for the channel that will appear in the channel
	// output's playback URL.
	//
	// This member is required.
	ManifestName *string

	// The URL used for playback by content players.
	//
	// This member is required.
	PlaybackUrl *string

	// A string used to associate a package configuration source group with a channel
	// output.
	//
	// This member is required.
	SourceGroup *string

	// DASH manifest configuration settings.
	DashPlaylistSettings *DashPlaylistSettings

	// HLS manifest configuration settings.
	HlsPlaylistSettings *HlsPlaylistSettings
	// contains filtered or unexported fields
}

This response includes only the "property" : "type" property.

type ScheduleAdBreak added in v1.4.0 

type ScheduleAdBreak struct {

	// The approximate duration of the ad break, in seconds.
	ApproximateDurationSeconds int64

	// The approximate time that the ad will start playing.
	ApproximateStartTime *time.Time

	// The name of the source location containing the VOD source used for the ad break.
	SourceLocationName *string

	// The name of the VOD source used for the ad break.
	VodSourceName *string
	// contains filtered or unexported fields
}

The schedule's ad break properties.

type ScheduleConfiguration added in v1.2.0 

type ScheduleConfiguration struct {

	// Program transition configurations.
	//
	// This member is required.
	Transition *Transition
	// contains filtered or unexported fields
}

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

type ScheduleEntry added in v1.2.0 

type ScheduleEntry struct {

	// The ARN of the program.
	//
	// This member is required.
	Arn *string

	// The name of the channel that uses this schedule.
	//
	// This member is required.
	ChannelName *string

	// The name of the program.
	//
	// This member is required.
	ProgramName *string

	// The name of the source location.
	//
	// This member is required.
	SourceLocationName *string

	// The name of the VOD source.
	//
	// This member is required.
	VodSourceName *string

	// The approximate duration of this program, in seconds.
	ApproximateDurationSeconds int64

	// The approximate time that the program will start playing.
	ApproximateStartTime *time.Time

	// The schedule's ad break properties.
	ScheduleAdBreaks []ScheduleAdBreak

	// The type of schedule entry. Valid values: PROGRAM or FILLER_SLATE.
	ScheduleEntryType ScheduleEntryType
	// contains filtered or unexported fields
}

The properties for a schedule.

type ScheduleEntryType added in v1.7.0 

type ScheduleEntryType string
const (
	ScheduleEntryTypeProgram     ScheduleEntryType = "PROGRAM"
	ScheduleEntryTypeFillerSlate ScheduleEntryType = "FILLER_SLATE"
)

Enum values for ScheduleEntryType

func (ScheduleEntryType) Values added in v1.7.0 

func (ScheduleEntryType) Values() []ScheduleEntryType

Values returns all known values for ScheduleEntryType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SecretsManagerAccessTokenConfiguration added in v1.4.0 

type SecretsManagerAccessTokenConfiguration struct {

	// The name of the HTTP header used to supply the access token in requests to the
	// source location.
	HeaderName *string

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains
	// the access token.
	SecretArn *string

	// The AWS Secrets Manager SecretString
	// (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html)
	// key associated with the access token. MediaTailor uses the key to look up
	// SecretString key and value pair containing the access token.
	SecretStringKey *string
	// contains filtered or unexported fields
}

AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html).

type SlateSource added in v1.2.0 

type SlateSource struct {

	// The name of the source location where the slate VOD source is stored.
	SourceLocationName *string

	// The slate VOD source name. The VOD source must already exist in a source
	// location before it can be used for slate.
	VodSourceName *string
	// contains filtered or unexported fields
}

Slate VOD source configuration.

type SourceLocation added in v1.2.0 

type SourceLocation struct {

	// The ARN of the SourceLocation.
	//
	// This member is required.
	Arn *string

	// The HTTP configuration for the source location.
	//
	// This member is required.
	HttpConfiguration *HttpConfiguration

	// The name of the source location.
	//
	// This member is required.
	SourceLocationName *string

	// The access configuration for the source location.
	AccessConfiguration *AccessConfiguration

	// The timestamp that indicates when the source location was created.
	CreationTime *time.Time

	// The default segment delivery configuration.
	DefaultSegmentDeliveryConfiguration *DefaultSegmentDeliveryConfiguration

	// The timestamp that indicates when the source location was last modified.
	LastModifiedTime *time.Time

	// The tags assigned to the source location.
	Tags map[string]string
	// contains filtered or unexported fields
}

This response includes only the "type" : "object" property.

type SpliceInsertMessage added in v1.2.0 

type SpliceInsertMessage struct {

	// This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the
	// SCTE-35 specification. The default value is 0. Values must be between 0 and 256,
	// inclusive.
	AvailNum int32

	// This is written to splice_insert.avails_expected, as defined in section 9.7.3.1
	// of the SCTE-35 specification. The default value is 0. Values must be between 0
	// and 256, inclusive.
	AvailsExpected int32

	// This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1
	// of the SCTE-35 specification. The default value is 1.
	SpliceEventId int32

	// This is written to splice_insert.unique_program_id, as defined in section
	// 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be
	// between 0 and 256, inclusive.
	UniqueProgramId int32
	// contains filtered or unexported fields
}

Splice insert message configuration.

type Transition added in v1.2.0 

type Transition struct {

	// The position where this program will be inserted relative to the
	// RelativePosition.
	//
	// This member is required.
	RelativePosition RelativePosition

	// Defines when the program plays in the schedule. You can set the value to
	// ABSOLUTE or RELATIVE. ABSOLUTE - The program plays at a specific wall clock
	// time. This setting can only be used for channels using the LINEAR PlaybackMode.
	// Note the following considerations when using ABSOLUTE transitions: If the
	// preceding program in the schedule has a duration that extends past the wall
	// clock time, MediaTailor truncates the preceding program on a common segment
	// boundary. If there are gaps in playback, MediaTailor plays the FillerSlate you
	// configured for your linear channel. RELATIVE - The program is inserted into the
	// schedule either before or after a program that you specify via RelativePosition.
	//
	// This member is required.
	Type *string

	// The name of the program that this program will be inserted next to, as defined
	// by RelativePosition.
	RelativeProgram *string

	// The date and time that the program is scheduled to start, in epoch milliseconds.
	ScheduledStartTimeMillis int64
	// contains filtered or unexported fields
}

Program transition configuration.

type Type added in v1.2.0 

type Type string
const (
	TypeDash Type = "DASH"
	TypeHls  Type = "HLS"
)

Enum values for Type

func (Type) Values added in v1.2.0 

func (Type) Values() []Type

Values returns all known values for Type. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VodSource added in v1.2.0 

type VodSource struct {

	// The ARN for the VOD source.
	//
	// This member is required.
	Arn *string

	// The HTTP package configurations for the VOD source.
	//
	// This member is required.
	HttpPackageConfigurations []HttpPackageConfiguration

	// The name of the source location that the VOD source is associated with.
	//
	// This member is required.
	SourceLocationName *string

	// The name of the VOD source.
	//
	// This member is required.
	VodSourceName *string

	// The timestamp that indicates when the VOD source was created.
	CreationTime *time.Time

	// The timestamp that indicates when the VOD source was last modified.
	LastModifiedTime *time.Time

	// The tags assigned to the VOD source.
	Tags map[string]string
	// contains filtered or unexported fields
}

VOD source configuration parameters.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.